README

Bluehost WordPress项目的PHP代码检查标准。

安装

将此Satis仓库添加到您的composer.json文件中

"repositories": [
    {
      "type": "composer",
      "url": "https://bluehost.github.io/satis/"
    }
  ],

在项目根目录下运行composer require bluehost/wp-php-standards。

使用

在项目根目录下运行vendor/bin/phpcs . --standard=Bluehost以检查您的代码。

可选地，将脚本添加到您的composer.json文件中，以便您可以仅运行composer run lint来检查代码。

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

附加说明

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

<?xml version="1.0"?>
<ruleset name="Project Rules">
  <rule ref="Bluehost" />
  <config name="testVersion" value="5.2-"/>
  <config name="minimum_supported_wp_version" value="4.7"/>
</ruleset>

附加文档

IDE集成

由于PHPCS的某些IDE集成没有在项目根目录中运行，因此无法注册您的规则集。为了纠正这个问题，请将phpcs.xml放在项目根目录下

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

PHPStorm配置

打开首选项面板。
转到“语言和框架”>“PHP”>“代码检查器”。
确保“配置”部分在下拉菜单中选择“本地”。点击“...”按钮。
将“PHP代码检查器路径”设置为"{projectRoot}/vendor/bin/phpcs"，其中"{projectRoot}"是您的项目根目录的实际路径。
点击“确定”。
在首选项面板中转到“编辑器”>“检查”。
在“PHP”>“质量工具”部分下点击“PHP代码检查器验证”。
点击右侧“编码标准”字段旁边的刷新按钮。
从下拉菜单中选择“Bluehost”。
点击“确定”退出首选项面板。

bluehost / wp-php-standards

维护者

详细信息

README

安装

使用

附加说明

附加文档

IDE集成

PHPStorm配置