README

此软件包包含在 WordPress 项目中使用的构建技术（=代码风格）。

关于

此软件包为 PHP_CodeSniffer 提供了一个规则集，该规则集扩展了 Timber 的规则集，Timber 由 WordPress 编码标准和一些添加的例外组成。与 WordPress 编码标准的偏差包括：

类文件名应遵循 PSR-4。
类名应使用 StudlyCaps。
行长度最大为 100 个字符（触发警告），
行长度在任何情况下都不应超过 120 个字符（触发错误）。
在钩子名称中允许使用 / 作为单词分隔符。
允许使用短数组语法（[]）。

先决条件

安装 Composer 以将此软件包添加到您的项目中。

安装

使用 Composer 安装软件包

composer require --dev achttienvijftien/building-techniques

安装后，phpcs 和 phpcbf 脚本将在 vendor/bin 文件夹中可用。

我们还建议安装 phpcodesniffer-composer-installer 以自动将编码标准与 PHP_CodeSniffer 注册

composer require --dev dealerdirect/phpcodesniffer-composer-installer

现在，运行 phpcs 时，编码标准应该可用。您可以通过运行以下命令来检查已安装的编码标准：

./vendor/bin/phpcs -i

列表应包含 1815BuildingTechniques。

使用方法

要使用适当的编码标准运行 PHP_CodeSniffer

./vendor/bin/phpcs --standard=1815BuildingTechniques path/to/file-or-directory

要修复可以自动纠正的代码风格违规

./vendor/bin/phpcbf --standard=1815BuildingTechniques path/to/file-or-directory

添加 composer 脚本

可以将 phpcs 和 phpcbf 的 composer 脚本添加到 composer.json 中以方便使用。

{
    "scripts": {
        "format": "phpcbf --standard=1815BuildingTechniques --report-summary --report-source",
        "lint": "phpcs --standard=1815BuildingTechniques"
    }
}

IDE 支持

有关如何将 PHP_Codesniffer 集成到 PhpStorm 等 IDE 的指南，请参阅 Wiki。

achttienvijftien / building-techniques

维护者

详细信息

README

关于

先决条件

安装

使用方法

添加 composer 脚本

IDE 支持