README

为插件和主题开发提供高级配置的 WordPress 编码标准。

使用方法

安装 Composer
运行 composer init 为您的项目设置 Composer。
运行 composer require wpscholar/phpcs-standards-wpscholar 安装编码标准。
从您的项目根目录运行 vendor/bin/phpcs . --standard=WPScholar 检查您的代码。
可选地，将脚本添加到您的 composer.json 文件中，以便您只需运行 composer run lint 就可以检查代码。

"scripts": {
  "lint": [
    "vendor/bin/phpcs . --standard=WPScholar"
  ],
  "clean": [
    "vendor/bin/phpcbf . --standard=WPScholar"
  ]
}

附加说明

添加 -s 标志以查看规则的内部名称。
添加 --runtime-set testVersion 8.0- 以检查 PHP 8.0 或更高版本。
将自定义的 phpcs.xml 文件添加到您的项目中以自定义规则集或所需的配置。

<?xml version="1.0"?>
<ruleset name="Project Rules">
  <rule ref="WPScholar" />
  <config name="testVersion" value="8.0-"/>
  <config name="minimum_supported_wp_version" value="6.0"/>
</ruleset>

附加文档

IDE 集成

由于 PHPCS 的某些 IDE 集成不会在您的项目根目录中运行，因此可能会失败注册您的规则集。为了纠正此问题，请将 phpcs.xml 放在项目根目录

<?xml version="1.0"?>
<ruleset name="Project Rules">
    <rule ref="WPScholar"/>
</ruleset>

PHPStorm 设置

打开首选项面板。
转到 "Languages & Frameworks" > "PHP" > "Code Sniffer"。
确保 "Configuration" 部分下拉菜单中设置为 "Local"。点击 "..." 按钮。
将 "PHP Code Sniffer path" 设置为 "{projectRoot}/vendor/bin/phpcs"，其中 "{projectRoot}" 是您的项目根目录的实际路径。
点击 "OK"。
转到首选项面板中的 "Editor" > "Inspections"。
在 "PHP" > "Quality tools" 部分下点击 "PHP Code Sniffer validation"。
点击右侧 "Coding Standard" 字段旁边的刷新按钮。
从下拉菜单中选择 "Newfold"。
点击 "OK" 以退出首选项面板。

wpscholar / phpcs-standards-wpscholar

维护者

详细信息

README

使用方法

附加说明

附加文档

IDE 集成

PHPStorm 设置