README

此代码与 squizlabs/php_codesniffer 兼容，并检查代码是否符合 CakePHP 使用的编码标准。

此嗅探器包完全遵循 PSR-12，并附带大量附加修复器。

我应该使用哪个版本？

安装

您应使用 composer 安装此 codesniffer

composer require --dev cakephp/cakephp-codesniffer
vendor/bin/phpcs --config-set installed_paths /path/to/your/app/vendor/cakephp/cakephp-codesniffer

第二个命令让 phpcs 知道如何找到您的新嗅探。请确保您没有覆盖任何现有的 installed_paths 值。或者，安装 dealerdirect/phpcodesniffer-composer-installer composer 包，该包将为您处理配置 phpcs 的 installed_paths。

使用方法

⚠️ 注意：当这些嗅探器使用 composer 安装时，请确保您已配置 CodeSniffer 的 installed_paths 设置。

根据您如何安装代码嗅探器，运行它的方式可能会有所不同。如果您已安装 phpcs 和此包，您可以使用以下方法

vendor/bin/phpcs --colors -p -s --standard=CakePHP /path/to/code/

您还可以将 phpcs.xml.dist 文件复制到项目的根目录作为 phpcs.xml。此文件将导入 CakePHP 编码标准。从那里您可以编辑它以包括/排除所需的内容。使用此文件后，您可以运行

vendor/bin/phpcs --colors -p -s /path/to/code/

如果您使用 Composer 管理您的 CakePHP 项目，您也可以将其添加到您的 composer.json 文件中

{
    "scripts": {
        "cs-check": "vendor/bin/phpcs --colors -p -s --extensions=php src/ tests/"
    }
}

运行测试

您可以使用 composer 运行测试。由于 PHPCS 测试套件的运作方式，phpcs 需要额外的配置状态。

composer test

完成一次后，您可以使用 phpunit --filter CakePHP 运行此存储库中的规则测试。

贡献

如果您想为 Code Sniffer 贡献，您可以分叉项目，添加功能并发送 pull 请求。

发布 CakePHP Code Sniffer

创建一个签名标签
在标签提交中编写更改日志

cakephp / cakephp-codesniffer

维护者

详细信息

README

我应该使用哪个版本？

安装

使用方法

运行测试

贡献

发布 CakePHP Code Sniffer