Code Monkey home page Code Monkey logo

gulp-translator's Introduction

Gulp Translator

Almost like string replace but using locales Now you can use both .json and .yml files.

Usage

First, install gulp-translator as a development dependency:

npm install --save-dev gulp-translator

Then, add it to your gulpfile.js:

var translate = require('gulp-translator');

gulp.task('translate', function() {
  var translations = ['pl', 'en'];

  translations.forEach(function(translation){
    gulp.src('app/views/**/*.html')
      .pipe(translate(options))
      .pipe(gulp.dest('dist/views/' + translation));
  });
});

or better, handle errors:

gulp.task('translate', function() {
  var translations = ['pl', 'en'];

  translations.forEach(function(translation){
    gulp.src('app/views/**/*.html')
      .pipe(
        translate(options)
        .on('error', function(){
          console.error(arguments);
        })
      )
      .pipe(gulp.dest('dist/views/' + translation));
  });
});

Options

options in translate function is:

  • String Path to locale file.
  • Object
    • .localePath String. Optional. Path to locale file. Or you can use .lang, .localeDirectory.
    • .lang String. Optional. Target language.
    • .localeDirectory String. Optional. Directory with locale files. If no .localePath specified, try construct it from .localeDirectory + .lang.
    • .localeExt String. Optional. If you specify path to file will transform newLocalePath = oldLocalePath + .localExt.
    • .pattern RegExp. Optional. Pattern to find strings to replace. You can specify your own pattern. To transform strings without translate. Default: /\{{2}([\w\.\s\"\']+\s?\|\s?translate[\w\s\|]*)\}{2}/g
    • .patternSplitter String. Some to split parts of transform. Default: '|'.
    • .transform Object. Every field is you transform function. First argument is an content to transform it. Second is an dictionary, that you specified. Function should return transformed string or Error object with some message.

Usage

I'm using angular-like syntax. Expressions in {{}} with | translate filter will be translated.

Following examples assume that "title" in locales equals "new TITLE"

Example:

{{ title | translate }} will be change to "new TITLE"

If you'd like to use filters(look at the bottom to check available filters) just pass them after like that:

{{ title | translate | lowercase }} will be change to "new title"

{{ title | translate | uppercase }} will be change to "NEW TITLE"

If you're still not sure, please look at tests.

API

gulp-translator is called with a string

translate(string)

string

Type: String

The string is a path to a nameOfTheFile.yml with your locales. Please look at test/locales for examples.

Available filters:

  • lowercase
  • uppercase
  • capitalize to capitalize only first word.
  • capitalizeEvery to capitalize every word.
  • reverse

User filters:

You also can specify your own filters. Just add them to .transform parameter of options. First argument is an content to transform it. Second is an dictionary, that you specified. Function should return transformed string or Error object with some message.

TODO:

  • refactor tests
  • work on matchers (sigh...)

License

MIT

gulp-translator's People

Contributors

arathunku avatar diegoleme avatar numminorihsf avatar raphaelluchini avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.