Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@zanminkian/git-hooks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@zanminkian/git-hooks

A bundle of opinionated git hooks. All in one!

Drop husky, eslint, lint-staged and commitlint in your project.

Feature

All in one. Just install ONE npm package.
Easy to use. Only 2 step: setup scripts and then install.
Zero Configs. Reasonable default settings for enterprise app.

Usage

Setup scripts in your package.json.

git-hooks install: Install the hook files to {PROJECT_ROOT}/.git/hooks directory, in order to check your code and committed message after running git commit command.
git-hooks format: Check and format all the files of your project. Use eslint --fix command under the hood.
git-hooks lint: Check all the files of your project. Use eslint command under the hood.

{
  "scripts": {
    "postinstall": "git-hooks install",
    "format": "git-hooks format",
    "lint": "git-hooks lint"
  }
}

And then install it.

pnpm add -D @zanminkian/git-hooks

After that, you can commit your code in your project. The invalid code and the invalid committed message will be blocked automatically.

Advanced usage

Work with `husky`

This library can work by standalone. But if you have husky 5 or greater installed, because husky will ignore the .git/hooks/commit-msg and .git/hooks/pre-commit, .husky/commit-msg and .husky/pre-commit need to be added manually:

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

.git/hooks/commit-msg $1

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

.git/hooks/pre-commit $1

Customize eslint config

We use eslint to lint and format the code under the hood. If your don't like the built-in eslint config, you can add your own .eslintrc.js to the root of your project. Here is example for you.

module.exports = {
  extends: '@zanminkian',
  rules: {
    // write your rules here
  }
}

How it works

After running git-hooks install, it will write commit-msg file and pre-commit file to {PROJECT_ROOT}/.git/hooks directory.

The commit-msg file will lint your git commit message before git commit.
The pre-commit file will lint your staged code before git commit.

License

MIT