📦 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.

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

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. Voir les Règles prises en charge ci-dessous pour une liste de règles que cela va activer.

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 : 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

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	Veille à ce que @docusaurus/Link soit utilisé à la place des balises <a>	✅
@docusaurus/prefer-docusaurus-heading	S'assure que @theme/Heading est utilisé à la place des balises <hn> pour les titres	✅

✅ = recommended

Exemple de configuration

Voici un exemple de configuration :

.eslintrc.js

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