README

应用于所有 WP Jazz 项目的 WordPress 编码标准。

提供一套规则集和扩展，用于

这些编码标准在Human Made 编码标准的基础上进行扩展。

安装

composer require --dev wp-jazz/coding-standards

此包将安装支持的 PHPCS、PHPStan 和 Psalm 版本。

有关样板配置文件，请参阅示例目录。

我们的 PHPCS 规则集扩展了 PHP 和 WordPress 的 Human Made 编码标准。

运行以下命令以运行标准检查

./vendor/bin/phpcs --standard=vendor/wp-jazz/coding-standards .

或者在您的 phpcs.xml 中包含以下内容

<!-- Use WP Jazz Coding Standards -->
<rule ref="Jazz" />

PHPCS 规则集基于

并进行自定义、排除和添加以符合我们的风格。

运行以下命令以运行静态分析

./vendor/bin/phpstan analyze -c vendor/szepeviktor/phpstan-wordpress/extension.neon .

使用 phpstan/extension-installer 让 PHPStan 自动查找

composer require --dev phpstan/extension-installer

或者在您的 phpstan.neon 中手动包含它

includes:
  - vendor/szepeviktor/phpstan-wordpress/extension.neon

有关配置 PHPStan 的更多信息，请参阅 Viktor Szépe 的szepeviktor/phpstan-wordpress 包。

./vendor/bin/psalm -c vendor/wp-jazz/coding-standards/psalm.xml.dist .

使用 Psalm 启用插件

./vendor/bin/psalm-plugin enable humanmade/psalm-plugin-wordpress

或者手动将其包含在您的 psalm.xml 中

<plugins>
  <pluginClass class="PsalmWordPress\Plugin" />
</plugins>

有关配置 Psalm 的更多信息，请参阅 Human Made 的humanmade/psalm-plugin-wordpress 包。

我们建议使用 Human Made 的 JavaScript 编码标准，它使用 ESLint。

npx install-peerdeps --dev @humanmade/eslint-config@latest

有关配置 ESLint 的更多信息，请参阅@humanmade/eslint-config 包的 README。

我们建议使用 Human Made 的 CSS 和 SCSS 编码标准，它使用 Stylelint。

npm install --save-dev stylelint @humanmade/stylelint-config

有关配置 Stylelint 的更多信息，请参阅@humanmade/stylelint 包的 README。