README

警告

重要说明：此项目不再积极开发。在Automattic，我们已经转向使用WordPress编码标准。

这是一套针对现代（PHP >7）的代码检查指南，旨在与WordPress编码标准一起应用于WordPress开发。由于使用了较新的PHP版本，因此它不适用于WordPress核心的开发，但对于不受PHP 5.2限制的开发者可能很有用。

这些指南主要是在Automattic内部的一个团队中开发的，但任何人都可以自由使用它们、提出更改或报告错误。

此项目是一个phpcs "标准"（一组规则或"嗅探器"），可以包含在任何项目中。

安装

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

composer require --dev squizlabs/php_codesniffer dealerdirect/phpcodesniffer-composer-installer
composer require --dev automattic/phpcs-neutron-standard

如果您需要此标准、WordPress标准、VariableAnalysis标准和其它自定义，您可以安装meta-standard NeutronRuleset。

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

配置

在项目中安装嗅探规则时，您需要编辑一个phpcs.xml文件，并在ruleset标签内使用rule标签。该标签的ref属性应指定一个标准、类别、嗅探器或错误代码以启用。也可以使用这些标签禁用或修改某些规则。官方注释文件解释了如何进行操作。

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

使用方法

大多数编辑器都有phpcs插件可用，但您也可以手动运行phpcs。要在您的项目中运行phpcs，请按以下命令行操作（-s选项会显示嗅探代码，这对于了解错误非常重要）。

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

指南

在此处查看指南。

automattic / phpcs-neutron-standard

维护者

详细信息

README

安装

配置

使用方法

指南