To help you get started, we've collected the most common ways that i18next-scanner is being used within popular public projects.

LiskHQ / lisk-desktop / src / i18n-scanner.js View on Github

function i18nScanner(params) { // eslint-disable-line
  const parser = new Parser({
    keySeparator: '>',
    nsSeparator: '|',
  });

  const sourceJSON = fs.readFileSync(params.outputFilePath, 'utf8');
  let translationsSource;
  try {
    translationsSource = JSON.parse(sourceJSON);
  } catch (e) {
    process.stderr.write(`i18nScanner: ${e}\n`);
    return;
  }

  const customHandler = function (key, options) {
    const value = translationsSource[key] || key;
    if (options.context) {

View more ways to use i18next-scanner

i18next-scanner

Scan your code, extract translation keys/values, and merge them into i18n resource files.

Turns your code

i18n._('Loading...');
i18n._('Backslashes in single quote: \' \\ \'');
i18n._('This is \
a multiline \
string');

i18n.t('car', { context: 'blue', count: 1 }); // output: 'One blue car'
i18n.t('car', { context: 'blue', count: 2 }); // output: '2 blue cars'

Default text

into resource files

{
  "Loading...": "Wird geladen...", // uses existing translation
  "Backslashes in single quote: ' \\ '": "__NOT_TRANSLATED__", // returns a custom string
  "This is a multiline string": "this is a multiline string", // returns the key as the default value
  "car": "car",
  "car_blue": "One blue car",
  "car_blue_plural": "{{count}} blue cars",
  "some": {
    "key": "Default text"
  }
}

Notice

There is a major breaking change since v1.0, and the API interface and options are not compatible with v0.x.

Checkout Migration Guide while upgrading from earlier versions.

Features

• Fully compatible with i18next - a full-featured i18n javascript library for translating your webapplication.
• Support react-i18next for parsing the Trans component
• Support Key Based Fallback to write your code without the need to maintain i18n keys. This feature is available since i18next@^2.1.0
• A standalone parser API
• A transform stream that works with both Gulp and Grunt task runner.
• Support custom transform and flush functions.

Installation

npm install --save-dev i18next-scanner

or

npm install -g i18next-scanner

Usage

CLI Usage

$ i18next-scanner

  Usage: i18next-scanner [options] 


  Options:

    -V, --version      output the version number
    --config   Path to the config file (default: i18next-scanner.config.js)
    --output