padosoft / hooks
Padosoft git hooks
Requires
- fabpot/php-cs-fixer: ^1.11
- padosoft/static-review: ^1.1.0
README
Padosoft git hooks
Table of Contents
- hooks
- Table of Contents
- Prerequisites
- Install
- Usage
- Example
- Screenshots
- Change Log
- Testing
- Contributing
- Security
- API Documentation
- Credits
- About Padosoft
- License
Prerequisites
Install
This package can be installed through Composer.
composer require padosoft/hooks
If you install in a laravel project add in config->app.php the following value in service providers array:
Padosoft\Hooks\HooksServiceProvider::class,
then use php artisan vendor:publish
In a non-laravel project you must copy the .php_cs file from vendor/padosoft/hooks/src/config to the root of project, and the pre-commit file from vendor/padosoft/hooks/src/config to .git/hooks folder. If you want customize the static-review operation create hooks folder in the root of project then copy pre-commit.php file from vendor/padosoft/static-review/src/config/pre-commit.php.
Be careful in a linux or mac environment change
php.exe "vendor/padosoft/hooks/src/php-cs-fix.php" php.exe "vendor/padosoft/hooks/src/static-review-pre-commit.php"
in the .git/hooks/pre-commit file to
php "vendor/padosoft/hooks/src/php-cs-fix.php" php "vendor/padosoft/hooks/src/static-review-pre-commit.php"
Usage
Pre-commit git hook is invoked by git commit. Exiting with non-zero status from this script causes the git commit to abort. Can be bypassed with --no-verify option.
Example
Screenshots
Change Log
Please see CHANGELOG for more information what has changed recently.
Testing
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Security
If you discover any security related issues, please email instead of using the issue tracker.
API Documentation
Credits
About Padosoft
Padosoft is a software house based in Florence, Italy. Specialized in E-commerce and web sites.
License
The MIT License (MIT). Please see License File for more information.