README.md

Git Hooks Composer Installer

Latest release: 1.0.0

This plugin helps you automate the installation git hooks using composer.

Installation

Just run the following command:

$ composer require --dev ams/git-hooks-installer

or if you prefer add the following to the composer.json file:

{
    "require-dev": {
        "ams/git-hooks-installer": "^1.0"
    },
    "extra": {
        "git-root-dir": "."
    }
}

Usage

When the git-hooks-composer installer is run, it only looks for git-hooks among your project dependencies. If your package is a git hook and you want it to be installed with composer automatically you'll need to define a composer.json as follows:

{
    "type": "git-hook"
}

The git hooks scripts should be located in the package root directory.

Currently are the following git hooks supported:

• applypatch-msg
• pre-applypatch
• post-applypatch
• pre-commit
• prepare-commit-msg
• commit-msg
• post-commit
• pre-rebase
• post-checkout
• post-merge
• pre-push
• pre-auto-gc
• post-rewrite

You can find any additional information about the git hooks on the git documentation online.

Contribute

Contributions to are very welcome!

• Report any bugs or issues you find on the issue tracker.

Support

If you are having problems, send a mail to [email protected] or just write me @flamingek on Twitter.

License

All contents of this package are licensed under the MIT license.