Aller au contenu principal
Version : 2.1.0

📩 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 install --save-dev @docusaurus/eslint-plugin

Utilisation​

Ajoutez @docusaurus à la section plugins de votre fichier de configuration .eslintrc :

.eslintrc
{
"plugins": ["@docusaurus"]
}

Ensuite, vous pouvez étendre une des configurations (par exemple la configuration recommended) :

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

Chaque configuration contient un ensemble de rÚgles. Pour un contrÎle plus précis, vous pouvez également configurer les rÚgles que vous voulez utiliser directement :

.eslintrc
{
"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​

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✅

✅ = recommended

Exemple de configuration​

Voici un exemple de configuration :

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