Skip to content

transferwise/webpack-translations-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🌐 Webpack Translations Plugin

npm GitHub release CircleCI npm

This is a Webpack plugin that creates bundles for each of the existing translations files automatically, with reasonable defaults. #0CJS

Using it enables only serving the translations the user needs, therefore increasing performance.

Usage

Installation

npm install --save-dev webpack-translations-plugin

Webpack config

import WebpackTranslationsPlugin from 'webpack-translations-plugin';

export default {
  ...,
  plugins: [..., new WebpackTranslationsPlugin()]
};

WebpackTranslationsPlugin takes an optional options object for configuration:

Option Description Default
directory containing translation JSONs translations
fileNameBase for translation JSONs (source file name without the extension) messages
moduleName will resolve as the translations object translations
development if true, will double escape the strings to work with webpack-dev-server false

Source files

import translations from 'translations';

const languages = Object.keys(translations);

if (languages.length === 1) {
  // we only have one translation object
  const language = languages[0];
  console.log(translations[language]['a.translation.key']);
} else {
  // we have all translations objects, so f.e. we can do:
  console.log(translations['en-US']['a.translation.key']);
}

File tree example

With translation files

.
β”œβ”€β”€ node_modules
β”œβ”€β”€ translations
β”‚   β”œβ”€β”€ messages.json
β”‚   β”œβ”€β”€ messages.en.json
β”‚   β”œβ”€β”€ messages.en-US.json
β”‚   └── messages.it.json
β”œβ”€β”€ package.json
└── webpack.config.js
  • options.directory is 'translations'
  • options.fileNameBase is 'messages'
  • options.moduleName is 'translations'

As these are all defaults, no options object needs to be passed.

This will produce the following:

.
β”œβ”€β”€ dist
β”‚   β”œβ”€β”€ main.js
β”‚   β”œβ”€β”€ main.en.js
β”‚   β”œβ”€β”€ main.en-US.js
β”‚   └── main.it.js
β”œβ”€β”€ node_modules
β”œβ”€β”€ translations
β”‚   β”œβ”€β”€ messages.json
β”‚   β”œβ”€β”€ messages.en.json
β”‚   β”œβ”€β”€ messages.en-US.json
β”‚   β”œβ”€β”€ messages.it.json
β”œβ”€β”€ package.json
└── webpack.config.js

where main.js contain all the translations, so 'translations' resolves as:

{
  "en": {
    ...
  },
  "en-US": {
    ...
  },
  "it": {
    ...
  }
}

and main.en.js, main.en-US.js and main.it.js contain only the specific translations, so for en-US 'translations' resolves as:

{
  "en-US": {
    ...
  }
}

With only the source file

.
β”œβ”€β”€ node_modules
β”œβ”€β”€ translations
β”‚   └── messages.json
β”œβ”€β”€ package.json
└── webpack.config.js

No options object needs to be passed, as we're using the default values. The following will be built:

.
β”œβ”€β”€ dist
β”‚   └── main.js
β”œβ”€β”€ node_modules
β”œβ”€β”€ translations
β”‚   └── messages.json
β”œβ”€β”€ package.json
└── webpack.config.js

where main.js contain the source translations, under the "source" key:

{
  "source": {
    ...
  }
}

Contributing

  1. Run tests with npm run jest. npm test will check for package and changelog version match, ESLint and Prettier format in addition.
  2. Develop.
  3. Bump version number in package.json according to semver and add an item that a release will be based on to CHANGELOG.md.
  4. Submit your pull request from a feature branch and get code reviewed.
  5. If the pull request is approved and the CircleCI build passes, you will be able to squash and merge.
  6. Code will automatically be released to GitHub and published to npm according to the version specified in the changelog and package.json.

Other

For features and bugs, feel free to add issues or contribute.