跳到主要内容

📦 Eslint 插件

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

安装​

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

使用​

推荐配置​

在您的 .eslintrc 配置文件的 extends 部分添加 plugin:@docusaurus/recommended：

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

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

手动配置​

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

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

支持的配置​

  • 推荐：适用于大多数 Docusaurus 站点的推荐规则集，应该被继承。
  • 全部：所有规则已启用。这在不同的次要版本之间可能会发生变化，因此如果您想避免意外的重大更改，不应使用此配置。

支持的规则​

名称描述
@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: ['·', '—', '×']},
    ],
  },
};