grunt-plntr-locale

grunt-plntr-locale

Converts YAML localization files to Planitar angular Locale services.

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-plntr-locale --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-plntr-locale');

The "plntrLocale" task

Overview

In your project's Gruntfile, add a section named plntrLocale to the data object passed into grunt.initConfig().

grunt.initConfig({
  plntrLocale: {
    jobName: {
      options: {
        moduleName: 'app.i18n',
        extractLanguage: /..(?=\.[^.]*$)/,
      },
      files: [{
        // Target-specific file lists and/or options go here. (see examples below)
      }]
    }
  }
})

Options

options.moduleName

Type: String Default value: app.i18n

i18n module name.

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.createNestedKeys

Type: Boolean Default value: true

Whether to create a nested output from dot separated keys.

Source json

key:
  "subkey.phraseId": "..."
}

Outputs

{
  'key': {
    'subkey': {
      'phraseId': '...'
    }
  }
}

Set this option to false if you use your source language string as the key.

createNestedKeys: false, Outputs

{
  "key": {
    "subkey.phraseId": "..."
  }
}

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.initConfig({
  plntrLocale: {
    jobName: {
      options: {},
      files: [{
        expand: true,
        cwd: 'app/scripts/locale',
        src: '*.json',
        dest: '.tmp/scripts/locale',
        ext: '.js'
      }]
    }
  },
})

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.module('translations');
} catch (e) {
  angular.module('translations', ['pascalprecht.translate']);
}

angular.module('translations').config(function ($translateProvider) {
  $translateProvider.translations('ru', {
    'key1': 'value1',
    'key2': {
      'subKey1': 'value2',
      'subKey2': 'value3'
    }
  });
  $translateProvider.preferredLanguage('ru');
});

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.initConfig({
  plntrLocale: {
    jobName: {
      options: {
        moduleName: 'myAppTranslations',
        extractLanguage: function (filepath) {
          return filepath.split('/').reverse()[0].slice(2);
        }
      },
      files: [{
        expand: true,
        cwd: 'app/scripts/locale',
        src: '*.json',
        dest: '.tmp/scripts/locale',
        ext: '.js'
      }]
    }
  },
})

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.