td-octopus 0.0.13 → 0.0.15

package/README.md

@@ -15,6 +15,7 @@ npm install td-octopus -g
 otp <cmd> [-args]
 
 命令：
+  otp export                      export 导出所有文件,并生成excel文件
   otp extract [dirPath] [prefix]  extract [dirPath] [prefix]
                                   一键批量替换指定文件夹下的所有文案
   otp import [langs]              import [langs]

package/cmds/export.js

@@ -0,0 +1,9 @@
+const { doExport } = require('../src/export');
+
+exports.command = 'export';
+
+exports.describe = 'export 导出所有文件,并生成excel文件';
+
+exports.handler = () => {
+  doExport()
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "td-octopus",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "I18N tool",
   "author": "Anthony Li",
   "bin": {

package/src/back/index.js

@@ -0,0 +1,192 @@
+/*
+ * @Description: 将国际化转换回去
+ * @Author: 郑泳健
+ * @Date: 2022-06-01 13:56:18
+ * @LastEditors: 郑泳健
+ * @LastEditTime: 2023-01-11 11:07:41
+ */
+const path = require('path')
+const fs = require('fs')
+const ts = require('typescript');
+const { getSpecifiedFiles, isFile } = require('../utils/file')
+const syncLang = require('../utils/syncLang')
+const { flatObject } = require('../utils/translate');
+const { failInfo, highlightText } = require('../utils/colors');
+const { getProjectConfig } = require('../utils/index')
+
+  // 匹配I18N.
+  const I18N_REGEX = /I18N(\.[a-zA-Z0-9_]+)+/g
+
+  // 匹配I18N.template()里面的内容
+  const TEMPLATE_INNER_REGEX =  /I18N\.template\(([\s\S]*?})\)/g
+
+  // 匹配{}之间的内容
+  const JSON_KEY_REGEX = /{([\s\S]*?)}/g
+
+  // 匹配{}之间的value
+  const JSON_VALYR_REGEX = /(?<=: )[^,}]+/g
+
+  /**
+   * 获取需要back的所有文件目录
+   * @returns
+   */
+  function getFilePaths() {
+    const CONFIG = getProjectConfig()
+    const dirArr = CONFIG.include && CONFIG.include.length > 0 ? CONFIG.include : ['./'];
+    let filePaths = []
+
+    dirArr.forEach(i => {
+      const dirPath = path.resolve(process.cwd(), i);
+      const files = getSpecifiedFiles(dirPath)
+      filePaths = filePaths.concat(files)
+    })
+
+    return filePaths.filter(file => {
+      let flag = false;
+      for (let index = 0; index < CONFIG.fileSuffix.length; index++) {
+        const element = CONFIG.fileSuffix[index];
+        flag = file.endsWith(element);
+        if (flag) {
+          break;
+        }
+      }
+      return (isFile(file) && flag);
+    });
+  }
+
+  /**
+   * 获取I18N.template里面{}每个value对应的value
+   * @param {*} str {val1: h, val2: m, val3: s}
+   * @returns [h, m, s]
+   */
+  function getTemplateValue(str) {
+    try {
+      const values = str.match(JSON_VALYR_REGEX)
+      return values;
+    } catch (e) {
+      throw e;
+    }
+  }
+
+  /**
+   * 如果文件中存在I18N.template，先转换一下
+   * @param {*} code
+   * @param {*} flatObj
+   * @returns
+   */
+  function transformTemplate(filePath, code, flatObj) {
+    try {
+      const templates = code.match(TEMPLATE_INNER_REGEX) || [];
+      let sum = Array.isArray(templates) ? templates.length : 0;
+      if (Array.isArray(templates) && templates.length) {
+        templates.forEach(i => {
+          const [jsonStr] = i ? i.match(JSON_KEY_REGEX) : []
+          const keys = getTemplateValue(jsonStr)
+          let matchList = getValueByI18N(filePath, i, flatObj) || [];
+          matchText = matchList[0] && matchList[0]['value']
+          if (matchText) {
+            matchText = matchText.replace(/{(val\d+)}/g, (match, group, index) => {
+              if(!keys[0]) {
+                throw new Error(`${filePath}文件中的 ${highlightText(i)} 转换有问题，请手动检查`)
+              }
+              const res = '${' + keys[0].trim() + '}'
+              keys.splice(0, 1)
+              return res
+            })
+
+            code = code.replace(i, '`' + matchText + '`')
+          }
+        })
+      }
+      return { code, sum }
+    } catch (e) {
+      throw e;
+    }
+  }
+
+  /**
+   * 获取I18N.xx.xx所对应的中文
+   * @param {*} filePath 文件路径
+   * @param {*} str
+   * @param {*} flatObj
+   * @returns { key: I18N.xx, value: '测试' }
+   */
+  function getValueByI18N(filePath, str, flatObj) {
+    try {
+      const matchs = str.match(I18N_REGEX);
+      if (!Array.isArray(matchs) || !matchs.length) {
+        return [];
+      }
+
+      const matchList = matchs.reduce((total, item) => {
+        if (!item.includes('I18N.template') && !item.includes('I18N.setLang')) {
+          const text = flatObj[item.replace('I18N.', '')]
+          if (text) {
+            total.push({ key: item, value: text })
+          } else {
+            throw new Error(`${filePath}文件中的 ${highlightText(item)} 未发现有对应的中文文案，请检查`);
+          }
+        }
+        return total
+      }, [])
+
+      return matchList
+    } catch (e) {
+      throw e;
+    }
+  }
+
+  /**
+   * 获取需要被重写的文件
+   * @param {*} filePath 文件路径
+   * @param {*} flatObj 所有key对应的中文
+   * @returns
+   */
+  function getNeedRewriteFiles(filePath, flatObj) {
+    try {
+      const str = fs.readFileSync(filePath, 'utf-8');
+      let { code, sum } = transformTemplate(filePath, str, flatObj)
+
+      let matchList = getValueByI18N(filePath, code, flatObj) || [];
+      if (Array.isArray(matchList) && matchList.length) {
+        sum += matchList.length;
+        matchList.forEach(({ key, value }) => {
+          code = code.replace(key, "'" + value + "'")
+        })
+      }
+
+      return {
+        filePath,
+        code,
+        sum
+      }
+    } catch (e) {
+      throw e;
+    }
+  }
+
+  // 同步不同的语言包
+  function back() {
+    try {
+      const filePaths = getFilePaths()
+      const zhCN = syncLang('zh-CN');
+      const zhCNFlat = flatObject(zhCN);
+      /** 获取需要被重写的文件 */
+      const needRewriteFiles = filePaths.map(i => getNeedRewriteFiles(i, zhCNFlat))
+
+      needRewriteFiles.forEach(({ filePath, code, sum }) => {
+        if (sum > 0) {
+          console.log(`正在对 ${highlightText(filePath)} 文件进行回滚操作, 共计${highlightText(sum)}处`);
+
+          fs.writeFileSync(filePath, code)
+          console.log(`${highlightText(filePath)} 文件回滚完毕`);
+        }
+      })
+    } catch (e) {
+      failInfo(e.message)
+    }
+  }
+
+  module.exports = {
+    back
+  }

package/src/export/index.js

@@ -0,0 +1,61 @@
+/*
+ * @Description: 翻译
+ * @Author: 郑泳健
+ * @Date: 2022-06-01 13:56:18
+ * @LastEditors: 郑泳健
+ * @LastEditTime: 2022-12-28 15:47:31
+ */
+const {
+    syncFiles,
+    otpPath,
+    flatObject,
+    getAdjustLangObjAndAddList,
+    generateExcel,
+    rewriteFiles,
+} = require('../utils/translate');
+const syncLang = require('../utils/syncLang')
+const { getProjectConfig } = require('../utils/index')
+const ora = require('ora');
+const { OCTOPUS_CONFIG_FILE } = require('../utils/const')
+
+const spinner = ora('开始export');
+
+// 同步不同的语言包
+function doExport() {
+    (async () => {
+        const otpConfig = getProjectConfig()
+        const distLang = otpConfig && otpConfig.distLangs
+
+        if (!Array.isArray(distLang)) {
+            console.log(`请配置${OCTOPUS_CONFIG_FILE}里面的distLangs`)
+            return;
+        }
+        spinner.start('正在同步文件')
+        await syncFiles(distLang);
+        spinner.succeed('同步文件成功')
+
+        const zhCN = syncLang('zh-CN');
+        const zhCNflat = flatObject(zhCN);
+
+        for (const lang of distLang) {
+            const currentLangMap = syncLang(lang);
+            const langFlat = flatObject(currentLangMap);
+            spinner.start('正在同步文件的key')
+            // 删除掉多余的key，增加新的key，同时提取没有翻译过的key的列表
+            const { fileKeyValueList, addList, allList } = await getAdjustLangObjAndAddList(lang, langFlat, zhCNflat);
+            spinner.succeed('同步文件的key成功')
+            // 重写文件
+            rewriteFiles(fileKeyValueList, lang);
+            spinner.start(`正在生成${lang} excel`)
+            // 生成excel
+            generateExcel(allList, otpPath + '/' + lang, lang);
+            spinner.succeed(`生成${lang} excel成功`)
+        }
+
+        spinner.stop('translate成功')
+    })()
+}
+
+module.exports = {
+    doExport
+}

package/src/extract/findChineseText.js

@@ -164,15 +164,20 @@ function visit(node) {
             isString: false
           });
         }
-        break;
       }
     }
 
     ts.forEachChild(node, visit);
   }
   ts.forEachChild(ast, visit);
-
-  return matches;
+  // 过滤相同的选项
+  return matches.reduce((total, item) => {
+    const bool = total.some(i => _.isEqual(i, item));
+    if(!bool) {
+      total.push(item)
+    }
+    return total;
+  }, []);
 }
 
 /**

package/src/utils/translate.js

@@ -136,6 +136,8 @@ async function getAdjustLangObjAndAddList(lang, langObj = {}, zhCNObj = {}) {
     const adjustLangObj = {};
     // 需要新增的key/value
     const needAddList = [];
+    // 全量的的key/value
+    const allList = [];
     // 循环zh-CN的key，得到当前语言包的key
     for (let key in zhCNObj) {
         // 4种情况下，需要将key放入到翻译对象里面去
@@ -147,6 +149,9 @@ async function getAdjustLangObjAndAddList(lang, langObj = {}, zhCNObj = {}) {
             needAddList.push([key, zhCNObj[key], '', '']);
         }
 
+        // allList.push([key, zhCNObj[key], '', _.upperFirst(langObj[key])]);
+        allList.push([key, zhCNObj[key], '', langObj[key]]);
+
         adjustLangObj[key] = langObj[key] || zhCNObj[key];
     }
 
@@ -154,7 +159,8 @@ async function getAdjustLangObjAndAddList(lang, langObj = {}, zhCNObj = {}) {
 
     return {
         fileKeyValueList: getFileKeyValueList(adjustLangObj),
-        addList
+        addList,
+        allList
     };
 }