メインコンテンツへスキップ
バージョン: 3.5.2

📦 eslint-plugin

ESLint は、コードを静的に分析し、エディターのヒントやコマンドラインを通じて問題点を報告したり、ベストプラクティスを提案したりするツールです。Docusaurus は、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"
  }
}

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

  • 推奨: ほとんどの Docusaurus サイトで拡張すべき推奨ルールセット。
  • すべて: すべて のルールが有効になります。これはマイナーバージョン間で変更される可能性があるため、予期しない破壊的変更を避けたい場合は使用しないでください。

サポートされているルール​

名前説明
@docusaurus/no-untranslated-textJSX のテキストラベルを翻訳呼び出しでラップすることを強制します
@docusaurus/string-literal-i18n-messagesプレーンテキストラベルで translate API が呼び出されることを強制します✅
@docusaurus/no-html-links<a> タグの代わりに @docusaurus/Link が使用されるようにします✅
@docusaurus/prefer-docusaurus-heading見出しに <hn> タグの代わりに @theme/Heading が使用されるようにします✅

✅ = 推奨

設定例​

設定例を以下に示します。

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