1.0.2 • Published 10 years ago

yaml-translate v1.0.2

Weekly downloads
7
License
MIT
Repository
github
Last release
10 years ago

yaml-translate

Installation

npm install yaml-translate

Usage

Create language.yml file in the root directory of your project and create key-value pair objects with the following syntax:

# Name
name:
 en: Name
 ru: Имя

# Description
description:
 en: Description
 ru: Описание
 de: Beschreibung

In your Node.js project require the yaml-translate module.

var yaml = require('yaml-translate');
var options = {
    // optional options settings
    // see all available options below
};
translate.translate(options); 

Or if you are using Gulp, in your gulpfile.js place the following code:

var yaml = require('yaml-translate');

gulp.task('translate', function() {
	var options = {
    	// optional options settings
        // see all available options below
    };
    return yaml.translate(options);   
});

And in terminal run the following command:

gulp translate

Options

OptionDescriptionDefault ValueType
srcLanguage source file YAML./language.ymlString
outputDirOutput directory of generated JSON fileslocaleString
onlyArray of only translatable language keys''String or Array
exceptArray of language keys, which should be excluded''String or Array
cleanRemove all generated files before regeneratingfalseBoolean