eslint-plugin-i18n icon indicating copy to clipboard operation
eslint-plugin-i18n copied to clipboard

ESLint rules to find out the texts and messages not internationalized in the project.

NPM License NPM Version NPM Downloads Ubuntu CI Status Windows CI Status Coverage Status

eslint-plugin-i18n

ESLint rules for internationalization.

Installation

Install ESLint as a dev-dependency:

$ npm install --save-dev eslint

Install eslint-plugin-i18n as a dev-dependency:

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

Configuration

Add plugins section to your .eslintrc and specify eslint-plugin-i18n as a plugin:

{
  "plugins": [
    "i18n"
  ]
}

Finally, enable the rules that you would like to use.

{
  "rules": {
    "i18n/no-chinese-character": 1,
    "i18n/no-greek-character": 1,
    "i18n/no-japanese-character": 1,
    "i18n/no-korean-character": 1,
    "i18n/no-russian-character": 1,
    "i18n/no-thai-character": 1
  }
}

List of supported rules

  • no-chinese-character: Prevent usage of Chinese characters.
  • no-greek-character: Prevent usage of Greek characters.
  • no-japanese-character: Prevent usage of Japanese characters.
  • no-korean-character: Prevent usage of Korean characters.
  • no-russian-character: Prevent usage of Russian characters.
  • no-thai-character: Prevent usage of Thai characters.

License

eslint-plugin-i18n is licensed under the MIT License.

Changelog

v2.4.0 - October 29, 2024

Features

  • Added excludeModuleImports option to exclude imports from linting.
  • Updated the excludeArgsForFunctions option.

Chore

  • Upgreded devDependencies.
  • Applied auto-publish.

v2.3.1 - April 10, 2024

  • Extended the ability of excludeArgsForFunctions option.

v2.3.0 - January 26, 2024

  • Added rule options to exclude some function arguments from linting.

v2.2.0 - January 16, 2024

  • Added rule options to support comments linting.

v2.1.0 - June 17, 2021

  • Added rule options to support identifier linting.
  • Dropped the support of node < 12 for development environment (due to lint-staged and mocha)

v2.0.0 - July 4, 2020

  • Dropped support for node < 10
  • Added JSX support