An NPM for git hooks.
hook-module
: Any module in npm that meets thehook-module specification
.hook-module specification
: A set of guidelines that define what it means to be ahook-module
. View here.npm
: node package manager. This can be (and is) used for more things than node modules.npm-module
: a bit of code that can be downloaded via npm.package.json
: a required file fornpm-modules
defined here.
npm install -g node-hooks
git init
hooks install
hooks add new-hook
hooks list
Check out this README for a quick intro. For more depth checkout the hook-module sepcs which covers the hook module requirements.
There is also a hook-module best practices doc which should help you avoid trip ups.
Working on that. See the TODO list below.
Installs hooks into the current working directory, seeding the required hooks.json and package.json files if needed.
It will also add node-hooks to the projects project.json devDependencies and node_modules folder so that all developers on the project will use the same hooks even if they don't have node-hooks installed locally.
- --soft: stops install from adding hooks to the package.json devDependencies and node_modules.
- --bare: updates folder dependency checks to reflect that of a git --bare repo.
Uninstall hooks from the current working directory. Removes hooks.json, but does not touch package.json or the node_module directory.
Adds an npm module to the local hooks project if the hook module's
package.json fits the hook-module specification
below. By default the module will be added to the hook specified in the module's package.json "default-hook" parameter and to the project's package.json devDependencies parameter.
- --hook {GIT HOOK NAME}: this option overrides the hook-module's default-hook parameter.
- -f, --force: installs a module from npm even if it doesn't meet the
hooks-module specification
. Requires the --hook option - --soft: don't add the module to the package.json
Removes a hook-module
from the default hooks.
- --hook {GIT HOOK NAME}: remove module from specified git hook.
- --all-hooks: remove the module from all git hooks
- --hard: Also removes the module from the project's devDependencies parameter.
Lists the hook modules registered with node-hooks.
does an npm search for modules tagged git-hooks
Runs a hook.
- Rework globals
- ~/.hooks/global: hooks a user wants to run for all their projects
- Add
hooks skip hook-module
to skip globals
- hooks add --global: Add a hook module to the global scope.
- hooks remove --global: Remove a hook module from the global scope.
- hooks run --global: Run a hook module that is in the global scope.
- hooks list --global: Lists the hook modules in your global scope.
- hooks list --local: Lists the hook modules as they are setup in the current project.
- hooks list --hook {git-hook}: limits results to hook modules for the specified git hook.
Remove a modules from the project (hooks remove --all-hooks) and forces a skip if its installed on a global level
- --hook {GIT HOOK NAME}: remove module from specified git hook.
- --all-hooks: remove the module from all git hooks
- Adding availabe hooks section to readme
- Starting change log
- Pass args on to hook-moduless
- Provide --bare command for install hooks into bare repos
- Started move towards using spawn rather than exec from child_process.
- Update to shell script to avoid failure if package.json is not found.
- Update to run, not exiting if hooks.json can't be found.
- Bug fix concerning adding npm data to the hooks.json file
- Bug fix concerning multiple hook-modules running from the same hook