i18n-yii-extract-webpack-plugin

Fork based on i18n Plugin at 8a51991b5b which was a head of branch feature/webpack_4 at the moment of fork.

The plugin will extract source messages at build time to separate files for future translation.

The plugin uses categorized messages like Yii2 I18N uses:

console.log(i18n.t('category', 'Test message'));
console.log(i18n.t('category/subcategory', 'Hello, {name}', {name: 'Mr. Smith'}));

Install

npm i -D i18n-yii-extract-webpack-plugin

Description

This plugin creates/updates separate JSON files containing all source messages for translation. Each entry produce separate set of JSON files for each requested language. This may duplicate messages in case of multiple entries, so later processing and/or automation is recommended (and is not, and will not a task for this plugin).

Options

plugins: [
  ...
  new I18nYii2ExtractPlugin(optionsObj)
],

where optionsObj is an object with following possible properties:

• functionName: the default value is "i18n.t", you can change it to other function name.

• language: the default value is ["en-US"], which is languages list to generate output.

• hideMessage: the default value is false, which will show the warning/error message. If set to true, the message will be hidden. Currently this option is unused, but reserved.

• inputFileName: the default value is equal to value of outputFileName option. Old translations will be read from this file for each output file. Allowed patterns are the same as in outputFileName.

• outputFileName: the default value is "[name].[language].json", which will control generated file name to save extracted messages. Relative path will resolve from configured output path. Following patterns are allowed:

  • [language]: language name
  • [name]: entry chunk name

  Note that only messages wanted by analyzed entry will be written to output file. This may cause a loss of old translations loaded from inputFileName when messages become unused in corresponding entry.

• outputSpace: the default value is 2. The value will pass as 3rd space argument to JSON.stringify() to control pretty print. You can use null, 0, or "" to disable pretty print. The value undefined will fallback to default value 2.