README

WordPress 项目的 eighteen73 编码标准。

设置

每个规则集都可以通过 Composer 或 NPM 单独使用。要安装所需的规则集，请使用以下命令之一

PHPCS: composer require --dev eighteen73/wordpress-coding-standards
ESLint: npx install --save-dev @eighteen73/eslint-config-wordpress
stylelint: npm install --save-dev @eighteen73/stylelint-config-wordpress

使用 PHPCS

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

vendor/bin/phpcs --standard=vendor/eighteen73/wordpress-coding-standards .

我们使用 DealerDirect phpcodesniffer-composer-installer 包来处理 PHPCS 的 installed_paths，当首次安装 eighteen73 规则集时。如果您遇到错误，例如 ERROR: Referenced sniff "WordPress-Core" does not exist，请删除 composer.lock 文件和 vendor 目录，并重新安装 Composer 依赖项。

这里的最后一个 . 指定了要测试的文件；这通常是当前目录（.），但您也可以通过指定它们来选择性检查文件或目录。

包含的检查

PHPCS 标准基于 WordPress Coding Standards 的 WordPress-VIP 标准，并进行了定制和添加，以符合我们的风格指南。

排除/禁用检查

规则可以逐行禁用。可以使用 // @codingStandardsIgnoreLine 注释禁用 phpcs 规则，并使用 /* eslint disable ... */ 注释禁用 ESLint 规则。

要找出这些代码是什么，请在运行 phpcs 时指定 -s，然后代码将被输出。您可以指定完整代码，或部分代码以禁用错误组。

使用 ESLint

ESLint 包包含一个 ESLint 配置，您可以使用它来验证您的 JavaScript 代码样式。虽然可以通过 phpcs 运行 ESLint，但我们建议您通过 npm 直接安装并使用 eslint。有关如何配置 ESLint 以使用 eighteen73 编码标准的更多信息，请参阅 @eighteen73/eslint-config-wordpress 包的 README。

要将 eighteen73 规则集成到您的项目中，请添加一个 .eslintrc 文件并扩展这些规则。您还可以添加自己的规则和覆盖以进行进一步的自定义。

{
  "extends": "@eighteen73/eslint-config-wordpress"
  "rules": {
    ...
  }
}

使用 stylelint

stylelint 包包含一个 stylelint 配置，您可以使用它来验证您的 CSS 和 SCSS 代码样式。我们建议您通过 npm 直接安装并使用 stylelint。有关如何配置 stylelint 以使用 eighteen73 编码标准的更多信息，请参阅 @eighteen73/stylelint-config-wordpress 包的 README。

要将 eighteen73 规则集成到您的项目中，请添加一个 .stylelintrc 文件并扩展这些规则。您还可以添加自己的规则和覆盖以进行进一步的自定义。

{
  "extends": "@eighteen73/stylelint-config-wordpress",
  "rules": {
    ...
  }
}

eighteen73 / wordpress-coding-standards

维护者

详细信息