@zkochan/husky

    0.0.0 • Public • Published

    husky npm version Mac/Linux Build Status Windows Build status

    Git hooks made easy

    Husky can prevent bad commit, push and more 🐶 woof!

    Install

    npm install husky --save-dev
    yarn add husky --dev
    // Edit package.json
    {
      "scripts": {
        "precommit": "npm test",
        "prepush": "npm test",
        "...": "..."
      }
    }
    git commit -m "Keep calm and commit"

    Existing hooks aren't replaced and you can use any Git hook.

    If you're migrating from ghooks, simply run npm uninstall ghooks --save-dev && npm install husky --save-dev and edit package.json. Husky will automatically migrate ghooks hooks.

    Used by

    Uninstall

    npm uninstall husky
    yarn remove husky

    Tricks

    Debug hooks easily

    If you need to debug hooks, simply use npm run <script-name>. For example:

    npm run precommit

    Git GUI clients support

    If you've installed Node using the standard installer, nvm or homebrew, Git hooks will be executed in GUI applications.

    Working with multiple version of Node

    If nvm is installed, husky will try to use the default/current installed Node version or use the project .nvmrc.

    Tip to use the system-installed version of node, nvm provides a system alias

    Accessing Git params

    Git params can be found in GIT_PARAMS environment variable.

    Setting a different log level

    By default, husky will run scripts using --silent to make the output more readable. If you want to override this, simply pass a different log level to your scripts:

    "precommit""npm run some-script -q"

    -q/--quiet is equivalent to --loglevel warn which is npm default log level.

    Git submodule and subtree support

    Yes

    Cygwin support

    Yes

    Yarn support

    Please use yarn v0.24+

    See also

    License

    MIT - Typicode 🌵 - Patreon

    Install

    npm i @zkochan/husky

    DownloadsWeekly Downloads

    2

    Version

    0.0.0

    License

    MIT

    Last publish

    Collaborators

    • zkochan