ember-i18n-yaml-to-json

Converts yaml files to js files, lets you maintain all your translations at one place.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
ember-i18n-yaml-to-json
1.0.16 years ago9 years agoMinified + gzip package size for ember-i18n-yaml-to-json in KB

Readme

ember-i18n-yaml-to-json
This README outlines the details of collaborating on this Ember addon.

Installation

  • ember install ember-i18n-yaml-to-json

  • In your Brocfile add the following at the top and before any build related activities.
var yamlToJsonEngine = require('ember-i18n-yaml-to-json').engine;
yamlToJsonEngine.convert();

  • ember build --yaml-path=<YAML_PATH> --js-path=<JS_PATH> --default-locale=en --file-type=js

  • You can even overwrite the parameters during conversion
`yamlToJsonEngine.convert({yamlDir:"<YAML_PATH>",jsDir:"<JS_PATH>",defaultLocale:"en",fileType:"js"});`<br/>
Ignore the params during `ember build`. If you give any, then command-line params will overwrite the params given during function call.
It will help you get rid of the pain in juggling between yml & js for i18n translations. I mean, yml file(as in Ruby on Rails "config/locales") for your backend translations and js file (as in ember-i18n "app/locales/en/translations") for frontend translations. It will enable you to maintain your i18n translations in a centralized location(.yml) by converting all your translation file to js/json format during "ember build". It also has a fallback mechanism with reference to your default locale, any missing key will grab the value from "default-locale"( or en.yml) during conversion.
Also it will generate translations with JS extension by default. To change it to JSON provide the option in command-line as --file-type=json or while calling convert({fileType:"json"}) method.
In case of JS file type, you can even format your translation output. By default it will be in the following format: export default {{translations}};. You can provide any custom format with {{translations}} interpolation like var I18NString = {{translations}}.
PS: this addon currently supports the locale path format as in ember-i18n, i.e., your yml files will be placed at PATH>//translations.js