Aller au contenu principal
Version : Canary 🚧

📦 eslint-plugin

ESLint est un outil qui analyse statiquement votre code et signale les problèmes ou suggère les meilleures pratiques par le biais d'astuces pour l'éditeur et la ligne de commande. Docusaurus fournit un plugin ESLint pour appliquer les meilleures pratiques de Docusaurus.

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

Installation​

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

Configurations prises en charge​

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

  • Recommended : ensemble de règles recommandées pour la plupart des sites Docusaurus qui devraient être étendus.
  • All : toutes les règles sont activées. Cela changera entre les versions mineures, donc vous ne devriez pas l'utiliser si vous voulez éviter des changements de rupture inattendus.

Règles prises en charge​

NomDescription
@docusaurus/no-untranslated-textOblige les libellés de texte en JSX à être enveloppés par des appels de traduction
@docusaurus/string-literal-i18n-messagesForce les API de traduction à être appelées sur les libellés en texte brut✅
@docusaurus/no-html-linksVeille à ce que @docusaurus/Link soit utilisé à la place des balises \<a>✅
@docusaurus/prefer-docusaurus-headingS'assure que @theme/Heading est utilisé à la place des balises \<hn> pour les titres✅

✅ = 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
  },
);

Ceci activera le plugin eslint @docusaurus et utilisera la configuration recommended. See Supported rules above for a list of rules that this will enable.

Configuration manuelle​

Pour un contrôle plus précis, vous pouvez également activer le plugin manuellementet configurer les règles que vous voulez utiliser directement :

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​

Ajouter plugin:@docusaurus/recommended à la section extends de votre fichier de configuration .eslintrc :

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

Ceci activera le plugin eslint @docusaurus et utilisera la configuration recommended. See Supported rules above for a list of rules that this will enable.

Configuration manuelle​

Pour un contrôle plus précis, vous pouvez également activer le plugin manuellementet configurer les règles que vous voulez utiliser directement :

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