@10up/eslint-plugin 中文文档教程

Question

ESLint Plugin

ESLint 插件，包括用于 WordPress 开发的配置和自定义规则。

Installation

安装模块

npm install @wordpress/eslint-plugin --save-dev

注意：此包需要 node 12.0.0 或更高版本，以及 npm 6.9.0 或更高版本。 它与旧版本不兼容。

Usage

要选择默认配置，请扩展您自己项目的 .eslintrc 文件：

{
    "extends": [ "plugin:@wordpress/eslint-plugin/recommended" ]
}

请参阅 有关可共享配置的 ESLint 文档 了解更多信息。

推荐 预设将包括管理 ES2015+ 环境的规则，并包括来自 的规则eslint-plugin-jsx-a11y，eslint-plugin-react 和 eslint-plugin-prettier 项目。 它还包括与 @typescript-eslint/eslint-plugin 的可选集成在项目中安装 typescript 包时激活。

对于想要退出 Prettier 的项目，还有 recommended-with-formatting 规则集。 它启用了本机 ESLint 代码格式化规则。

Rulesets

或者，您可以选择仅加入插件提供的更精细的规则集。 这些包括：

• custom
• es5
• esnext
• jsdoc
• jsx-a11y
• react
• i18n
• test-e2e
• test-unit

例如，如果您的项目不使用 React，您可以考虑使用以下 extends 定义扩展项目中仅包含 ESNext 规则：

{
    "extends": [ "plugin:@wordpress/eslint-plugin/esnext" ]
}

这些规则可以附加使用，因此您可以扩展esnext 和 custom 规则集，但省略了 react 和 jsx-a11y 配置。

粒度规则集不会定义任何环境全局变量。 因此，如果您的项目需要它们，您将需要自己定义它们。

Rules

Rule	Description	Recommended
data-no-store-string-literals	Discourage passing string literals to reference data stores
dependency-group	Enforce dependencies docblocks formatting	✓
is-gutenberg-plugin	Governs the use of the process.env.IS_GUTENBERG_PLUGIN constant	✓
no-base-control-with-label-without-id	Disallow the usage of BaseControl component with a label prop set but omitting the id property	✓
no-unguarded-get-range-at	Disallow the usage of unguarded getRangeAt calls	✓
no-unsafe-wp-apis	Disallow the usage of unsafe APIs from @wordpress/* packages	✓
no-unused-vars-before-return	Disallow assigning variable values if unused before a return	✓
react-no-unsafe-timeout	Disallow unsafe setTimeout in component
valid-sprintf	Enforce valid sprintf usage	✓
i18n-ellipsis	Disallow using three dots in translatable strings	✓
i18n-no-collapsible-whitespace	Disallow collapsible whitespace in translatable strings	✓
i18n-no-placeholders-only	Prevent using only placeholders in translatable strings	✓
i18n-no-variables	Enforce string literals as translation function arguments	✓
i18n-text-domain	Enforce passing valid text domains	✓
i18n-translator-comments	Enforce adding translator comments	✓
i18n-no-flanking-whitespace	Disallow leading or trailing whitespace in translatable strings
i18n-hyphenated-range	Disallow hyphenated numerical ranges in translatable strings

Legacy

如果您正在使用 WordPress 的 .jshintrc JSHint 配置，并且您想迈出迁移到等效的 ESLint 的第一步，也可以定义您自己项目的 .eslintrc文件为：

{
    "extends": [ "plugin:@wordpress/eslint-plugin/jshint" ]
}

Contributing to this package

这是一个独立的包，是古腾堡项目的一部分。 该项目被组织为一个 monorepo。 它由多个独立的软件包组成，每个软件包都有特定的用途。 此 monorepo 中的包发布到 npm 并由 WordPress 以及其他软件项目。

要了解更多关于为这个包或整个古腾堡做贡献的信息，请阅读项目的主要贡献者指南。