README

Composer 库，用于提供 WPCS 和 PHPCompatibilityWP 的即插即用安装和配置，设置合理的默认值以实现几乎零配置的 WordPress 开发。

安装

您必须将存储库添加到 composer.json

{
    "repositories": [
        {
            "type": "git",
            "url": "https://github.com/wcvendors/wc-vendors-phpcs.git"
        }
    ]
}

通过 Composer 安装库

$ composer require --dev wcvendors/wc-vendors-phpcs:dev-main

使用以下命令检查 PHP 文件的 Lint

$ ./vendor/bin/phpcs

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

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

然后通过以下方式检查

$ composer run lint

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

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

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

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

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

PHPCS 的某些 IDE 集成未能注册 WCVendors-WordPress-Default 规则集。为了纠正此问题，请在项目根目录放置 .phpcs.xml.dist

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