gulp-i18n-leverage - npm Package Compare versions

Comparing version 1.0.6 to 1.0.7

package.json

 {
   "name": "gulp-i18n-leverage",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Merge changes in default JSON into localized JSON for i18n-behavior",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -430,2 +430,226 @@ [![Build Status](https://travis-ci.org/t2ym/gulp-i18n-leverage.svg?branch=master)](https://travis-ci.org/t2ym/gulp-i18n-leverage)
 
+### Integrate with polymer-cli project templates (highly experimental)
+
+#### Note:
+  - As of [`polymer-cli 0.8.0`](https://github.com/Polymer/polymer-cli), `polymer` command and the project templates are pre-release and subject to change including the private API `userTransformers` on which this integration works.
+
+#### Set up `package.json` and the dependent packages of the following `guilfile.js`
+
+```sh
+    npm init # if package.json is missing
+    npm install --save-dev gulp gulp-debug gulp-grep-contents \
+      gulp-i18n-add-locales gulp-i18n-leverage gulp-i18n-preprocess \
+      gulp-if gulp-match gulp-merge gulp-size gulp-sort gulp-util \
+      json-stringify-safe strip-bom through2 xliff-conv
+```
+
+#### User Transformers:
+  - scan - Scan HTMLs and construct localizable attributes repository
+  - basenameSort - Sort source files according to their base names; Bundle files come first.
+  - preprocess - Preprocess Polymer templates for I18N
+  - tmpJSON - Store extracted JSON in the temporary folder .tmp
+  - importXliff - Import XLIFF into JSON
+  - leverage - Merge changes in default JSON into localized JSON
+  - exportXliff - Generate bundles and export XLIFF
+  - feedback - Update JSON and XLIFF in sources
+  - debug - Show the list of processed files including untouched ones
+  - size - Show the total size of the processed files
+
+#### Gulp task:
+  - `gulp locales --targets="{space separated list of target locales}"`
+
+#### gulpfile.js: Put it in the root folder of the project
+```javascript
+    var gulp = require('gulp');
+    var gutil = require('gulp-util');
+    var debug = require('gulp-debug');
+    var gulpif = require('gulp-if');
+    var gulpmatch = require('gulp-match');
+    var sort = require('gulp-sort');
+    var grepContents = require('gulp-grep-contents');
+    var size = require('gulp-size');
+    var merge = require('gulp-merge');
+    var through = require('through2');
+    var path = require('path');
+    var stripBom = require('strip-bom');
+    var JSONstringify = require('json-stringify-safe');
+    var i18nPreprocess = require('gulp-i18n-preprocess');
+    var i18nLeverage = require('gulp-i18n-leverage');
+    var XliffConv = require('xliff-conv');
+    var i18nAddLocales = require('gulp-i18n-add-locales');
+
+    // Global object to store localizable attributes repository
+    var attributesRepository = {};
+
+    // Bundles object
+    var prevBundles = {};
+    var bundles = {};
+
+    var title = 'I18N transform';
+    var tmpDir = '.tmp';
+
+    // Scan HTMLs and construct localizable attributes repository
+    var scan = gulpif('*.html', i18nPreprocess({
+      constructAttributesRepository: true, // construct attributes repository
+      attributesRepository: attributesRepository, // output object
+      srcPath: '.', // path to source root
+      attributesRepositoryPath: 
+        'bower_components/i18n-behavior/i18n-attr-repo.html', // path to i18n-attr-repo.html
+      dropHtml: false // do not drop HTMLs
+    }));
+
+    var basenameSort = sort({
+      comparator: function(file1, file2) {
+        var base1 = path.basename(file1.path).replace(/^bundle[.]/, ' bundle.');
+        var base2 = path.basename(file2.path).replace(/^bundle[.]/, ' bundle.');
+        return base1.localeCompare(base2);
+      }
+    });
+
+    var preprocess = gulpif('*.html', i18nPreprocess({
+      replacingText: true, // replace UI texts with {{annotations}}
+      jsonSpace: 2, // JSON format with 2 spaces
+      srcPath: '.', // path to source root
+      attributesRepository: attributesRepository // input attributes repository
+    }));
+
+    var tmpJSON = gulpif([ 'src/**/*.json', '!src/**/locales/*' ], gulp.dest(tmpDir));
+
+    var unbundleFiles = [];
+    var importXliff = through.obj(function (file, enc, callback) {
+      // bundle files must come earlier
+      unbundleFiles.push(file);
+      callback();
+    }, function (callback) {
+      var match;
+      var file;
+      var bundleFileMap = {};
+      var xliffConv = new XliffConv();
+      while (unbundleFiles.length > 0) {
+        file = unbundleFiles.shift();
+        if (path.basename(file.path).match(/^bundle[.]json$/)) {
+          prevBundles[''] = JSON.parse(stripBom(String(file.contents)));
+          bundleFileMap[''] = file;
+        }
+        else if (match = path.basename(file.path).match(/^bundle[.]([^.\/]*)[.]json$/)) {
+          prevBundles[match[1]] = JSON.parse(stripBom(String(file.contents)));
+          bundleFileMap[match[1]] = file;
+        }
+        else if (match = path.basename(file.path).match(/^bundle[.]([^.\/]*)[.]xlf$/)) {
+          xliffConv.parseXliff(String(file.contents), { bundle: prevBundles[match[1]] }, function (output) {
+            if (bundleFileMap[match[1]]) {
+              bundleFileMap[match[1]].contents = new Buffer(JSONstringify(output, null, 2));
+            }
+          });
+        }
+        else if (gulpmatch(file, '**/locales/*.json') &&
+                 (match = path.basename(file.path, '.json').match(/^([^.]*)[.]([^.]*)/))) {
+          if (prevBundles[match[2]] && prevBundles[match[2]][match[1]]) {
+            file.contents = new Buffer(JSONstringify(prevBundles[match[2]][match[1]], null, 2));
+          }
+        }
+        this.push(file);
+      }
+      callback();
+    });
+
+    var leverage = gulpif([ 'src/**/locales/*.json', '!**/locales/bundle.*.json' ], i18nLeverage({
+      jsonSpace: 2, // JSON format with 2 spaces
+      srcPath: '', // path to source root
+      distPath: '/' + tmpDir, // path to dist root to fetch next default JSON files
+      bundles: bundles // output bundles object
+    }));
+
+    var bundleFiles = [];
+    var exportXliff = through.obj(function (file, enc, callback) {
+      bundleFiles.push(file);
+      callback();
+    }, function (callback) {
+      var file;
+      var cwd = bundleFiles[0].cwd;
+      var base = bundleFiles[0].base;
+      var xliffConv = new XliffConv();
+      var srcLanguage = 'en';
+      var promises = [];
+      var self = this;
+      while (bundleFiles.length > 0) {
+        file = bundleFiles.shift();
+        if (!gulpmatch(file, [ '**/bundle.json', '**/locales/bundle.*.json', '**/xliff/bundle.*.xlf' ])) {
+          this.push(file);
+        }
+      }
+      for (var lang in bundles) {
+        bundles[lang].bundle = true;
+        this.push(new gutil.File({
+          cwd: cwd,
+          base: base,
+          path: lang ? path.join(cwd, 'locales', 'bundle.' + lang + '.json')
+                     : path.join(cwd, 'bundle.json'),
+          contents: new Buffer(JSONstringify(bundles[lang], null, 2))
+        }));
+      }
+      for (var lang in bundles) {
+        if (lang) {
+          (function (destLanguage) {
+            promises.push(new Promise(function (resolve, reject) {
+              xliffConv.parseJSON(bundles, {
+                srcLanguage: srcLanguage,
+                destLanguage: destLanguage
+              }, function (output) {
+                self.push(new gutil.File({
+                  cwd: cwd,
+                  base: base,
+                  path: path.join(cwd, 'xliff', 'bundle.' + destLanguage + '.xlf'),
+                  contents: new Buffer(output)
+                }));
+                resolve();
+              });
+            }));
+          })(lang);
+        }
+      }
+      Promise.all(promises).then(function (outputs) {
+        callback();
+      });
+    });
+
+    var feedback = gulpif([ '**/bundle.json', '**/locales/*.json', '**/src/**/*.json', '**/xliff/bundle.*.xlf' ], gulp.dest('.'));
+
+    var config = {
+      // list of target locales to add
+      locales: gutil.env.targets ? gutil.env.targets.split(/ /) : []
+    }
+
+    // Gulp task to add locales to I18N-ready elements and pages
+    // Usage: gulp locales --targets="{space separated list of target locales}"
+    gulp.task('locales', function() {
+      var elements = gulp.src([ 'src/**/*.html' ], { base: '.' })
+        .pipe(grepContents(/i18n-behavior.html/))
+        .pipe(grepContents(/<dom-module /));
+
+      var pages = gulp.src([ 'index.html' ], { base: '.' })
+        .pipe(grepContents(/is=['"]i18n-dom-bind['"]/));
+
+      return merge(elements, pages)
+        .pipe(i18nAddLocales(config.locales))
+        .pipe(gulp.dest('.'))
+        .pipe(debug({ title: 'Add locales:'}))
+    });
+
+    module.exports = {
+      transformers: [
+        scan,
+        basenameSort,
+        preprocess,
+        tmpJSON,
+        importXliff,
+        leverage,
+        exportXliff,
+        feedback,
+        debug({ title: title }),
+        size({ title: title })
+      ]
+    };
+```
+
 ## API
@@ -432,0 +656,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

721

increased by45.07%

Worsened metrics

Total package byte prevSize

154771

decreased by-41.64%

Number of package files

42

decreased by-19.23%

Lines of code

3852

decreased by-9.73%

No dependency changes