shared-git-hooks

    1.2.1 • Public • Published

    shared-git-hooks

    js-standard-style build status coverage npm version npm downloads License

    Install (Node.js >= 0.12.0)

    $ npm i shared-git-hooks --save-dev
    

    Usage

    Add your scripts to ./hooks and name them 1:1 as git hooks (optional extension allowed):

    applypatch-msg.EXT
    pre-applypatch.EXT
    post-applypatch.EXT
    pre-commit.EXT
    prepare-commit-msg.EXT
    commit-msg.EXT
    post-commit.EXT
    pre-rebase.EXT
    post-checkout.EXT
    post-merge.EXT
    pre-push.EXT
    pre-receive.EXT
    update.EXT
    post-receive.EXT
    post-update.EXT
    pre-auto-gc.EXT
    post-rewrite.EXT
    

    A generic script is symlinked in .git/hooks when you npm install your project. The script will look for an executable file with a ~matching name in your ./hooks and run it if found.

    You can also set a $GIT_HOOKS_PATH env var and customize your scripts location.

    Assumption

    This project assumes that:

    • you have a package.json, .git/ and hooks/ in the root of your project.
    • you want to run your hooks with the same env $PATH you have when you run npm install (this will allow git GUI like Tower to access node through nvm for example)

    Example

    Save the following as ./hooks/pre-commit

    #!/usr/bin/env node 
    console.log('refusing all commits!')
    process.exit(1)

    Remember to chmod +x ./hooks/pre-commit.

    Related projects

    How to contribute

    This project follows the awesome Vincent Driessen branching model.

    • You must add a new feature on its own branch
    • You must contribute to hot-fixing, directly into the master branch (and pull-request to it)

    This project uses standardjs to enforce a consistent code style. Your contribution must be pass standard validation.

    The test suite is written on top of mochajs/mocha. Use the tests to check if your contribution breaks some part of the library and be sure to add new tests for each new feature.

    $ npm test
    

    License

    This software is released under the MIT license cited below.

    Copyright (c) 2015 Kilian Ciuffolo, me@nailik.org. All Rights Reserved.
    
    Permission is hereby granted, free of charge, to any person
    obtaining a copy of this software and associated documentation
    files (the 'Software'), to deal in the Software without
    restriction, including without limitation the rights to use,
    copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following
    conditions:
    
    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
    OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
    OTHER DEALINGS IN THE SOFTWARE.
    

    Keywords

    Install

    npm i shared-git-hooks

    DownloadsWeekly Downloads

    3,317

    Version

    1.2.1

    License

    MIT

    Last publish

    Collaborators

    • kilianc