get-translation/libraries/log.js

Effective translation workflow

var file = require('./file')
  , log = require('./_log');

/**
 * Add terminal colors
 */

require('terminal-colors');

/**
 * Log constructor helps you output all logs for you
 *
 * @constructor Log
 */

function Log() {
  this.defaultLocale = pcf.defaultLocale;
  this.locales = pcf.locales;
}


/**
 * Get latest translation updates
 *
 * @param {String} locale
 * @return {Array}
 * @api private
 */

Log.prototype.outputLog = function(locale, type) {
  locale = locale || this.defaultLocale;

  var translations = this._getLatestUpdates(locale).slice(0, pcf.LOG_LENGTH);

  if(!translations.length) {
    return log.log('No translations.');
  }

  if(type === 'no-values') {
    var n = 1;
    for(var i in translations) {
      if(translations[i].values.length === 0) {
        if(n <= pcf.LOG_LENGTH) {
          log.log(translations[i].key + ' | ' + translations[i].text.green);
        }
        else {
          break;
        }
        n++;
      }
    }

    if(n === 1) {
      log.log('No non-translated translations for locale ' + locale.yellow + '.');
    }
  }
  else {
    var n = 1;
    for(var i in translations) {
      var tag;
      if((n+'').length < 2) {
        tag = ' @' + n;
      }
      else {
        tag = '@' + n;
      }
      log.log((tag).yellow + ' ' + translations[i].key + ' | ' + translations[i].text.green);
      n++;
    }

    if(n === 1) {
      log.log('No translations updated from source. Please update with `gt update`.');
    }
  }
};

/**
 * Get latest translation updates
 *
 * @param {String} locale
 * @return {Array}
 * @api private
 */

Log.prototype._getLatestUpdates = function(locale) {
  if(locale && typeof locale !== 'string') {
    throw new TypeError('first parameter must contain a locale string');
  }

  var translations = file.readTranslations(locale, { returnType : 'array' });

  return translations;
};

/**
 * Export constructor
 */

module.exports.Log = Log;