wtyd/githooks

Manage git hooks in a simple and sophisticated way.

v2.3.0 2022-07-06 16:25 UTC

This package is auto-updated.

Last update: 2022-11-19 16:08:28 UTC


README

68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f577479642f676974686f6f6b73 68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f577479642f676974686f6f6b73 68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f577479642f676974686f6f6b73 PHP Versions Supported 68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f577479642f676974686f6f6b73

badge.svg badge.svg badge.svg

Wtyd/GitHooks

Are many other tools and composer plugins for manage git hooks. But GitHooks offers:

  • Standalone app. GitHooks is a binary (.phar) so its dependencies don't interfere with your application's dependencies.
  • Is managed with composer. You don't need other tools like Phive or others.
  • Crentralizes all QA tools configuration (all of supported tools at least).
  • It abstracts developers away from how QA tools have to be executed by using only the githooks tool name-of-the-tool command.
  • You can also create your own scripts and configure any git hook.

Further, it can be used together with javascript validation tools like typicode/husky if you have hybrid projects.

Requirements

  • PHP >= 7.1
  • The tools you need to check the code.
  • Or your owns scripts for the hooks.

Install

  1. GitHooks must be installed like dev requirement with composer. Currently, it does not have .phar packaging.
    composer require --dev wtyd/githooks

Note: for php 7.1 or 7.2 you must add the next post-update-cmd event to the scripts section in your composer.json:

"scripts": {
    "post-update-cmd": [
      "Wtyd\\GitHooks\\Utils\\ComposerUpdater::php72orMinorUpdate"
    ]
}

Then run composer update wtyd/githooks.

  1. Install all needed supported tools. How you install the tools doesn't matter.

  2. Initialize GitHooks with githooks conf:init. This command creates the configuration file in the root path (githooks.yml).

  3. Run githooks hook. It Copies the script for launch GitHooks on the precommit event in .git/hooks directory. You can, also run githooks hook otherHook MyScriptFile.php for set any hook with a custom script. See the wiki for more information.

  4. Set the configuration file.

Usage

When you commit, all the configured code check tools are automatically launched. If your code pass all checks, GitHooks allows you to commit. If not, you have to fix the code and try again:

Imagen todo OK

Imagen con KO

You can also run GitHooks whenever you want. All tools at same time or one by one:

githooks tool all # Run all tools
githooks tool phpcs # Run only phpcs

Imagen de una herramienta

Supported Tools

At this moment, the supported tools are:

But you can set your own script on any git hook.

Set the Configuration File

The githooks.yml file is splitted on three parts:

Options

Execution

The execution flag marks how GitHooks will run:

  • full (the default option): executes always all tools setted against all path setted for each tool. For example, you setted phpcs for run in src and app directories. The commit only contains modified files from database directory. Phpcs will check src and app directories even if no files in these directories have been modified.
  • fast: this option runs the tools only against files modified by commit.
    • This option only affects the following tools: phpcs, phpmd, phpstan, and parallel-lint. The rest of the tools will run as the full option.
    • WARNING!!! You must set the excludes of the tools either in githooks.yml or in the configuration file of eath tool since this option overwrites the key paths of the tools so that they are executed only against the modified files.

Processes

Run multiple tools in multiple processes at same time (tool all command). The default number of processes is 1.

Tools

It is an array with the name of the tools that GitHooks will run. The name of the tools is their executable. If you want all the tools to be executed, the Tools key will be as follows:

Tools:
    - phpstan
    - security-checker
    - parallel-lint
    - phpcs
    - phpcbf
    - phpmd
    - phpcpd

The order in which the tools are is the order in which they will be executed.

Setting Tools

In next step you must configure the tools with the same name as in the Tools key. For example, for set phpcs:

phpcs:
    executablePath: vendor/bin/phpcs
    paths: [src, tests]
    ignore: [vendor]
    standard: 'PSR12'

All the available options are in the wiki.

Contributing

Contributions from others would be very much appreciated! Send pull request/issue. Check all steps for do that at Wiki section for Contributing. Thanks!

License

The MIT License (MIT). Please see License File for more information.