git-hook-local

git-hook-local is a repository that contains some git client hook. The function of git client hook. It's now used for node project, you can custom it for your project.

Function of git client hook

pre-push: run eslint before git push

If pre-push's eslint passed, then git push will go on, else if pre-push failure, git push will be forbided, an output the errors eslint found.

pre-commit: check email format before git commit

prepare-commit-msg: add branch name(jira) to commit message automaticall & do some check

Your branch name should have format like feature/TASK-[1234] or bugfix/TASK-[1234]. When run git commit, prepare-commit-msg hook will add branch name(jira task number) to commit message prepend. The function of JIRA Task number in commit message: can build a link between git commit and JIRA TASK.

Before add branch name(JIRA TASK number) to commit message, there are some checks,

Check options includes:

1. if commit on branch: master/develop, it will output a warning.
2. if commit without any message, this commit will fail.
3. if commit message already contains a jira task number, it will not add one again. If all passed, prepare-commit-msg will add branch name(JIRA TASK number) to commit message.

Installing git-hook-local from source

Check out a copy of the git-hook-local repository. Then, add the git-hook-local/git-hook/ directory to your project root dir, cd project root dir, run the provided git-client-hook.sh command, to install git hooks into .git/hooks/,

$ git clone git@github.com:adispring/git-hook-local.git
$ cp -rf ./git-hook-local/git-hook your-project-root-dir
$ cd your-project-root-dir
$ bash ./git-hook/git-client-hook.sh

If your project is using Node, you can add the install script into package.json after copy the git-hook/ dir to the project root dir, after add git-test and postinstall to package.json, run `npm install to install the hooks. The change of package.json as follows:

"scripts": {
  "test": "npm run git-test",
  "git-test": "bats git-hook/test",
  "postinstall": "bash ./git-hook/git-client-hook.sh"
},

Before install git hooks to .git/hooks, there are also some checks,

Check options includes:

1. git hook will install only if NODE_ENV is development or undefined.
2. if the project is managed by git.(has .git/ dir)
3. whether some hooks have already installed, whether hooks have changed/updated. If hook has already installed and not changed, this hook will not install again, else if it updated, it will updated.

Development

You can add any fantasy git client hooks to the repository, or custom it for your project.

Tests are executed using Bats:

$ bats git-hook/test
$ bats git-hook/test/<file>.bats

Please feel free to submit pull requests and file bugs on the issue tracker.