A powerful and easy-to-use package for managing Git hooks within your Laravel projects. Improve your code quality, reduce the time spent on code reviews, and catch potential bugs before they make it into your repository.
- Pre-configured Hooks: Laravel Git Hooks comes with pre-configured pre-commit hooks for popular tools, such as Laravel Pint, PHPCS, ESLint, Prettier, Larastan, Enlightn, Rector, PHP Insights and Blade Formatter, making it easy to enforce coding standards and style guidelines right away.
- Manage Git Hooks: Easily manage your Git hooks in your Laravel projects with a streamlined and organized approach.
- Edit Commit Messages: Gain control over your commit messages by customizing them to meet your project requirements and maintain a clean Git history.
- Create Custom Hooks: Add and integrate custom hooks tailored to your specific project needs, ensuring better code quality and adherence to guidelines.
- Artisan Command for Hook Generation: The package includes a convenient Artisan command that allows you to effortlessly generate new hooks of various types. Such as:
pre-commit,prepare-commit-msg,commit-msg,post-commit,pre-push - Code Quality: The package is thoroughly tested, with >95% of code coverage, ensuring its reliability and stability in a wide range of Laravel projects.
- Docker support: Each hook can be configured to either run locally or inside a docker container.
- You can install the package via composer:
composer require igorsgm/laravel-git-hooks --dev- Publish the config file and customize it in the way you want:
php artisan vendor:publish --tag=laravel-git-hooks- Now whenever you make a change in your
config/git-hooks.phpfile, please register your git hooks by running the artisan command:
php artisan git-hooks:registerOnce you've configured and registered the hooks, you're all set!
To use the already created pre-commit hooks of this package, you can simply edit the pre-commit section of git-hooks.php config file. Here's an example of how to configure them:
'pre-commit' => [
\Igorsgm\GitHooks\Console\Commands\Hooks\PintPreCommitHook::class, // Laravel Pint
\Igorsgm\GitHooks\Console\Commands\Hooks\PHPCodeSnifferPreCommitHook::class, // PHPCS (with PHPCBF autofixer)
\Igorsgm\GitHooks\Console\Commands\Hooks\LarastanPreCommitHook::class, // Larastan
\Igorsgm\GitHooks\Console\Commands\Hooks\EnlightnPreCommitHook::class, // Enlightn
\Igorsgm\GitHooks\Console\Commands\Hooks\ESLintPreCommitHook::class, // ESLint
\Igorsgm\GitHooks\Console\Commands\Hooks\PrettierPreCommitHook::class, // Prettier
\Igorsgm\GitHooks\Console\Commands\Hooks\PhpInsightsPreCommitHook::class, // PhpInsights
\Igorsgm\GitHooks\Console\Commands\Hooks\RectorPreCommitHook::class, // Rector
],By default the pre-commit hooks will stop at first failure and will not continue with the remaining tools.
If the tool contains a fixer option it will prompt in the CLI to run the fix command.
This behavior can be adjusted using the following parameters from git-hooks.php config file:
/*
|--------------------------------------------------------------------------
| Automatically fix errors
|--------------------------------------------------------------------------
|
| This configuration option allows you to configure the git hooks to
| automatically run the fixer without any CLI prompt.
|
*/
'automatically_fix_errors' => false,
/*
|--------------------------------------------------------------------------
| Automatically re-run analyzer after autofix
|--------------------------------------------------------------------------
|
| This configuration option allows you to configure the git hooks to
| automatically re-run the analyzer command after autofix.
| The git hooks will not fail in case the re-run is succesful.
|
*/
'rerun_analyzer_after_autofix' => false,
/*
|--------------------------------------------------------------------------
| Stop at first analyzer failure
|--------------------------------------------------------------------------
|
| This configuration option allows you to configure the git hooks to
| stop (or not) at the first analyzer failure encountered.
|
*/
'stop_at_first_analyzer_failure' => true,There are also several debug options which can be adjusted using the following parameters from git-hooks.php config file:
/*
|--------------------------------------------------------------------------
| Output errors
|--------------------------------------------------------------------------
|
| This configuration option allows you output any errors encountered
| during execution directly for easy debug.
|
*/
'output_errors' => false,
/*
|--------------------------------------------------------------------------
| Debug commands
|--------------------------------------------------------------------------
|
| This configuration option allows you to configure the git hooks to
| display the commands that are executed (usually for debug purpose).
|
*/
'debug_commands' => false,
/*
|--------------------------------------------------------------------------
| Debug output
|--------------------------------------------------------------------------
|
| This configuration option allows you display the output of each
| command during execution directly for easy debug.
|
*/
'debug_output' => false,If you are using Laravel Sail and maybe not lokal PHP is installed, you can adjust the following parameters in the git-hooks.php config file:
'use_sail' => env('GITHOOKS_USE_SAIL', false),This will force the local git hooks to use the sail command to execute the hooks.
By default commands are executed locally, however this behavior can be adjusted for each hook using the parameters run_in_docker and docker_container:
'run_in_docker' => env('LARAVEL_PINT_RUN_IN_DOCKER', true),
'docker_container' => env('LARAVEL_PINT_DOCKER_CONTAINER', 'app'),- If you need to create a custom Git hook for your project, Laravel Git Hooks makes it easy with the
git-hooks:makeArtisan command. To create a new custom hook, simply run the following command:This command will prompt you to choose the type of hook you want to create (e.g.,php artisan git-hooks:make
pre-commit,post-commit, etc.) and to provide a name for the hook. Once you've provided the required information, the command will generate a new hook class in theapp/Console/GitHooksdirectory. - To start using your custom hook, open the generated file and implement the
handle()method with your desired logic. - Add your custom hook to the appropriate array in the git-hooks.php config file:
'pre-commit' => [
// Other pre-commit hooks...
\App\Console\GitHooks\MyCustomPreCommitHook::class,
],- Finally register your custom hook by running the artisan command:
php artisan git-hooks:registerThe pre-commit hook is run first, before you even type in a commit message. It's used to inspect the snapshot that's about to be committed, to see if you've forgotten something, to make sure tests run, or to examine whatever you need to inspect in the code. Exiting non-zero from this hook aborts the commit, although you can bypass it with git commit --no-verify. You can do things like check for code style (run lint or something equivalent), check for trailing whitespace (the default hook does exactly this), or check for appropriate documentation on new methods.
// config/git-hooks.php
return [
...
'pre-commit' => [
\App\Console\GitHooks\MyPreCommitHook::class,
],
...
];// App/Console/GitHooks/MyPreCommitHook.php
namespace App\Console\GitHooks;
use Closure;
use Igorsgm\GitHooks\Git\ChangedFiles;
class MyPreCommitHook implements \Igorsgm\GitHooks\Contracts\PreCommitHook
{
// ...
public function handle(ChangedFiles $files, Closure $next)
{
// TODO: Implement your pre commit hook logic here.
// If you want to cancel the commit, you have to throw an exception.
// i.e: throw new HookFailException();
// Run the next hook in the chain
return $next($files);
}
}The prepare-commit-msg hook is run before the commit message editor is fired up but after the default message is created. It lets you edit the default message before the commit author sees it. This hook takes a few parameters: the path to the file that holds the commit message so far, the type of commit, and the commit SHA-1 if this is an amended commit. This hook generally isn't useful for normal commits; rather, it's good for commits where the default message is auto-generated, such as templated commit messages, merge commits, squashed commits, and amended commits. You may use it in conjunction with a commit template to programmatically insert information.
// config/git-hooks.php
return [
...
'prepare-commit-msg' => [
\App\Console\GitHooks\MyPrepareCommitMessageHook::class,
],
...
];// App/Console/GitHooks/MyPrepareCommitMessageHook.php
namespace App\Console\GitHooks;
use Closure;
use Igorsgm\GitHooks\Git\CommitMessage;
use Igorsgm\GitHooks\Contracts\MessageHook;
class MyPrepareCommitMessageHook implements \Igorsgm\GitHooks\Contracts\MessageHook
{
// ...
public function handle(CommitMessage $message, Closure $next)
{
// TODO: Implement your prepare commit msg hook logic here.
$currentMessage = $message->getMessage();
// You can update commit message text
$message->setMessage(str_replace('issue', 'fixed', $currentMessage));
// If you want to cancel the commit, you have to throw an exception.
// i.e: throw new HookFailException();
// Run the next hook in the chain
return $next($message);
}
}The commit-msg hook takes one parameter, which again is the path to a temporary file that contains the commit message written by the developer. If this script exits non-zero, Git aborts the commit process, so you can use
// config/git-hooks.php
return [
...
'commit-msg' => [
\App\Console\GitHooks\MyCommitMessageHook::class,
],
...
];The class structure of the commit-msg hook is the same as the prepare-commit-msg hook, shown right above.
After the entire commit process is completed, the post-commit hook runs. It doesn't take any parameters, but you can easily get the last commit by running git log -1 HEAD. Generally, this script is used for notification or something similar.
// config/git-hooks.php
return [
...
'post-commit' => [
\App\Console\GitHooks\MyPostCommitHook::class,
],
...
];// App/Console/GitHooks/MyPrepareCommitMessageHook.php
namespace App\Console\GitHooks;
use Closure;
use Igorsgm\GitHooks\Git\CommitMessage;
use Igorsgm\GitHooks\Contracts\PostCommitHook;
class MyPostCommitHook implements \Igorsgm\GitHooks\Contracts\PostCommitHook
{
// ...
public function handle(Log $log, Closure $next)
{
// TODO: Implement post commit hook logic here.
// You can interact with the commit log
$hash = $log->getHash();
$author = $log->getAuthor();
$date = $log->getDate();
$message = $log->getMessage();
// If you want to cancel the commit, you have to throw an exception.
// i.e: throw new HookFailException();
// Run the next hook in the chain
return $next($log);
}
}The pre-push hook runs during git push, after the remote refs have been updated but before any objects have been transferred. It receives the name and location of the remote as parameters, and a list of to-be-updated refs through stdin. You can use it to validate a set of ref updates before a push occurs (a non-zero exit code will abort the push).
// config/git-hooks.php
return [
...
'pre-push' => [
\App\Console\GitHooks\MyPrePushHook::class,
],
...
];The class structure of the pre-push hooks is the same as the post-commit hook shown right above, but implementing \Igorsgm\GitHooks\Contracts\PrePushHook interface.
composer testPlease see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
The MIT License (MIT). Please see License File for more information.