`
// import library
import { validator } from '@adguard/translate'
`

#### isTranslationValid

`
const baseMessage = 'test string has node';
const targetMessage = 'тестовая строка с нодой';

validator.isTranslationValid(baseMessage, targetMessage); // true
`

#### isPluralFormValid

`
validator.isPluralFormValid(%count% серверов | %count% сервер | %count% сервера | %count% серверов, 'ru', "servers_count"); // true, all 4 plural forms are provided

validator.isPluralFormValid(%count% сервера | %count% серверов, 'ru', "servers_count"); // false, ru locale awaits for 4 plural forms provided
`

$3

#### createTranslator

`
/**
* Creates translator instance strings, by default for simple strings
* @param i18n - function which returns translated message by key
* @param messageConstructor - function that will collect messages
* @param values - map with default values for tag converters
*/
const createTranslator = (
i18n: I18nInterface,
messageConstructor?: MessageConstructorInterface,
values?: ValuesAny
): Translator
`

#### createReactTranslator

`
/**
* Creates translation function for strings used in the React components
* We do not import React directly, because translator module can be used
* in the modules without React too
*
*
* @param i18n - object with methods which get translated message by key and return current locale
* @param React - instance of react library
*/
const createReactTranslator = (i18n: I18nInterface, React: ReactCustom): Translator
`

#### getMessage
`
/**
* Retrieves message and translates it, substituting parameters where necessary
* @param key - translation message key
* @param params - values used to substitute placeholders and tags
*/
public getMessage(key: string, params: ValuesAny = {}): T {
`

#### getPlural
`
/**
* Retrieves correct plural form and translates it
* @param key - translation message key
* @param number - plural form number
* @param params - values used to substitute placeholders or tags if necessary,
* if params has "count" property it will be overridden by number (plural form number)
*/
public getPlural(key: string, number: number, params: ValuesAny = {}): T {
`

#### isTranslationValid

`js
/**
* Validates translation against base string by AST (abstract syntax tree) structure.
*
* @param baseMessage Base message.
* @param translatedMessage Translated message.
* @param locale Locale of translatedMessage.
*
* @returns True if translated message is valid, false otherwise:
* - if base message has no plural forms, it will return true if AST structures are same;
* - if base message has plural forms, first of all
* the function checks if the number of plural forms is correct for the locale,
* and then it validates AST plural forms structures for base and translated messages.
*
* @throws Error for invalid tags in base or translated messages,
* or if translated message has invalid plural forms.
*/
const isTranslationValid = (baseMessage: string, translatedMessage: string, locale: Locale): boolean
`

#### isPluralFormValid

`js
/**
* Checks if plural forms are valid.
*
* @param targetStr Translated message with plural forms.
* @param locale Locale.
* @param key Optional, message key, used for clearer log message.
*
* @returns True if plural forms are valid, false otherwise.
*/
const isPluralFormValid = (targetStr: string, locale: Locale, key: string): boolean
`

Development

Use yarn to build the library

$3

To build the library run:

`
yarn build
`

Build result would be in the dist directory

$3

To check lint errors run in terminal:

`
yarn lint
`

$3

The library uses jest for running unit-tests. To launch the tests, run the following command in the terminal:

`
yarn test
`

$3

To build documentation, run the following command in the terminal:

`
yarn docs
``

$3

- [ ] Create Vue plugin
- [ ] Add utility to check if code contains unused or redundant translation messages

$3

MIT