iodigital-com / composer-git-hooks
iO Composer Git Hooks
Installs: 9 591
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 7
Forks: 1
Open Issues: 0
Type:composer-plugin
Requires
- php: ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0
- composer-plugin-api: ^2.0
Requires (Dev)
- composer/composer: ^2.0
- iodigital-com/php-code-sniffer-standard: ^29.0
- phpstan/extension-installer: ^1.2.0
- phpstan/phpstan: ^1.10.1
- phpstan/phpstan-strict-rules: ^1.5.0
- slevomat/coding-standard: ^7.1.0 || ^8.0
Replaces
- dev-develop
- v3.1.0
- v3.0.1
- v3.0.0
- v2.2.0
- v2.1.0
- v2.0.0
- v1.3.0
- v1.2.0
- 1.1.0
- 1.0.2
- 1.0.1
- 1.0.0
- 0.2.1
- 0.2.0
- 0.1.5
- 0.1.4
- 0.1.3
- 0.1.2
- 0.1.1
- 0.1.0
- 0.0.3
- 0.0.2
- 0.0.1
- dev-main
- dev-feature/add-php-8.3-support
- dev-fix/create-symlinks-when-current-symlink-is-broken
- dev-feature/ICOMP-804-rebrand-to-iodigital-namespace
- dev-feature/add-static-analysis-github-workflow
This package is auto-updated.
Last update: 2024-09-06 17:31:37 UTC
README
Composer plugin to manage git hooks from bin/git-hooks/[hook].d
folders.
How it works:
- Include the package as a dev dependency
- On execution of Composer's
install
andupdate
commands, symlinks will be created from.git/hooks/[hook]
to this module'sscripts/chain-hook
script for all non-remote git hooks. - The
chain-hook
script will run the scripts found in the project'sbin/git-hooks/[hook].d
folder.
Prerequisites
- A composer-managed project
Install
Add the package as a dev dependency.
composer require --dev iodigital-com/composer-git-hooks
Add the package to the allow-plugins section of your composer.json
file:
{ "config": { "allow-plugins": { ... "iodigital-com/composer-git-hooks": true ... } } }
Running the script manually
This package is a composer plugin and will install the githooks automatically on composer install
and composer update
. Should you need it however, you can run the installer manually by adding it as a composer script and executing it.
Add the following to composer.json
:
"scripts": { ... "install-git-hooks": "IODigital\\ComposerGitHooks\\ComposerPlugin::process" ... },
Run it:
composer run-script install-git-hooks
Usage
Add project specific git-hooks to bin/git-hooks/[hook].d
. For example:
bin/git-hooks/pre-commit.d/phpstan
bin/git-hooks/pre-commit.d/phpcs
All scripts (for in this case pre-commit
) should give a 0 exit code for the whole hook to succeed.
Contribute
Create a pull request.
This package makes use of the composer
plugin interface. See the composer documentation.