eslint-plugin-no-cyrillic-string/README.md

Disable cyrillic text in string literals

# Disable cyrillic string literals (no-cyrillic-string)

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

## Installation

```sh
$ npm install eslint eslint-plugin-no-cyrillic-string --save-dev
```

## Usage

Create an `.eslint.json` file with the following:

```json
  "plugins": [
      "eslint-plugin-no-cyrillic-string"
  ]
```

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

```json
  "rules": {
      "no-cyrillic-string/no-cyrillic-string": "error"
  }
```

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

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

and run the linter with:

```sh
$ npm run lint
```

## Rule Details

This rule aims to...

Examples of **incorrect** code for this rule:

```js

// 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:

```js

// 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.