Repository Relocation Notice

This repository has been relocated to the deriv-com organization. Please access it at the following URL: eslint-plugin-localize-usage

Thank you!

---

@deriv/eslint-plugin-localize-usage

Eslint rules for enforcing the correct usage of localize function and Localize component in the app

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install @deriv/eslint-plugin-localize-usage:

$ npm install @deriv/eslint-plugin-localize-usage --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install @deriv/eslint-plugin-localize-usage globally.

Usage

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

{
  "plugins": ["@deriv/localize-usage"]
}

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

{
  "rules": {
    "localize-usage/rule-name": "error"
  }
}

You can also use the recommended config instead

{
  "extends": ["plugin:localize-usage/recommended"]
}

Supported Rules

• localize-usage/only-string-literal-argument: Enforce using static strings as keys for localize functions which we use for translation
• localize-usage/no-invalid-identifier-in-prop-value: Validate string literal passed to Localize component in i18n_default_text prop is valid and has all the identifiers in values prop