Skip to main content
Version: 2.0.1

📦 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 provides an ESLint plugin to enforce best Docusaurus practices.

Installation​

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

Usage​

Add @docusaurus to the plugins section of your .eslintrc configuration file:

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

Then, you can extend one of the configs (e.g. the recommended config):

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

Each config contains a set of rules. For more fine-grained control, you can also configure the rules you want to use directly:

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

Supported Configs​

  • Recommended: recommended rule set for most Docusaurus sites that should be extended from.
  • All: all rules enabled. This will change between minor versions, so you should not use this if you want to avoid unexpected breaking changes.

Supported Rules​

NameDescription
@docusaurus/no-untranslated-textEnforce text labels in JSX to be wrapped by translate calls
@docusaurus/string-literal-i18n-messagesEnforce translate APIs to be called on plain text labels✅

✅ = recommended

Example configuration​

Here's an example configuration:

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