1.0.7 • Published 5 months ago

eslint-plugin-no-cyrillic-symbols v1.0.7

Weekly downloads
-
License
ISC
Repository
github
Last release
5 months ago

Disable cyrillic string literals (no-cyrillic-symbols)

If you develop multi language system, you constantly forget using lang dictionaries.
For stop it, use it rule for detect hardcoded cyrillic text

Installation

$ npm install eslint eslint-plugin-no-cyrillic-symbols --save-dev

Usage

Create an .eslint.json file with the following:

  "plugins": [
      "eslint-plugin-no-cyrillic-symbols"
  ]

Then, you can add the custom rules to the .eslint.json file:

  "rules": {
      "no-cyrillic-symbols/no-cyrillic-symbols": "error"
  }
  "rules": {
    "no-cyrillic-symbols/no-cyrillic-symbols": [
      "error",
      {
        "comments": true,
        "allow": ["NOTE", "\"[\\w\\W]+\""]
      }
    ]
  }

To lint your project with ESLint, add the following script to your package.json:

{
  "scripts": {
    "lint": "eslint ."
  }
}

and run the linter with:

$ npm run lint

Rule Details

This rule aims to...

Examples of incorrect code for this rule:

// cyrillic text inside double quotes
let buttonText = "Кнопка";

// cyrillic text inside single quotes
let someLabel = 'Кнопка';

// cyrillic text inside backtick
let someTemplate = `По заказу ${ orderNumber } выставлен счет`;

Examples of correct code for this rule:

// Using dictionary
let buttonText = dictionary.buttonText;
let someLabel = dictionary.label;

// cyrillic text inside backtick
let someTemplate = dictionary.template({
    orderNumber: "#123"
});

// cyrillic text inside comments
// комментарий

When Not To Use It

Inside dictionaries.js you need ignore it rule.

1.0.7

5 months ago

1.0.6

5 months ago