README

这里有一套针对EventsMadeLive PHP项目的代码检查指南。它主要借鉴了Automattic的Neutron规则集。

这是一套针对WordPress开发的现代（PHP>7）代码检查指南。由于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-ruleset

配置

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

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

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

使用方法

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

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

brandonkal / phpcs-neutron-refined

维护者

详细信息

README

安装

配置

使用方法