README

需求

squizlabs/php_codesniffer 3.3.1 或更高版本
slevomat/coding-standard 4.7 或更高版本

如何安装

composer require sebastiaanluca/php-codesniffer-ruleset --dev

如何使用

启用规则

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

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

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

    <rule ref="./vendor/sebastiaanluca/php-codesniffer-ruleset/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"
        ]
    }
}

在PHPStorm中检查代码

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

许可证

此包在MIT许可证（MIT）下运行。有关更多信息，请参阅 LICENSE。

变更日志

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

贡献

有关详细信息，请参阅 CONTRIBUTING 和 CONDUCT。

安全

如果您发现任何安全相关的问题，请通过电子邮件 hello@sebastiaanluca.com 而不是使用问题跟踪器。

致谢

关于

我叫Sebastiaan，是一名专注于构建自定义Laravel应用程序的自由职业Laravel开发者。查看我的作品集以获取更多信息，查看我的博客获取最新技巧和窍门，以及我的其他软件包以启动您的下一个项目。

您有一个可能需要指导的项目吗？请通过hello@sebastiaanluca.com给我发邮件！

sebastiaanluca / php-codesniffer-ruleset

维护者

详细信息