📦 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
配置文件的 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: 推荐大多数 Docusaurus 站点使用的规则,建议继承。
- All:启用所有规则。 这个配置的内容会在次要版本之间发生变化,所以如果你想避免不必要的破坏性变更,就不应使用这个配置。
支持的规则
参数 | 描述 | |
---|---|---|
@docusaurus/no-untranslated-text | 确保 JSX 中的所有文本标签都被翻译 API 包裹。 | |
@docusaurus/string-literal-i18n-message | 确保翻译 API 只用于纯文本标签。 | ✅ |
@docusaurus/no-html-links | 确保使用 @docusaurus/Link 而不是 <a> 标签 | ✅ |
@docusaurus/prefer-docusaurus-heading | 确保使用 @theme/Heading 而不是 <hn> 标签来处理标题 | ✅ |
✅ = recommended
示例配置
这是一个示例配置:
.eslintrc.js
module.exports = {
extends: ['plugin:@docusaurus/recommended'],
rules: {
'@docusaurus/no-untranslated-text': [
'warn',
{ignoredStrings: ['·', '—', '×']},
],
},
};