跳到主要内容

📦 eslint-plugin

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

安装​

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"
  }
}

支持的配置​

  • Recommended：大多数道格龙站点推荐继承的规则集。
  • 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: ['·', '—', '×']},
    ],
  },
};