https://github.com/rbeer/i18next-versioning-webpack-plugin
Automatic version bumping for i18next and its XHRBackend plugin
https://github.com/rbeer/i18next-versioning-webpack-plugin
Last synced: 3 months ago
JSON representation
Automatic version bumping for i18next and its XHRBackend plugin
- Host: GitHub
- URL: https://github.com/rbeer/i18next-versioning-webpack-plugin
- Owner: rbeer
- License: mit
- Created: 2019-10-15T12:27:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-02T21:12:03.000Z (over 1 year ago)
- Last Synced: 2025-01-26T18:33:57.996Z (4 months ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# i18next-versioning-webpack-plugin
("i18next-versioning")
This [webpack](https://https://webpack.js.org) plugin detects changes in your i18n files and increments the language's version for the [i18next-localstorage-backend](https://github.com/i18next/i18next-localstorage-backend).
The localstorage backend of [i18next](https://www.i18next.com/) takes an option `versions` to determine whether the language definitions have been updated and should be pulled from the backend.
NOTE: i18next-versioning does not care whether you've undone changes. It will always increment the version number of changed languages.
## Install
`npm i git+https://github.com/shadowban-eu/i18next-versioning-webpack-plugin.git`
## Use
Assuming an i18next setup using a combination of localstorage- and XHR-backend:
```js
{
fallbackLng: 'en-US',
ns: ['common', 'buttons'],
defaultNS: 'common',
backend: {
backends: [LocalStorageBackend, XHRBackend],
backendOptions: [
{
// LocalStorageBackend options
versions: i18nVersions
},
{
// XHRBackend options
loadPath: '/i18n/{{lng}}/{{ns}}.json',
crossDomain: false
}
]
}
}
```
and a language source folder structure of `/i18n/{{lng}}/{{ns}}.json`:
```
i18n/ <-- `langsRoot` in config
├── de
│ ├── common.json
│ └── buttons.json
├── en-US
│ ├── common.json
│ └── buttons.json
└── es
├── common.json
└── buttons.json
```
`versions: i18nVersions` would be an object, containing:
```js
{
'en-US': '1',
'de': '1',
'es': '1'
}
```
Instead of changing the version strings by hand whenever you change one of the files,
i18next-versioning hashes each `{{lng}}` directory and compares that hash with the one from the last build.
To use i18next-versioning, simply add it to your `webpack.config.js`:
```js
const { DefinePlugin } = require('webpack'); // required!
const I18nextVersioningPlugin = require('i18next-versioning-webpack-plugin');
module.exports = {
mode: process.env.NODE_ENV,
entry: { ... },
output: { ... },
infrastructureLogging: {
level: 'info' // i18next-versioning logs to the 'info' level
},
plugins: [
new I18nextVersioningPlugin({
langsRoot: './src/i18n',
hashFileName: './i18nVersionHashes.json'
}),
new DefinePlugin({
// i18nVersions - added by i18next-versioning
})
]
```
i18next-versioning taps into webpack's `beforeRun` hook, does its thing and
adds the versions object with the name `i18nVersions` to the DefinePlugin definitions,
to make it available to whereever your init({...}) i18next.
## Production vs. Development
i18next-versioning uses `Date.now()` as version string for *all* languages, when `mode !== 'production'` to reflect all changes without actually incrementing your versions (also stored in and read from `hashFileName`). In fact, it does not write to the hash file at all.
Creating a production build with a presumably "smaller" version (timestamps are 13 digits) works, since i18next-localstorage-backend also does not care about the direction your version strings change. It just pulls an update of the definitions whenever their version string has changed. You could even call your versions 'Mike', 'Joe', and 'Diane' and it still worked. ;D
## Options
| Name | Default | |
|:------------:|:----------------------:|--------------------------------------------------------------------------------------------------------------------|
| langsRoot | - | Root folder of translations. Expects one folder per language as children. |
| hashFileName | i18nVersionHashes.json | Filename where hashes should be stored. Commit this file! |