README

Composer 库，用于提供 WPCS 和 PHPCompatibilityWP 的快速安装和配置，以合理默认设置进行 WordPress 开发，配置几乎为零。

安装

通过 Composer 安装库

$ composer require --dev plank/wp-phpcs-composer:master

这就完成了！

使用以下命令检查 PHP 文件

$ ./vendor/bin/phpcs .

如果依赖 Composer，请编辑 composer.json 文件，并添加以下内容

	"scripts": {
		"lint": [
			"phpcs ."
		],
	}

然后通过以下命令进行 lint 检查

$ composer run lint

PHPCS 配置与持续集成解决方案兼容。默认情况下，库加载 Plank-Default 规则集，并检查 PHP 7 或更高版本的语法错误。

要覆盖默认的 PHP 版本检查，请设置 --runtime-set testVersion 7.0- 配置选项。例如，对于 PHP 7.2 及以上版本

$ ./vendor/bin/phpcs --runtime-set testVersion 7.2-

有关指定 PHP 版本更多信息，请参阅此处。

请注意，您只能从命令行覆盖 PHP 版本检查。

一些 PHPCS 的 IDE 集成未能注册 Plank-Default 规则集。为了纠正这个问题，请将 .phpcs.xml.dist 放置在项目根目录下

<?xml version="1.0"?>
<ruleset name="Project Rules">
	<rule ref="Plank-Default" />
</ruleset>