ztxkutils 10.0.8 → 20.0.1

package/zti18n-cli/src/command/initFileConf.js

@@ -0,0 +1,133 @@
+const glob = require('glob');
+const fs = require('fs');
+const path = require('path');
+const inquirer = require('inquirer');
+const prettier = require('prettier');
+const FileConf = require('../conf/FileConf');
+const reactOptions = require('../utils/reactOptions');
+const vueOptions = require('../utils/vueOptions');
+const log = require('../utils/log');
+
+function getLocaleFiles({ path, exclude }) {
+  return glob.sync(`${path}/**/*.json`, {
+    ignore: (exclude || []).map((e) => `${path}/${e}`),
+  });
+}
+
+async function doInquire() {
+  // 1. whether overwrite?
+  let configExist = true;
+  try {
+    fs.accessSync('./zti18n.config.js');
+  } catch (e) {
+    configExist = false;
+  }
+
+  if (configExist) {
+    const ans = await inquirer.prompt([
+      {
+        name: 'overwrite',
+        type: 'confirm',
+        message: '配置文件 zti18n.config.js 已存在，是否覆盖？',
+      },
+    ]);
+
+    if (!ans.overwrite) process.exit(0);
+  }
+
+  // 2. first i18n?
+  let ans = await inquirer.prompt([
+    {
+      name: 'firstI18n',
+      type: 'confirm',
+      message: '是否初次国际化？',
+    },
+    {
+      name: 'localePath',
+      type: 'input',
+      message: '请输入现有国际化资源路径：',
+      when(answers) {
+        return !answers.firstI18n;
+      },
+    },
+  ]);
+
+  return ans;
+}
+
+module.exports = async function initFileConf(isVue) {
+  const answers = await doInquire();
+  const { localePath = 'locales', firstI18n } = answers;
+
+  const defaultOptions = isVue ? vueOptions : reactOptions;
+  const options = {
+    ...defaultOptions,
+    localeConf: { type: 'file', folder: localePath },
+  };
+
+  // 配置信息写入文件
+  fs.writeFileSync(
+    './zti18n.config.js',
+    prettier.format('module.exports = ' + JSON.stringify(options), {
+      parser: 'babel',
+      singleQuote: true,
+      trailingComma: 'es5',
+    }),
+    'utf8'
+  );
+
+  let createTasks = [];
+  const confService = new FileConf(options.localeConf.folder);
+
+  if (!firstI18n) {
+    // 非首次国际化，本地代码中已有国际化资源
+    const locales = getLocaleFiles({ path: localePath });
+
+    // 读取国际化资源
+    const data = locales.map((element) => {
+      // TODO: 支持国际化资源为 js 文件的情况，目前只支持为 json 文件。
+      const json = fs.readFileSync(element, {
+        encoding: 'utf-8',
+      });
+
+      // 使用现有文件名为语言 key
+      const key = path.parse(element).name;
+
+      return {
+        key,
+        value: JSON.parse(json),
+        confName: key,
+      };
+    });
+
+    createTasks = data.map(({ confName, value, key }) => {
+      let commentValue = {};
+      if (key !== options.primaryLocale) {
+        commentValue = data.find((d) => d.key === options.primaryLocale).value;
+      }
+      return confService.createConf(confName, value, commentValue, key);
+    });
+  } else {
+    // 首次国际化，只需要创建配置
+    createTasks = options.supportedLocales.map((key) => {
+      const value = { TBD: 'TBD' }; // 创建配置时，必须要有一个 k/V
+      const confName = key; // 初始化时，先创建测试环境的配置
+      return confService.createConf(confName, value, {}, key);
+    });
+  }
+
+  const createTaskResults = await Promise.all(createTasks);
+  log.success('[done] conf created');
+  console.log(createTaskResults);
+
+  // 将已有国际化资源的配置发布
+  if (!firstI18n) {
+    const publishTasks = options.supportedLocales.map((key) => {
+      return confService.publishConf(`${key}-test`);
+    });
+
+    const publishTaskResults = await Promise.all(publishTasks);
+    log.success('[done] conf published');
+    console.log(publishTaskResults);
+  }
+};

package/zti18n-cli/src/command/publish.js

@@ -0,0 +1,24 @@
+const path = require('path');
+const mergeOptions = require('../utils/mergeOptions');
+const log = require('../utils/log');
+
+module.exports = async function publish(programOption, env = '') {
+  const options = mergeOptions(programOption, ['locales']);
+
+  let confService = null;
+  if (options.localeConf.type === 'file') {
+    const FileConf = require('../conf/FileConf');
+    confService = new FileConf(options.locales);
+  } else {
+    const Conf = require(path.join(process.cwd(), options.localeConf.path));
+    confService = new Conf(options.localeConf);
+  }
+
+  const publishTasks = options.supportedLocales.map((key) => {
+    return confService.publishConf(`${key}-${env}`);
+  });
+
+  const publishTaskResults = await Promise.all(publishTasks);
+  log.success('[done] conf published');
+  console.log(publishTaskResults);
+};

package/zti18n-cli/src/conf/BaseConf.js

@@ -0,0 +1,21 @@
+module.exports = class BaseConf {
+  createService() {
+    return Promise.resolve(true);
+  }
+
+  createConf() {
+    throw new Error('`createConf` must be overrided');
+  }
+
+  updateConf() {
+    throw new Error('`updateConf` must be overrided');
+  }
+
+  getConf() {
+    throw new Error('`getConf` must be overrided');
+  }
+
+  publishConf() {
+    return Promise.resolve(true);
+  }
+};

package/zti18n-cli/src/conf/FileConf.js

@@ -0,0 +1,116 @@
+const fs = require('fs');
+const path = require('path');
+const BaseConf = require('./BaseConf');
+const log = require('../utils/log');
+
+const cwdPath = process.cwd();
+
+module.exports = class FileConf extends BaseConf {
+  constructor(folder) {
+    super();
+    this.localesDir = folder;
+  }
+
+  /**
+   * 创建一个服务
+   */
+  createService() {
+    log.info('No need to create service in FileConf');
+    return super.createService();
+  }
+
+  /**
+   * 创建一个配置
+   * @param {string} confName  配置名称
+   * @param {object} values    KV值
+   * @param {object} refValues 参数备注
+   * @param {string} key       locales标识
+   */
+  createConf(confName, values, refValues, key) {
+    const folder = this.localesDir.startsWith('/')
+      ? this.localesDir
+      : path.join(cwdPath, this.localesDir);
+
+    try {
+      fs.accessSync(folder);
+    } catch (e) {
+      fs.mkdirSync(folder);
+    }
+
+    const configFilePath = path.join(folder, `${key}.json`);
+    return new Promise((resolve, reject) => {
+      fs.writeFile(configFilePath, JSON.stringify(values, null, 2), (err) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(configFilePath);
+        }
+      });
+    });
+  }
+
+  /**
+   * 更新一个配置
+   * @param {string} confName  配置名称
+   * @param {object} values    KV值
+   * @param {object} refValues 参数备注
+   * @param {string} key       locales标识
+   */
+  updateConf(confName, values, refValues, key) {
+    const configFilePath = path.join(cwdPath, this.localesDir, `${key}.json`);
+    return new Promise((resolve) => {
+      fs.writeFile(configFilePath, JSON.stringify(values, null, 2), (err) => {
+        if (err) {
+          resolve({
+            code: -1,
+            message: err.message,
+          });
+        } else {
+          resolve({
+            code: 0,
+            data: configFilePath,
+          });
+        }
+      });
+    });
+  }
+
+  /**
+   * 获取配置值
+   * @param {string} _  配置名称
+   * @param {string} key  key
+   */
+  getConf(confName, key) {
+    const configFilePath = path.join(cwdPath, this.localesDir, `${key}.json`);
+    return new Promise((resolve, reject) => {
+      if (fs.existsSync(configFilePath)) {
+        let data = {};
+        try {
+          const content = fs.readFileSync(configFilePath);
+          data = content.length > 0 ? JSON.parse(content) : {};
+          resolve({
+            code: 0,
+            data: Object.keys(data).map((k) => ({
+              key: k,
+              value: data[k],
+            })),
+          });
+        } catch (err) {
+          reject(
+            new Error(`请检查 ${configFilePath} 资源文件 JSON 格式是否正确`)
+          );
+        }
+      } else {
+        reject(new Error(`资源文件 ${configFilePath} 不存在`));
+      }
+    });
+  }
+
+  /**
+   * 发布指定的配置
+   */
+  publishConf() {
+    log.info('No need to publish in FileConf');
+    return super.publishConf();
+  }
+};

package/zti18n-cli/src/index.js

@@ -0,0 +1,75 @@
+const program = require('commander');
+const convert = require('./command/convert');
+const convert2 = require('./command/convert2');
+const collect = require('./command/collect');
+const publish = require('./command/publish');
+const option = require('../../package.json');
+
+module.exports = program;
+
+program
+  .version(option.version)
+  .option(
+    '-c, --config <path>',
+    'set config path. defaults to ./i18n.config.js'
+  );
+
+program
+  .command('sync')
+  .alias('s')
+  .description('pick chinese words and snyc with locale conf')
+  .option('-p, --publish', 'to publish the synced conf or not, defautl : false')
+  .action(function (options) {
+    collect(program.opts(), !!options.publish);
+  })
+  .on('--help', function () {
+    console.log('  Examples:');
+    console.log();
+    console.log('  sync without publish:');
+    console.log('    $ zti18n sync -c ./config/prod.config.js');
+    console.log('  sync and then publish:');
+    console.log('    $ zti18n sync -p -c ./config/prod.config.js');
+    console.log();
+  });
+
+program
+  .command('publish')
+  .description('publish locale confs')
+  .action(function () {
+    publish(program.opts());
+  })
+  .on('--help', function () {
+    console.log('  Examples:');
+    console.log();
+    console.log('    $ zti18n publish');
+    console.log();
+  });
+
+// XXX: 不表意，需要改一下
+program
+  .command('convert')
+  .alias('c')
+  .description('convert to react-intl-universal')
+  .action(function () {
+    convert(program.opts());
+  })
+  .on('--help', function () {
+    console.log('  Examples:');
+    console.log();
+    console.log('    $ zti18n convert -c ./config/prod.config.js');
+    console.log();
+  });
+
+program
+  .command('convert2')
+  .alias('c2')
+  .description('convert to intl.t')
+  .action(function () {
+    convert2(program.opts());
+  })
+  .on('--help', function () {
+    console.log('  Examples:');
+    console.log();
+    console.log('    $ zti18n convert2 -c ./config/prod.config.js');
+    console.log();
+  });

package/zti18n-cli/src/translate/google.js

@@ -0,0 +1,87 @@
+const crypto = require('crypto');
+const https = require('https');
+const querystring = require('querystring');
+
+function MD5(string) {
+  return crypto.createHash('md5').update(string).digest('hex');
+}
+
+function generateRandomString(length) {
+  // 定义包含所有可能字符的字符串
+  const characters =
+    'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+  let result = '';
+  const charactersLength = characters.length;
+  for (let i = 0; i < length; i++) {
+    // 生成一个0到字符集长度之间的随机索引
+    const randomIndex = Math.floor(Math.random() * charactersLength);
+    // 从字符集中取出对应索引的字符添加到结果字符串中
+    result += characters.charAt(randomIndex);
+  }
+  return result;
+}
+
+function translateByGoogle(text, targetLang, appid, privatekey) {
+  const data = {
+    appid,
+    nonce_str: generateRandomString(10),
+    from: 'zh',
+    to: targetLang,
+    text: text,
+  };
+  const translateData = {
+    ...data,
+    privatekey,
+  };
+  const stringA = Object.keys(translateData)
+    .sort()
+    .map((key) => `${key}=${translateData[key]}`)
+    .join('&');
+  const token = MD5(stringA).toUpperCase();
+
+  const agent = new https.Agent({
+    rejectUnauthorized: false,
+  });
+  const postData = querystring.stringify({
+    ...data,
+    token,
+  });
+  return new Promise((resolve, reject) => {
+    const req = https.request(
+      {
+        hostname: 'aify.zmd.com.cn',
+        path: '/TranslateApi/api/transText',
+        method: 'POST',
+        agent,
+        headers: {
+          'Content-Type': 'application/x-www-form-urlencoded',
+          'Content-Length': Buffer.byteLength(postData),
+        },
+      },
+      (res) => {
+        let data = [];
+
+        res.on('data', (chunk) => {
+          data.push(chunk);
+        });
+
+        res.on('end', () => {
+          const buffer = Buffer.concat(data);
+          const json = JSON.parse(buffer.toString());
+          resolve(json.data);
+        });
+      }
+    );
+
+    req.on('error', (error) => {
+      console.error(error);
+      reject(error);
+    });
+    // 写入请求数据
+    req.write(postData);
+    req.end();
+  });
+}
+// translateByGoogle('你好', 'en');
+
+module.exports = translateByGoogle;

package/zti18n-cli/src/utils/isChinese.js

@@ -0,0 +1,3 @@
+module.exports = function isChinese(text) {
+  return /[\u4e00-\u9fa5]/.test(text);
+};

package/zti18n-cli/src/utils/log.js

@@ -0,0 +1,8 @@
+const chalk = require('chalk');
+
+module.exports = {
+  info: (msg) => console.log(chalk.cyan(msg)),
+  warning: (msg) => console.log(chalk.yellow(msg)),
+  success: (msg) => console.log(chalk.green(msg)),
+  error: (msg) => console.log(chalk.red(msg)),
+};

package/zti18n-cli/src/utils/mergeOptions.js

@@ -0,0 +1,45 @@
+const fs = require('fs');
+const path = require('path');
+const defaultOptions = require('./reactOptions');
+const log = require('./log');
+
+const cwdPath = process.cwd();
+
+module.exports = function mergeOptions(programOption, programParameter) {
+  const options = defaultOptions;
+  const configFileName = programOption.config || 'zti18n.config.js';
+
+  const configFilePath = path.join(cwdPath, configFileName);
+
+  // 读取 zti18n-ast.config.js 中设置的参数，然后并入 options
+  if (fs.existsSync(configFilePath)) {
+    let configurationFile = {};
+    try {
+      configurationFile = require(configFilePath);
+    } catch (err) {
+      log.error(`请检查 ${configFileName} 配置文件是否正确\n`);
+    }
+
+    Object.assign(options, configurationFile);
+  } else {
+    log.error(`配置文件 ${configFileName} 不存在\n`);
+  }
+
+  if (!Object.keys(programOption).length) {
+    return options;
+  }
+
+  // 处理命令行参数
+  programParameter.forEach((k) => {
+    const value = programOption[k];
+    if (value) {
+      if (k === 'exclude' && typeof value === 'string') {
+        options[k] = value.split(',');
+      } else {
+        options[k] = value;
+      }
+    }
+  });
+
+  return options;
+};

package/zti18n-cli/src/utils/reactOptions.js

@@ -0,0 +1,73 @@
+// default options
+module.exports = {
+  // source path, <string array>
+  // e.g. ['src']
+  entry: ['src'],
+
+  // exclude pattern, <string array>
+  // e.g. ['**/dist/**', '**/*.config.js', '**/*.data.js']
+  exclude: [],
+
+  // output path, <string array>
+  // e.g. ['dist']
+  output: ['src'], // default i18n in place
+
+  // auto translate flag, <boolean>
+  // e.g. true
+  disableAutoTranslate: true,
+
+  // only extract locales, not touch source code, <boolean>
+  // e.g. true
+  extractOnly: false,
+
+  // translator, <null | string>
+  // null: default google translator
+  // e.g. ../translate/google.js
+  translator: null,
+
+  // ignored components, <string array>
+  // e.g. ['EventTracker']
+  ignoreComponents: [],
+
+  // ignored methods, <string array>
+  // e.g. ['MirrorTrack']
+  ignoreMethods: [],
+
+  // XXX: json loose
+  // primaryRegx: /[\u4e00-\u9fa5]/,
+
+  // primary locale, <string>
+  // e.g. 'zh-CN'
+  primaryLocale: 'zh-CN',
+
+  // supported locales, <string array>
+  // e.g. ['zh-CN', 'en-US']
+  supportedLocales: ['zh-CN', 'en-US'],
+
+  // import codes, <string>
+  importCode: "import i18next from 'ztxkutils/dist/i18next';",
+
+  // i18n object, <string>
+  // e.g. 'intl'
+  i18nObject: 'i18next',
+
+  // i18n method, <string>
+  // e.g. 't'
+  i18nMethod: 't',
+
+  // prettier conf, <null | object>
+  // e.g. {}
+  prettier: {
+    singleQuote: true,
+    trailingComma: 'es5',
+    endOfLine: 'lf',
+  },
+
+  // i18n saving conf, <object>
+  // if localeConf.type !== 'file', localeConf.path is required
+  // e.g. { type: 'apollo', path: '../conf/ApolloConf.js', ... }
+  localeConf: {
+    type: 'file',
+    // others...
+  },
+};

package/zti18n-cli/src/utils/vueOptions.js

@@ -0,0 +1,69 @@
+// default options
+module.exports = {
+  // source path, <string array>
+  // e.g. ['src']
+  entry: ['src'],
+
+  // exclude pattern, <string array>
+  // e.g. ['**/dist/**', '**/*.config.js', '**/*.data.js']
+  exclude: [],
+
+  // output path, <string array>
+  // e.g. ['dist']
+  output: ['src'], // default i18n in place
+
+  // auto translate flag, <boolean>
+  // e.g. true
+  disableAutoTranslate: true,
+
+  // only extract locales, not touch source code, <boolean>
+  // e.g. true
+  extractOnly: false,
+
+  // translator, <null | string>
+  // null: default google translator
+  // e.g. ../translate/google.js
+  translator: null,
+
+  // ignored components, <string array>
+  // e.g. ['EventTracker']
+  ignoreComponents: [],
+
+  // ignored methods, <string array>
+  // e.g. ['MirrorTrack']
+  ignoreMethods: [],
+
+  // XXX: json loose
+  // primaryRegx: /[\u4e00-\u9fa5]/,
+
+  // primary locale, <string>
+  // e.g. 'zh-CN'
+  primaryLocale: 'zh-CN',
+
+  // supported locales, <string array>
+  // e.g. ['zh-CN', 'en-US']
+  supportedLocales: ['zh-CN', 'en-US'],
+
+  // import codes, <string>
+  importCode: "import { intl } from 'di18n-vue';",
+
+  // i18n object, <string>
+  // e.g. 'intl'
+  i18nObject: 'intl',
+
+  // i18n method, <string>
+  // e.g. '$t'
+  i18nMethod: '$t',
+
+  // prettier conf, <null | object>
+  // e.g. {}
+  prettier: null,
+
+  // i18n saving conf, <object>
+  // if localeConf.type !== 'file', localeConf.path is required
+  // e.g. { type: 'apollo', path: '../conf/ApolloConf.js', ... }
+  localeConf: {
+    type: 'file',
+    // others...
+  },
+};

package/zti18n-core/index.js

@@ -0,0 +1 @@
+module.exports = require('./src');

package/zti18n-core/src/index.js

@@ -0,0 +1,5 @@
+exports.transformReactIntlToReactIntlUniversal = require('./transform/transformReactIntlToReactIntlUniversal');
+exports.transformReactIntlUniveralToDi18n = require('./transform/transformReactIntlUniveralToDi18n');
+exports.transformZeroToDi18n = require('./transform/transformZeroToDi18n');
+exports.transformToDi18n = require('./transform/transformToDi18n');
+exports.googleTranslate = require('./translate/google');