Skip to main content

📦 eslint-plugin

ESLint is a tool that statically analyzes your code and reports problems or suggests best practices through editor hints and command line. Docusaurusは、それにおける最善の慣例を遵守させるためのESLintプラグインを用意しています。

This ESLint plugin supports ESLint >= 8.57.0, flat configs and legacy configs.

インストール​

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

サポートされている設定​

Both built-in configs exist in flat and legacy variants:

  • Recommended: recommended rule set for most Docusaurus sites that should be extended from.
  • All: all rules enabled. This will change between minor versions, so you should not use this if you want to avoid unexpected breaking changes.

サポートされている規則​

名前説明
@docusaurus/no-untranslated-textJSX内のすべてのテキストラベルが翻訳API呼び出しで必ず囲まれるようにします
@docusaurus/string-literal-i18n-messages翻訳APIがプレーンテキストラベルに対して必ず呼ばれるようにします✅
@docusaurus/no-html-linksEnsures @docusaurus/Link is used instead of \<a> tags✅
@docusaurus/prefer-docusaurus-headingEnsures @theme/Heading is used instead of \<hn> tags for headings✅

✅ = recommended

Usage - Flat​

Import @docusaurus/eslint-plugin and add docusaurus.configs.flat.recommended to your flat config array:

eslint.config.js
import {defineConfig} from 'eslint/config';
import docusaurus from '@docusaurus/eslint-plugin';

export default defineConfig(
  docusaurus.configs.flat.recommended,
  {
    // Other config
  },
);

This will enable the @docusaurus eslint plugin and use the recommended config. See Supported rules above for a list of rules that this will enable.

手動設定​

For more fine-grained control, you can also enable the plugin manually and configure the rules you want to use directly:

eslint.config.js
import {defineConfig} from 'eslint/config';
import docusaurus from '@docusaurus/eslint-plugin';

export default defineConfig({
  plugins: {docusaurus},
  rules: {
    '@docusaurus/string-literal-i18n-messages': 'error',
    '@docusaurus/no-untranslated-text': 'warn',
  },
});

Usage - Legacy​

Add plugin:@docusaurus/recommended to the extends section of your .eslintrc configuration file:

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

This will enable the @docusaurus eslint plugin and use the recommended config. See Supported rules above for a list of rules that this will enable.

手動設定​

For more fine-grained control, you can also enable the plugin manually and configure the rules you want to use directly:

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