版本: 3.5.2

📦 eslint-plugin

ESLint 是一款静态分析代码的工具，通过编辑器提示和命令行报告问题或建议最佳实践。Docusaurus 提供一个 ESLint 插件来强制执行最佳 Docusaurus 实践。

安装

npm
Yarn
pnpm

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

yarn add --dev @docusaurus/eslint-plugin

pnpm add --save-dev @docusaurus/eslint-plugin

使用

手动配置

为了更精细的控制，你也可以手动启用插件并直接配置要使用的规则

.eslintrc
{
  "plugins": ["@docusaurus"],
  "rules": {
    "@docusaurus/string-literal-i18n-messages": "error",
    "@docusaurus/no-untranslated-text": "warn"
  }
}

支持的配置

推荐：大多数 Docusaurus 网站应从中扩展的推荐规则集。
全部：启用所有规则。这将在次要版本之间发生变化，因此如果你想要避免意外的破坏性更改，你不应该使用它。

支持的规则

名称	描述
`@docusaurus/no-untranslated-text`	强制 JSX 中的文本标签用 translate 调用包装
`@docusaurus/string-literal-i18n-messages`	强制 translate API 在纯文本标签上调用	✅
`@docusaurus/no-html-links`	确保使用 @docusaurus/Link 而不是 `<a>` 标签	✅
`@docusaurus/prefer-docusaurus-heading`	确保使用 @theme/Heading 而不是 `<hn>` 标签作为标题	✅

✅ = 推荐

示例配置

这是一个示例配置

.eslintrc.js
module.exports = {
  extends: ['plugin:@docusaurus/recommended'],
  rules: {
    '@docusaurus/no-untranslated-text': [
      'warn',
      {ignoredStrings: ['·', '—', '×']},
    ],
  },
};

安装​

使用​

推荐配置​

手动配置​

支持的配置​

支持的规则​

示例配置​

安装

使用

推荐配置

手动配置

支持的配置

支持的规则

示例配置