README

需求

squizlabs/php_codesniffer 3.6 或更高版本

如何安装

composer require noisivlagel/quality-tools --dev

如何使用

启用规则

将其添加到项目的 phpcs.xml 或 phpcs.xml.dist 规则集中

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

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

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

代码嗅探

以下命令可以添加到您的 composer.json 文件的 scripts 部分，以检查和修复无效代码。还包含一些可选的检查，以说明它们如何一起工作以检查所有代码。

{
    "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 是一个可以添加预提交钩子以测试不同规则的工具：https://github.com/phpro/grumphp

我们检查

git conventional commit (https://www.conventionalcommits.org/en/v1.0.0/#specification)
phpCodeSniffer 规则集。

在 PHPStorm 中代码嗅探

有关如何在 PhpStorm 中设置 CodeSniffer 的信息，请参阅 PHP Code Sniffer in PhpStorm。

变更日志

有关最近更改的更多信息，请参阅 CHANGELOG。

noisivlagel / quality-tools

维护者

详细信息