README

此存储库包含基于 Yii 2 的应用的 Mito 编码规范。

获取代码

您可以使用以下方法之一获取代码风格定义。

$ git clone git://github.com/hellowearemito/yii2-coding-standards.git

$ composer require mito/yii2-coding-standards:"~2.0.0@beta"

此存储库包含五个 phpcs 标准

这些标准基于 PSR2 和 Yii 2 的编码规范，并添加了一些改进。

Views 标准禁用了某些规则，这些规则在将 PHP 与 HTML 混合时会导致问题，因此无法完全检查视图文件并无法修复其中所有问题，因此在使用 phpcbf 与视图文件时要小心。

有关规则的完整描述，请参阅 docs/rules.md。

安装 CodeSniffer 后，可以使用以下语法使用自定义标准启动它

$ ./vendor/bin/phpcs --extensions=php --standard=vendor/mito/yii2-coding-standards/Application .

要自动修复大多数问题，请使用 phpcbf

$ ./vendor/bin/phpcbf --extensions=php --standard=vendor/mito/yii2-coding-standards/Application .

警告：始终检查 phpcbf 的输出并保留备份。如果它破坏了您的代码，您将保留两份。

在运行 phpcbf 之前，您还应该使用 php -l 运行语法检查，因为一些嗅探假定代码在语法上是有效的，如果它不是，可能会对其进行破坏。

如果您正在使用 PhpStorm，可以配置它使用 CodeSniffer，方法是在设置中转到 PHP → Code Sniffer。标准可以在检查 → PHP → PHP Code Sniffer 验证中指定。

请注意，这将使用单个标准检查您的所有文件，但您应该为不同类型的文件使用不同的标准。这些标准是为与 gulp-phpcs 和 gulp-phpcbf 一起使用而设计的，因此，而不是在 ruleset.xml 中使用排除模式，它们依赖于 gulp 任务为文件选择适当的标准。

您可以编写自己的 ruleset.xml，它从 Application 标准扩展，并包含适当的排除模式（检查 Others 和 Views ruleset.xml 文件以确定要排除哪些规则）。

请参阅CONTRIBUTING.md获取信息。