git client hook for node project with unit-test: bats
npm install git-client-hook
git-client-hook used for installing some git client hook into node project.
1. If npm test passed, git push will go on, else git push will be cancelled, and output errors npm test found.
2. Check if the pushing branch is update to newest remotes/origion/master.
1. Check if commit-msg is valid, check options as follows:
* if commit on branch: master/develop/release/test, it will output a warning.
* if commit without any message, this commit will fail.
* if branch name format does not satisfy [feature | release | bugfix | hotfix]/JIRA-xxxx-brief-description, this commit will fail. (correct branch name format)
* if commit message already contains a jira task number(regex: [A-Z][A-Z_0-9]+-[0-9]+), it will not add one again.
2. Add JIRA TASK number(branch name) to commit-msg.
If all above passed, commit-msg will add branch name (JIRA TASK number) to commit message.
Add JIRA Task number into commit message can build a link between git commit and JIRA TASK.
Run npm install git-client-hook --save-dev, pre-push & commit-msg hooks
will install into git/hooks.
Before install git hooks to .git/hooks, there are also some checks,
Check options as follows:
1. Git hook will install only if NODE_ENV is development or undefined.
2. If project is managed by git.(has .git/ dir)
3. Check if some hooks have already installed, if 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.
Run npm uninstall git-client-hook --save-dev:
1. git-client-hook will be uninstalled.
2. git hooks installed into .git/hooks/ will be uninstalled.
You can add any fantasy git client hooks to the repository, or custom it for your project.
Tests are executed using Bats
Please feel free to submit pull requests and file bugs on the issue
tracker.
1. add post-commit to run npm test in background
2. add git-hook CLI: 1.custom pre-commit email verify; 2.batch change current branch commits email
1. optimize "feature branch update to master branch before push".
1. add branch name format reference link.
2. add branch name of release.
1. restrict branch name format: [feature | bugfix | hotfix]/JIRA-xxxx-brief-description.
2. optimize emoji.
1. fix: JIRA Number can not prepend to commit-msg when git commit with editor.
1. force feature branch update to master branch before git push.
1. check whether feature branch merged/rebased newest master branch in pre-push.