README

Table of contents

• Requirements
• How to install
  • Enabling the rules
  • Sniffing code
  • Sniffing code in PHPStorm
• Change log

Requirements

• squizlabs/php_codesniffer 3.6 or higher

How to install

composer require noisivlagel/quality-tools --dev

How to use

Enabling the rules

Add it to your project phpcs.xml or phpcs.xml.dist ruleset:

<?xml version="1.0"?>
<ruleset>
    <arg name="basepath" value="."/>

    <file>./src</file>
    <file>./tests</file>

    <rule ref="./vendor/noisivlagel/quality-tools/ruleset.xml"/>
</ruleset>

Sniffing code

The following commands can be added to the scripts section of your composer.json file to check and fix invalid code. Some optional checks are also included to illustrate how they might work together to check all your code.

{
    "scripts": {
        "composer-validate": "@composer validate --no-check-all --strict",
        "codesniffer-check": "vendor/bin/phpcs --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1",
        "codesniffer-fix": "vendor/bin/phpcbf --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 || exit 0",
        "test": "vendor/bin/phpunit",
        "check": [
            "@composer-validate",
            "@codesniffer-check",
            "@test"
        ]
    }
}

GrumPHP

Grumphp is a tool that can add a pre-commit hook to test different rules : https://github.com/phpro/grumphp

We check for :

• git conventional commit (https://www.conventionalcommits.org/en/v1.0.0/#specification)
• phpCodeSniffer ruleset.

Sniffing code in PHPStorm

See PHP Code Sniffer in PhpStorm on how to set up CodeSniffer in PHPStorm.

Change log

Please see CHANGELOG for more information what has changed recently.