bernardosilva/git-hooks-installer-plugin

git-hooks-installer-plugin

, _(*1)

This project goal is to share and enforce code standards to all your projects., _(*2)

Why create this?

Currently there are millions of php projects that do not follow or adapt any code standards., _(*3)

I think the main reasons for that are:, _(*4)

• Lack of time to implement a script to check them;
• Not sure how those will help;
• Not sure how to enforce them for all team members;
• Not aware of what that is;

Using git-hook packages will enable everyone to share their hooks and reduce de number of projects not following any standards., _(*5)

git-hook package

A git-hook package is a composer package that uses the type git-hook., _(*6)

Any package that set git-hook-installer-plugin as dependency and type to git-hook will be installed on your project using this plugin., _(*7)

Git-hook packages available

Create you own git-hook package to be listed here and share it with everyone., _(*8)

• bernardosilva/git-hooks-php
• partnermarketing/pm-git-hooks-php

How to create my git-hook packages?

You can start by looking into this example, _(*9)

Things required to create a new git-hook package?, _(*10)

• [x] composer.json file.
• [x] The git hook files you want to use. view list of available hooks

Example of new composer.json file, _(*11)

{
    "name": "yourname/your-package-name",
    "type": "git-hook",
    "description": "Composer git-hook package with hooks for your php projects.",
    "require": {
        "bernardosilva/git-hooks-installer-plugin": "^1.0.0"
    }
}

Note: Your composer.json must have a specific type to be installed in correct directory:, _(*12)

"type": "git-hook"

Also your git hooks should have execution permission., _(*13)

Available hooks

You can create any of those files on your package with execute permissions., _(*14)

• applypatch-msg
• pre-applypatch
• pre-commit
• prepare-commit-msg
• commit-msg
• pre-rebase
• pre-push
• update
• post-update

See a list of all git hooks available, _(*15)

How to Install

php composer.phar require bernardosilva/git-hooks-installer-plugin

How to test

./vendor/bin/phpunit

How to contribute

• Create your own git hook composer package., _(*16)

• Create a PR to list your package on this page., _(*17)

• Raise new issues or add suggestions to improve this plugin., _(*18)

Created By

Bernardo Silva, _(*19)

License

MIT © Bernardo Silva, _(*20)