Add i18n scripts

gulpfile.js

@@ -7,6 +7,7 @@ const minifyCss = require('gulp-minify-css');
 const gulpFilter = require('gulp-filter');
 const del = require('del');
 const templateCache = require('./scripts/templateCache');
+const i18n = require('./scripts/i18n');
 
 gulp.task('templates', function () {
   return merge2([
@@ -27,6 +28,7 @@ gulp.task('copy-files', function () {
     '!src/cache.js',
     '!src/**/templates/**',
     '!src/**/templates',
+    '!src/_locales/**',
   ], {base:'src'})
   .pipe(cssFilter)
   .pipe(minifyCss())
@@ -34,4 +36,34 @@ gulp.task('copy-files', function () {
   .pipe(gulp.dest('dist/'));
 });
 
-gulp.task('default', ['templates', 'copy-files']);
+gulp.task('copy-i18n', function () {
+  return gulp.src([
+    'src/**/*.js',
+    'src/**/*.html',
+    'src/**/*.json',
+  ]).pipe(i18n.extract({
+    base: 'src',
+    prefix: '_locales',
+    touchedOnly: true,
+    useDefaultLang: true,
+    markUntouched: false,
+  }))
+  .pipe(gulp.dest('dist'));
+});
+
+gulp.task('default', ['templates', 'copy-files', 'copy-i18n']);
+
+gulp.task('i18n', function () {
+  return gulp.src([
+    'src/**/*.js',
+    'src/**/*.html',
+    'src/**/*.json',
+  ]).pipe(i18n.extract({
+    base: 'src',
+    prefix: '_locales',
+    touchedOnly: false,
+    useDefaultLang: false,
+    markUntouched: true,
+  }))
+  .pipe(gulp.dest('src'));
+});

scripts/i18n.js

@@ -0,0 +1,158 @@
+'use strict';
+
+const gutil = require('gulp-util');
+const through = require('through2');
+const fs = require('fs');
+
+function Locale(lang, path, base) {
+  this.lang = lang;
+  this.path = path;
+  this.base = base || '.';
+  this.data = {};
+  this.loaded = this.read();
+}
+Locale.prototype.read = function () {
+  return new Promise((resolve, reject) => {
+    fs.readFile(this.base + '/' + this.path, (err, data) => err ? reject(err) : resolve(data));
+  }).then((data) => {
+    const desc = {};
+    data = JSON.parse(data);
+    for (let key in data) {
+      this.data[key] = data[key].message;
+      desc[key] = data[key].description;
+    }
+    return desc;
+  });
+};
+Locale.prototype.get = function (key, def) {
+  return this.data[key] || def;
+};
+
+function Locales(prefix, base) {
+  this.prefix = prefix || '.';
+  this.base = base || '.';
+  this.langs = [];
+  this.data = {};
+  this.desc = {};
+  this.loaded = this.load();
+}
+Locales.prototype.defaultLang = 'en';
+Locales.prototype.newLocaleItem = 'NEW_LOCALE_ITEM';
+Locales.prototype.getLanguages = function () {
+  const localeDir = this.base + '/' + this.prefix;
+  return new Promise((resolve, reject) => {
+    fs.readdir(localeDir, (err, files) => err ? reject(err) : resolve(files));
+  });
+};
+Locales.prototype.load = function () {
+  return this.getLanguages().then((langs) => {
+    this.langs = langs;
+    return Promise.all(langs.map((lang) => {
+      const locale = this.data[lang] = new Locale(lang, `${this.prefix}/${lang}/messages.json`, this.base);
+      return locale.loaded;
+    }));
+  }).then((data) => {
+    const desc = data[this.langs.indexOf(this.defaultLang)];
+    for (let key in desc) {
+      this.desc[key] = {
+        touched: false,
+        value: desc[key],
+      };
+    }
+  });
+};
+Locales.prototype.getData = function (lang, options) {
+  options = options || {};
+  let data = {};
+  const langData = this.data[lang];
+  const defaultData = options.useDefaultLang && lang != this.defaultLang && this.data[this.defaultLang];
+  for (let key in this.desc) {
+    if (options.touchedOnly && !this.desc[key].touched) continue;
+    data[key] = {
+      description: this.desc[key].value || this.newLocaleItem,
+      message: langData.get(key) || defaultData && defaultData.get(key) || '',
+    };
+    if (options.markUntouched && !this.desc[key].touched)
+      data[key].touched = false;
+  }
+  return data;
+};
+Locales.prototype.dump = function (options) {
+  return this.langs.map((lang) => {
+    const data = this.getData(lang, options);
+    const string = JSON.stringify(data, null, 2);
+    return new gutil.File({
+      base: '',
+      path: `${this.prefix}/${lang}/messages.json`,
+      contents: new Buffer(string),
+    });
+  });
+};
+Locales.prototype.touch = function (key) {
+  let item = this.desc[key];
+  if (!item) item = this.desc[key] = {
+    value: this.newLocaleItem,
+  };
+  item.touched = true;
+};
+
+function extract(options) {
+  const keys = new Set();
+  const patterns = {
+    js: ['_.i18n\\(([\'"])(\\w+)\\1', 2],
+    json: ['__MSG_(\\w+)__', 1],
+    html: ['data-i18n=([\'"]?)(\\w+)\\1', 2],
+  };
+
+  const locales = new Locales(options.prefix, options.base);
+
+  function extract(data, types) {
+    if (!Array.isArray(types)) types = [types];
+    data = String(data);
+    types.forEach(function (type) {
+      const patternData = patterns[type];
+      const pattern = new RegExp(patternData[0], 'g');
+      const groupId = patternData[1];
+      let groups;
+      while (groups = pattern.exec(data)) {
+        keys.add(groups[groupId]);
+      }
+    });
+  }
+
+  function bufferContents(file, enc, cb) {
+    if (file.isNull()) return cb();
+    if (file.isStream())
+      return this.emit('error', new gutil.PluginError('VM-i18n', 'Stream is not supported.'));
+    if (file.path.endsWith('.js'))
+      extract(file.contents, 'js');
+    else if (file.path.endsWith('.json'))
+      extract(file.contents, 'json');
+    else if (file.path.endsWith('.html'))
+      extract(file.contents, ['html', 'js']);
+    cb();
+  }
+
+  function endStream(cb) {
+    locales.loaded.then(() => {
+      keys.forEach((key) => {
+        locales.touch(key);
+      });
+      return locales.dump({
+        touchedOnly: options.touchedOnly,
+        useDefaultLang: options.useDefaultLang,
+      });
+    }).then((files) => {
+      files.forEach((file) => {
+        this.push(file);
+      });
+      cb();
+    });
+  }
+
+  return through.obj(bufferContents, endStream);
+}
+
+module.exports = {
+  extract,
+};

scripts/templateCache.js

@@ -13,6 +13,7 @@ const minified = require('./minifyHtml');
 module.exports = function templateCache() {
   const contentTpl = '_.cache.put(<%= name %>, <%= content %>);\n';
   let content = '/* Below are templates cached from `_.template` with love :) */\n\n';
+
   function bufferContents(file, enc, cb) {
     if (file.isNull()) return cb();
     if (file.isStream())
@@ -24,6 +25,7 @@ module.exports = function templateCache() {
     });
     cb();
   }
+
   function endStream(cb) {
     this.push(new gutil.File({
       base: '',
@@ -32,5 +34,6 @@ module.exports = function templateCache() {
     }));
     cb();
   }
+
   return through.obj(bufferContents, endStream);
 };