README

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

⚠️ master 分支包含基于 PSR2 标准的 CodeSniffer 规则。如果您想检查历史 CakePHP 编码标准，请使用任何 1.x 版本的发布。

安装

您应该使用 composer 安装此代码规范

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

第二个命令让 phpcs 知道如何找到您的新嗅探器。请确保您没有覆盖任何现有的 installed_paths 值。

用法

根据您如何安装代码规范，运行方式可能会有所不同。如果您已安装 phpcs 和此包，您可以使用以下命令：

vendor/bin/phpcs --standard=CakePHP /path/to/code

⚠️ 警告：当这些嗅探器通过 composer 安装时，请确保您已配置 CodeSniffer 的 installed_paths 设置。

运行测试

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

composer test

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

贡献

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

发布 CakePHP Code Sniffer

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

jacricelli / cakephp-codesniffer

维护者

详情

README

安装

用法

运行测试

贡献

发布 CakePHP Code Sniffer