@saji/git-hooks

git hooks

Zero config, opinionated git hooks that you can drop into your project and it will just work™.

If there’s EsLint config, will lint your files, if there’s test npm script will run it on push, if commit lint config, will check your commit messages etc, etc, etc. For full list of hooks, see files in *.d directories.

Installation

For everyone who clones your repository

Install hooks as a dependency in your project:

npm install --save-dev @saji/git-hooks

For yourself

• Install hooks package globally:

  npm install -g @saji/git-hooks
  

• Install it in any repository you want:

  git install-hooks
  

  Add -f to force overwriting any existing hooks.

Other methods

from cloned repository

• Clone this repository somewhere

• In your repository run:

  SOMEWHERE/install.sh`
  

by changing hooksPath

• Clone this repository somewhere

• In your repository run:

  git config core.hooksPath SOMEWHERE
  

  You could use --global to set it up for all your repositories.

Configuration

Disabling a hook

git config --type=int hooks.$HOOK_NAME.enabled false
# e.g. hooks.npm-test.enabled

You can also disable a hook for single run, e.g.

git -c hooks.npm-test.enabled=false push

As a shorthand you can omit .enabled:

git -c hooks.npm-test=false push

Disabling all hooks

Apart from passing --no-verify you can also use hooks.enabled config option.

Changing verbosity

git config --type=int hooks.verbosity 2

• -1: Only error messages
• 0: Also show celebratory success message (default)
• 1: Also print hook names as they run
• 2: Also print hook execution time after they finish.
• 7: Also print main commands for some hooks
• 8: Also print some debug information
• 9: Also run everything with set -x

Hook–specific options

pre-push: npm-test

Hook detects if jest is being used for testing and if so, only runs tests that are related to modified files, but that heuristic is not perfect. You can force selected files to always be included, e.g.

git config hooks.pre-push.npm-test.forcedJestTests tests/storybook.test.js

pre-push: branch-name

When configured with a extended grep regular expression will check if branch names match it, e.g.

git config hooks.pre-push.branch-name.allow-regexp '^((feat|fix|doc|chore)/|production$)'

You don’t have to list your main branch.

License

Licensed under ISC.