README

这是一套针对 WordPress 开发的现代（PHP >7）代码检查指南。由于使用较新的 PHP 版本，它不适合用于 Core WordPress 的工作，但对于不受 PHP 5.2 限制的人来说可能很有用。

警告

重要提示：该项目已不再积极开发。在 Automattic，我们已转向使用 WordPress 编码标准 + VariableAnalysis。

这些指南主要针对 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-ruleset

配置

在项目中安装嗅探标准时，您需要编辑一个包含在 ruleset 标签内的 phpcs.xml 文件，其中的 rule 标签的 ref 属性应指定一个标准、类别、嗅探或错误代码以启用。还可以使用这些标签禁用或修改某些规则。有关如何操作的说明，请参阅官方注释文件。

以下配置将启用此规则集中的所有嗅探。

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

用法

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

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

automattic / phpcs-neutron-ruleset

维护者

详细信息

README

安装

配置

用法