toin0u/cakephp-codesniffer

CakePHP CodeSniffer 标准

2.0.3 2015-03-17 01:11 UTC

README

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

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

安装

您应该使用 composer 安装此 codesniffer

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

第二个命令让 phpcs 知道如何找到您的新 sniffs。确保不要覆盖任何现有的 installed_paths 值。

用法

根据您如何安装代码检查器,运行方式可能会有所不同。如果您已安装 phpcs 并使用 PEAR 安装了此包,您可以执行以下操作

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

⚠️ 警告:当这些 sniffs 使用 composer 安装时,请确保您已配置 CodeSniffer 的 installed_paths 设置。

贡献

如果您想为 Code Sniffer 贡献,您可以创建项目的分支、添加功能并提交 pull request。

请确保将仓库克隆为类似于 cakephp_codesniffer 的名称(而不是默认的 cakephp-codesniffer),否则 phpunit 将无法运行测试。

发布 CakePHP Code Sniffer

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