Skip to main content

📦 eslint-plugin

ESLint は、コードを静的解析して問題を報告したり、エディタのヒント機能やコマンドラインを通じてベストプラクティスを提案したりするツールです。 Docusaurusは、それにおける最善の慣例を遵守させるためのESLintプラグインを用意しています。

インストール​

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

使い方​

推奨設定​

.eslintrc設定ファイル内のextends節に、plugin:@docusaurus/recommendedを追加してください。

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

This will enable the @docusaurus eslint plugin and use the recommended config. See Supported rules below 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"
  }
}

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

  • 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-links<a>タグの代わりに @docusaurus/Link が使用されるようにします✅
@docusaurus/prefer-docusaurus-heading見出しに<hn>タグの代わりに @theme/Heading が使用されるようにします✅

✅ = recommended

Example configuration​

Here's an example configuration:

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