📦 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 fournit un plugin ESLint pour appliquer les meilleures pratiques de Docusaurus.

Installation

npm

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

Yarn

yarn add --dev @docusaurus/eslint-plugin

pnpm

pnpm add --save-dev @docusaurus/eslint-plugin

Utilisation

Configuration recommandée

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 below 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"
  }
}

Configurations prises en charge

• Recommended : ensemble de règles recommandées pour la plupart des sites Docusaurus qui devraient être étendus.
• All: all rules enabled. 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

Nom	Description
@docusaurus/no-untranslated-text	Oblige les libellés de texte en JSX à être enveloppés par des appels de traduction
@docusaurus/string-literal-i18n-messages	Force les API de traduction à être appelées sur les libellés en texte brut	✅
@docusaurus/no-html-links	Ensures @docusaurus/Link is used instead of <a> tags	✅
@docusaurus/prefer-docusaurus-heading	Ensures @theme/Heading is used instead of <hn> tags for headings	✅

✅ = recommended

Exemple de configuration

Voici un exemple de configuration :

.eslintrc.js

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