rollup-umd-scripts/bin/scripts/cmds/documentation_cmds/intl.js

CLI for rollup-umd projects

'use strict';

var _stringify = require('babel-runtime/core-js/json/stringify');

var _stringify2 = _interopRequireDefault(_stringify);

var _keys = require('babel-runtime/core-js/object/keys');

var _keys2 = _interopRequireDefault(_keys);

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

/* eslint-disable */
var path = require('path');
var fs = require('fs');
var async = require('async');

var emptyLink = function emptyLink(lang, isPrivate) {
  return isPrivate ? '*empty* ([edit now](' + pkg.bugs.url.split('/issues')[0] + '/edit/dev/translate/' + lang + '.json))' : '*empty*';
};
require('shelljs/global');

exports.command = 'intl';
exports.desc = 'Create internationalization documentation.';
exports.builder = function (yargs) {
  return yargs.option('path', {
    alias: 'p',
    describe: 'path',
    default: process.cwd()
  });
};
exports.handler = function (argv) {
  switch (argv.path[0]) {
    case '/':
      break;
    default:
      argv.path = argv.path[1] === '/' ? path.join(process.cwd(), argv.path.slice(2)) : path.join(process.cwd(), argv.path);
      break;
  }
  var thisPkg = require(path.join(__dirname, '../../../../package.json'));
  var pkg = require(path.join(argv.path, 'package.json'));

  if (!pkg.dependencies['react-intl']) {
    console.log('[Error] - You must use a intl declination to use this command!');
    return;
  }
  var gitlabCiPath = path.join(argv.path, '.gitlab-ci.yml');
  var configPath = path.join(argv.path, 'styleguide/styleguide.ext.json');
  var config = require(configPath);

  if (!pkg.translation) {
    throw new Error('You must run intl install first. (eg: intl install en fr de --default=en');
  }

  var readmeList = [];
  var start = '**Import translation**\n\n';
  start += '```js static\nimport englishMessages from \'$PACKAGE_NAME/translate/en.json\';\n```';
  start += '\n\n> Locales can be configured within your `package.json` under `translation` or using `npx rollup-umd-scripts intl install` command.';
  start += '\n';

  async.auto({
    runExtract: function runExtract(cb) {
      return spawn('npx ' + thisPkg.name + ' intl extract', cb);
    },
    isPrivate: function isPrivate(cb) {
      return spawn('npx ' + thisPkg.name + ' publish status | tail -1', cb);
    },
    setupCi: function setupCi(cb) {
      return exec('grep -q "npx rollup-umd-scripts doc intl" ' + gitlabCiPath + ' || echo true', function (err, res) {
        if (res && res.indexOf('true') !== -1) {
          sedReplace(gitlabCiPath, '# !Replace variables', '# !Replace variables\n    - npx ' + thisPkg.name + ' doc intl', gitlabCiPath, cb);
          return;
        }
        cb();
      });
    },
    makeDoc: ['runExtract', 'isPrivate', 'setupCi', function (res, cb) {
      var isPrivate = !((res.isPrivate[0].split('tail')[1] || res.isPrivate).indexOf('private') === -1); // ugly but support both internal cli and external cli
      pkg.translation.locales.forEach(function (locale) {
        var translationPath = path.join(argv.path, 'translation', locale + '.json');
        if (fs.existsSync(translationPath)) {
          var messages = require(translationPath);
          var readme = '\n';
          readme += pkg.translation.locale === locale ? '## ' + locale + ' (default)' : '## ' + locale;
          readme += '\n\n';
          readme += '| id | defaultMessage |';
          readme += '\n';
          readme += '|----|----------------|';
          readme += '\n';
          (0, _keys2.default)(messages).forEach(function (key) {
            readme += '| `' + key + '` | ' + (messages[key] ? '`' + messages[key] + '`' : emptyLink(locale, isPrivate)) + ' |';
            readme += '\n';
          });
          readme += '\n';
          readmeList.push({ locale: locale, readme: readme });
        }
      });
      var final = start;
      readmeList.forEach(function (readme) {
        final += readme.readme;
      });

      final += '*This file is automatically generated. Do not edit.*';
      final += '\n';

      fs.writeFileSync(path.join(argv.path, 'docs/translation.md'), final, 'utf-8');

      var intlDocSection = config.sections.filter(function (section) {
        return section.name === 'Translation';
      })[0];
      if (!intlDocSection) {
        var faqInd = 0;
        config.sections.filter(function (section, i) {
          if (section.name === 'FAQ') {
            faqInd = i;
          }
        });
        config.sections = config.sections.slice(0, faqInd).concat([{ name: 'Translation', content: 'docs/translation.md' }]).concat(config.sections.slice(faqInd));

        fs.writeFileSync(configPath, (0, _stringify2.default)(config, null, 2), { encoding: 'utf8' });
      }

      console.log(path.join(argv.path, 'docs/translation.md') + ' has been updated');
    }]
  }, function (err, res) {
    if (err) {
      console.error('[ERROR] ' + err.message);
      process.exit(1);
    }
    console.log('[Success] Internationalization documentation generated.');
  });
};