eslint-plugin-i18next
ESLint plugin for i18n
Installation
$ npm install eslint-plugin-i18next --save-dev
Usage
Add i18next
to the plugins section of your .eslintrc
configuration file.
{
"plugins": ["i18next"]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"i18next/no-literal-string": 2
}
}
or
{
"extends": ["plugin:i18next/recommended"]
}
Rule no-literal-string
This rule aims to avoid developers to display literal string to users
in those projects which need to support multi-language.
The --fix
option on the command line can automatically fix some of the problems reported by this rule.
Literay strings that are not constant string (all characters are UPPERCASE
) are typically mistakes. For example:
const foo = 'foo';
They are frowned upon in favor of internationalization:
const foo = i18next.t('foo');
Rule Details
It will find out all literal strings and validate them.
Examples of incorrect code for this rule:
const a = 'foo';
Examples of correct code for this rule:
var FOO = 'foo';
var a = {
BAR: 'bar',
[FOO]: 'foo'
};
var foo = 'FOO';
i18n
This rule allows to call i18next translate function.
Correct code:
var bar = i18next.t('bar');
var bar2 = i18n.t('bar');
Maybe you use other internationalization libraries
not i18next. You can use like this:
const bar = yourI18n('bar');
const bar = yourI18n.method('bar');
Redux/Vuex
This rule also works with those state managers like
Redux and Vuex.
Correct code:
var bar = store.dispatch('bar');
var bar2 = store.commit('bar');
Options
ignore
The ignore
option specifies exceptions not to check for
literal strings that match one of regexp paterns.
Examples of correct code for the { "ignore": ['foo'] }
option:
const a = 'afoo';
ignoreCallee
THe ignoreCallee
option speficies exceptions not check for
function calls whose names match one of regexp patterns.
Examples of correct code for the { "ignoreCallee": ["foo"] }
option:
const bar = foo('bar');