eslint-plugin-i18n-checker

Check i18n keys existence

Installation

You"ll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-i18n-checker:

npm install eslint-plugin-i18n-checker --save-dev

Usage

Add i18n-checker to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "i18n-checker"
    ]
}

Then configure the rules you want to use under the rules section.

{
    "rules": {
      "i18n-checker/json-key-exists": [
        2,
        {
          "functionNames": [
            "i18n.t",
            "t"
          ],
          "localesPath": "public/locales",
          "specifics": [
            {
              "matcher": "^global:(.*)$",
              "to": "global.json"
            },
            {
              "matcher": "^(.*)$",
              "to": "app.json"
            }
          ]
        }
      ],
      "i18n-checker/key-must-be-literal": [
        1,
        {
          "functionNames": ["i18n.t", "t"]
        }
      ],
      "i18n-checker/no-literal-in-jsx": [
        1,
        {
          "allowList": ["-"]
        }
      ]
    }
}

Supported Rules

• json-key-exists
• key-must-be-literal
• no-literal-in-jsx