requirejs-i18njs

> A RequireJS plugin to pre-compile I18NJS' translations



----

Overview

This plugins lets you pre-compile the templates in your translation files.

You won't have any unsafe eval in your production code and will gain some execution time too.

----

Install

Either

``node
npm install requirejs-i18njs --save
`
or

`node
bower install requirejs-i18njs --save
`

----

Test

`node
npm test
`

----

Usage

$3

To use with RequireJS and I18NJS.

You'll have to configure a new package in your RequireJS' config.

`javascript
({
packages: [
{
'name': 'i18n',
// The location where the package is installed
'location': './node_modules/requirejs-i18njs/src/',
// The main file
'main': 'requirejs-i18njs'
}
]
})
`

You can also configure some new delimiters for your templates :

`javascript
({
packages: [
{
'name': 'i18n',
'location': './node_modules/requirejs-i18njs/src/',
'main': 'requirejs-i18njs',
'delimiters': {
'evaluate': /<%([\s\S]+?)%>/g,
'interpolate': /<%=([\s\S]+?)%>/g,
'escape': /<%-([\s\S]+?)%>/g
}
}
]
})
`
This will result in pre-compiling delimiters in the form of <%=interpolate%>, <%evaluate%> or <%-escape%>.

$3

You'll then be able to import your locales with :

`javascript
var fr = require('i18n!./locales/fr.json');
i18njs.add('fr', fr);
`

Also, you can tell which language you want to subscribe your strings to by providing the lang as a parameter :

`javascript
require('i18n!./locales/fr.json?lang=fr');
`
It will execute i18n.add('fr', locales); directly from the plugin.

The same is also possible to add new defaults to your configuration by providing the defaults parameter :

`javascript
require('i18n!./locales/defaults.json?defaults=true');
`
It will execute i18n.setDefaults(defaults); directly from the plugin.

For these to work, you'll need to have I18NJS imported first.

You can use your require.config.deps for this :
`javascript
require.config({
// Note that this is at the root of the config.
deps: ['i18njs']
});
`
This will load i18njs` before everything else.