README

这是一套针对WordPress开发的现代（PHP >7）代码规范。由于PHP版本较新，不适用于核心WordPress的开发，但对于不受PHP 5.2限制的开发者可能很有用。

这些规范主要在Automattic内部的团队中开发，任何人都可以自由使用它们，提出更改建议或报告错误。

这是一个phpcs "标准"项目（一组规则或"sniffs"集合），可以包含在任何项目中。

这是一个元项目，因为它只是对这些包中定义的规则进行了一些修改的集合

安装

要在一个使用composer设置的项目中使用这些规则，我们建议使用phpcodesniffer-composer-installer库，在运行phpcs时，它将自动使用当前项目中所有安装的标准，使用composer类型phpcodesniffer-standard。

composer require --dev squizlabs/php_codesniffer dealerdirect/phpcodesniffer-composer-installer
composer require --dev automattic/phpcs-cobalt-ruleset

配置

在项目中安装sniff标准时，你将编辑一个带有ruleset标签内的rule标签的phpcs.xml文件。该标签的ref属性应指定一个标准、类别、sniff或错误代码以启用。还可以使用这些标签禁用或修改某些规则。官方注释文件说明了如何进行此操作。

以下配置将启用此规则集中所有sniffs。

<?xml version="1.0"?>
<ruleset name="MyStandard">
 <description>My library.</description>
 <rule ref="CobaltRuleset"/>
</ruleset>

使用

大多数编辑器都提供phpcs插件，但您也可以手动运行phpcs。要在项目中的文件上运行phpcs，请使用以下命令行（-s会导致显示sniff代码，这对于了解错误非常重要）。

vendor/bin/phpcs -s src/MyProject/MyClass.php

automattic / phpcs-cobalt-ruleset

维护者

详细信息

README

安装

配置

使用