跳到主要内容
版本:Canary 🚧

📦 eslint-plugin

ESLint 是一个静态代码分析工具,会通过编辑器提示和命令行报告问题,推荐最佳做法。 Docusaurus 提供了一个 ESLint 插件来推广 Docusaurus 相关的最佳做法。

安装流程

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

用法

.eslintrc 配置文件的 plugins 列表中添加 @docusaurus

.eslintrc
{
"plugins": ["@docusaurus"]
}

然后,你可以继承某个配置(例如 recommended 配置):

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

每个配置包含了一组规则。 为了更精细地控制配置,你也可以直接配置想使用的规则:

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

支持的配置

  • Recommended: 推荐大多数 Docusaurus 站点使用的规则,建议继承。
  • All:启用所有规则。 这个配置的内容会在次要版本之间发生变化,所以如果你想避免不必要的破坏性变更,就不应使用这个配置。

支持的规则

参数描述
@docusaurus/no-untranslated-text确保 JSX 中的所有文本标签都被翻译 API 包裹。
@docusaurus/string-literal-i18n-message确保翻译 API 只用于纯文本标签。

✅ = recommended

示例配置

这是一个示例配置:

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