跳到主要内容
版本：3.8.1

📦 eslint-plugin

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

安装​

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

用法​

将 plugin:@docusaurus/recommended 添加到您的 .eslintrc 配置文件中的 extends 部分

.eslintrc
{
  "extends": ["plugin:@docusaurus/recommended"]
}

这将启用 @docusaurus eslint 插件并使用 recommended 配置。请参阅下面的支持的规则以获取将启用的规则列表。

手动配置​

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

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

支持的配置​

  • Recommended：大多数 Docusaurus 站点推荐的规则集，应从中扩展。
  • All：启用所有规则。这会在次要版本之间发生变化，因此如果您想避免意外的破坏性更改，则不应使用此配置。

支持的规则​

名称描述
@docusaurus/no-untranslated-text强制 JSX 中的文本标签被翻译调用包裹
@docusaurus/string-literal-i18n-messages强制翻译 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: ['·', '—', '×']},
    ],
  },
};