grunt-static-i18next

Static Internationalization

Grunt plugin to translate static assets, using i18next translator.

Say you have:

app/
├── Gruntfile.js
└── app
    ├── locale
    │   ├── en
    │   │  └── ns.common.json
    │   │  └── ns.special.json
    │   └── en-US
    │       └── ns.common.json
    │       └── ns.special.json
    └── static
        └── data.json
        └── template.html

Static internationalization would like like:

app/
├── Gruntfile.js
└── app
    ├── i18next_static
    │   ├── en
    │   │   └── data.json
    │   │   └── template.html
    │   ├── en-US
    │       └── data.json
    │       └── template.html
    ├── locale
    │   ├── en
    │   │  └── ns.common.json
    │   │  └── ns.special.json
    │   └── en-US
    │       └── ns.common.json
    │       └── ns.special.json
    └── static
        └── data.json
        └── template.html

Getting Started

This plugin requires Grunt.

Translation done with i18next translator. See i18next project (client lib). Text replacement is done with lodash template.

The "static_i18next" task

Overview

Default configuration:

grunt.initConfig({
    static_i18next: {
        options: {
          localeDir: '<%= yeoman.app %>/locale'
        },
        translateApp: {
          options: {},
          files: [{
            expand: true,
            cwd: '<%= yeoman.app %>/static',
            src: '**/*.*',
            dest: '.tmp/i18next'
          }]
        }
    }
})

Options

options.localeDir

Type: String Default value: locale

Locale Directory should contain json files, each json file should be in lang folder (for example en, en-US). lang folder could contain subfolder with json files in it, subfolder name will be assumed as name of locale namespace, see i18next docs.

options.lang

Type: String or String[]

Language to translate assets. By default, files will be translated to languages, defined in locale dir.

options.langInFilename

Type: String or boolean Default value: false

If you don't want to place translated files in lang folders, but expect it to be placed in filename, set langInFilename to true or specify as delimiter string (default is .).

options.singleLang

Type: boolean Default value: false

If one Language used, and you dont want to add it's name into path or name of translated files.

options.splitNamespace

Type: boolean Default value: false

Set to true, if translated files should be generated per each Namespace. Additionally set options.i18next.ns.defaultNs to set fallback namespace options.i18next: { ns: { defaultNs: 'ns.common' } }

options.nsInFilename

Type: String or boolean Default value: false *Ignored if options.splitNamespace is not set as true

If you don't want to place translated files in Namespace folders, but expect it to be placed in filename, set nsInFilename to true or specify as delimiter string (default is .).

Tests

Run grunt test

Release History

• 0.0.2 - basic task
• 0.0.1 - initial release

License

Copyright (c) 2014 Stas Yermakov. Licensed under the MIT license.