grunt-json-angular-translate
Converts json files to angular-translate config javascript files.
Getting Started
This plugin requires Grunt.
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-json-angular-translate --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "jsonAngularTranslate" task
Overview
In your project's Gruntfile, add a section named jsonAngularTranslate
to the data object passed into grunt.initConfig()
.
grunt
Options
options.moduleName
Type: String
Default value: translations
The module name to use in the angular.module
calls.
options.extractLanguage
Type: RegExp|Function
Default value: /..(?=\.[^.]*$)/
(last two characters before the last dot)
A regular expression or a function that returns the processed file's language according to its file path.
options.hasPreferredLanguage
Type: Boolean
Default value: true
Whether to set the language and preferred language in config file. Relevant only in angular-translate 1.*
.
options.createNestedKeys
Type: Boolean
Default value: true
Whether to create a nested output from dot separated keys.
Source json
{
"My.First.Key": "..."
}
Outputs
{
'My': {
'First': {
'Key': '...'
}
}
}
Set this option to false if you use your source language string as the key.
createNestedKeys: false, Outputs
{
'My.First.Key': '...'
}
Usage Examples
Default Options
In this example, we convert all .json files in app/scripts/locale
to angular-translate config files in .tmp/scripts/locale
.
grunt
So app/scripts/locale/messages_ru.js
with contents:
"key1": "value1" "key2.subKey1": "value2" "key2.subKey2": "value3"
Will be converted to .tmp/scripts/locale/messages_ru.js
with contents:
'use strict'; try angular; catch e angular; angular;
Custom Options
In this example, we convert all .json files in app/scripts/locale
to angular-translate config files in .tmp/scripts/locale
with custom moduleName
. Thanks to the custom extractLanguage
file's language code will be extracted from the first two characters in the file name, so filepath app/scripts/locale/he_messages.json
will get language code he
.
grunt
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
License
Copyright (c) 2014 Shahar Talmi. Licensed under the MIT license.