Skip to main content

ESLint Plugin

Lingui provides an ESLint plugin to help you find common Lingui usage errors in your code.

npm-version npm-downloads

Installation​

Install ESLint:

npm install --save-dev eslint

Next, install eslint-plugin-lingui:

npm install --save-dev eslint-plugin-lingui
info

If you have installed ESLint globally (using the -g flag), you must also install eslint-plugin-lingui globally.

Usage​

Flat Config (eslint.config.js)​

Version 8 of ESLint introduced a new configuration format called Flat Config. Flat config files represent plugins and parsers as JavaScript objects.

To enable all the recommended rules for the plugin, add the following config:

import pluginLingui from "eslint-plugin-lingui";

export default [
  pluginLingui.configs["flat/recommended"],
  // Any other config...
];

Custom Setup​

Alternatively, you can load the plugin and configure only the rules you want to use:

import pluginLingui from "eslint-plugin-lingui";

export default [
  {
    plugins: {
      lingui: pluginLingui,
    },
    rules: {
      "lingui/t-call-in-function": "error",
    },
  },
  // Any other config...
];

Legacy Config (.eslintrc)​

The legacy configuration format has been deprecated by ESLint, but it's still supported. If you're using the legacy format, you can use the following configuration.

To enable all the recommended rules for the plugin, add plugin:lingui/recommended to the extends section:

{
  "extends": ["plugin:lingui/recommended"]
}

Custom Setup​

Alternatively, add lingui to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["lingui"]
}

In the rules section, configure the rules you want to use:

{
  "rules": {
    "lingui/no-unlocalized-strings": 2,
    "lingui/t-call-in-function": 2,
    "lingui/no-single-variables-to-translate": 2,
    "lingui/no-expression-in-message": 2,
    "lingui/no-single-tag-to-translate": 2,
    "lingui/no-trans-inside-trans": 2
  }
}
tip

See the official repository for more information about the rules.