wickedreports/phpcs-pre-commit-hook

PHPCS check before commit

0.8 2021-02-25 11:37 UTC

Requires

• squizlabs/php_codesniffer: 3.5.8

GPL-3.0

• Stanislav Malkin

README

About

Auto installed git pre-commit hook for running PHP Code Sniffer code checking to PSR2 coding standard compliance. It checks only files that are to be committed.

Inspired by Enforce code standards with composer, git hooks, and phpcs and https://github.com/smgladkovskiy/phpcs-git-pre-commit and https://gist.github.com/BrizzleRocker/62ed61b37acf05344d4bce894e719251 . Installer checks OS on hosting machine and installs needed hooks for platform.

Installation

Install wickedreports/phpcs-pre-commit-hook with composer require command:

composer require "wickedreports/phpcs-pre-commit-hook"

Or alternatively, include a dependency for wickedreports/phpcs-pre-commit-hook in your composer.json file manually:

{
    "require-dev": {
        "wickedreports/phpcs-pre-commit-hook": "*"
    }
}

To enable code sniff, аdd to post-install-cmd and post-update-cmd in composer.json installation script:

"scripts": {
    "post-install-cmd": [
        "PHPCodeChecker\\Installer::postInstall"
    ],
    "post-update-cmd": [
        "PHPCodeChecker\\Installer::postInstall"
    ]
}

Then run composer install or composer update. pre-commit hook will be installed or updated if it already exists.

Usage

Run git commit and pre-commit hook will check your committed files like if you run

php phpcs.phar --standard=PSR2 --colors --encoding=utf-8 -n -p /path/to/file.php