td-octopus 0.0.18 → 0.0.21

package/README.md

@@ -49,7 +49,8 @@ copyright 2022 同盾
   "importI18N": "import I18N from 'src/utils/I18N';",
   "include": [], // 需要翻译的目录&也可以命令行输入参数
   "exclude": [], // 过滤目录&文件
-  "reservedKey": ["template", "case"] // js关键词以及I18N内置方法不能作为目录名，会统一添加td作为前缀
+  "reservedKey": ["template", "case"], // js关键词以及I18N内置方法不能作为目录名，会统一添加td作为前缀
+  "tabSize": number // 如果I18N.template内部有多个变量时，用于空格锁进的个数，默认为4
 }
 ```
 

package/package.json

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

package/src/back/index.js

@@ -3,7 +3,7 @@
  * @Author: 郑泳健
  * @Date: 2022-06-01 13:56:18
  * @LastEditors: 郑泳健
- * @LastEditTime: 2023-01-11 17:23:29
+ * @LastEditTime: 2023-01-18 15:25:47
  */
 const path = require('path')
 const fs = require('fs')
@@ -120,7 +120,7 @@ function getValueByI18N(filePath, str, flatObj) {
         }
 
         const matchList = matchs.reduce((total, item) => {
-            if (!item.includes('I18N.template') && !item.includes('I18N.setLang')) {
+            if (!['I18N.template', 'I18N.setLang'].includes(item)) {
                 const text = flatObj[item.replace('I18N.', '')]
                 if (text) {
                     total.push({ key: item, value: text })
@@ -152,6 +152,8 @@ function getNeedRewriteFiles(filePath, flatObj) {
         if (Array.isArray(matchList) && matchList.length) {
             sum += matchList.length;
             matchList.forEach(({ key, value }) => {
+                // 兼容翻译的文案中有\n \r \t 这种情况
+                value = value.replace(/\n/g, "\\n").replace(/\r/g, "\\r").replace(/\t/g, "\\t");
                 const replaceVal = value && value.includes("'") ? '"' + value + '"' : "'" + value + "'"
                 code = code.replace(key, replaceVal)
             })

package/src/export/index.js

@@ -3,7 +3,7 @@
  * @Author: 郑泳健
  * @Date: 2022-06-01 13:56:18
  * @LastEditors: 郑泳健
- * @LastEditTime: 2022-12-28 15:47:31
+ * @LastEditTime: 2023-06-12 11:33:34
  */
 const {
     syncFiles,
@@ -25,6 +25,7 @@ function doExport() {
     (async () => {
         const otpConfig = getProjectConfig()
         const distLang = otpConfig && otpConfig.distLangs
+        const baiduApiKey = otpConfig && otpConfig.baiduApiKey
 
         if (!Array.isArray(distLang)) {
             console.log(`请配置${OCTOPUS_CONFIG_FILE}里面的distLangs`)
@@ -42,7 +43,7 @@ function doExport() {
             const langFlat = flatObject(currentLangMap);
             spinner.start('正在同步文件的key')
             // 删除掉多余的key，增加新的key，同时提取没有翻译过的key的列表
-            const { fileKeyValueList, addList, allList } = await getAdjustLangObjAndAddList(lang, langFlat, zhCNflat);
+            const { fileKeyValueList, addList, allList } = await getAdjustLangObjAndAddList(lang, langFlat, zhCNflat, baiduApiKey, spinner);
             spinner.succeed('同步文件的key成功')
             // 重写文件
             rewriteFiles(fileKeyValueList, lang);

package/src/extract/findChineseText.js

@@ -83,10 +83,12 @@ function visit(node) {
           const start = node.getStart();
           const end = node.getEnd();
           const range = { start, end };
+          const { line } = ast.getLineAndCharacterOfPosition(start)
           matches.push({
             range,
             text,
-            isString: true
+            isString: true,
+            line
           });
         }
         break;
@@ -104,11 +106,12 @@ function visit(node) {
               const start = child.getStart();
               const end = child.getEnd();
               const range = { start, end };
-
+              const { line } = ast.getLineAndCharacterOfPosition(start)
               matches.push({
                 range,
                 text: text.trim(),
-                isString: false
+                isString: false,
+                line
               });
             }
           }
@@ -123,10 +126,12 @@ function visit(node) {
           const start = node.getStart();
           const end = node.getEnd();
           const range = { start, end };
+          const { line } = ast.getLineAndCharacterOfPosition(start)
           matches.push({
             range,
             text: code.slice(start + 1, end - 1),
-            isString: true
+            isString: true,
+            line
           });
         }
         break;
@@ -139,10 +144,12 @@ function visit(node) {
           const start = node.getStart();
           const end = node.getEnd();
           const range = { start, end };
+          const { line } = ast.getLineAndCharacterOfPosition(start)
           matches.push({
             range,
             text: code.slice(start + 1, end - 1),
-            isString: true
+            isString: true,
+            line
           });
         }
         break;
@@ -157,19 +164,20 @@ function visit(node) {
           const start = node.getStart();
           const end = node.getEnd();
           const range = { start, end };
-
+          const { line } = ast.getLineAndCharacterOfPosition(start)
           matches.push({
             range,
             text: text.trim(),
-            isString: false
+            isString: false,
+            line
           });
         }
       }
     }
 
-    ts.forEachChild(node, visit);
+    ts.forEachChild(node, (node) => visit(node, ast));
   }
-  ts.forEachChild(ast, visit);
+  ts.forEachChild(ast, (node) => visit(node, ast));
   // 过滤相同的选项
   return matches.reduce((total, item) => {
     const bool = total.some(i => _.isEqual(i, item));

package/src/extract/replace.js

@@ -156,6 +156,29 @@ function createImportI18N(filePath) {
   }
 }
 
+/**
+ * 判断I18N.template所在行前面有多少个空格/tab，以及类型是tab还是空格
+ * @param {*} code
+ * @param {*} text
+ * @returns { tabSize: number, isSpace: bool } || null
+ */
+function getLineTableSize(code, line){
+    try{
+        const list = code ? code.split('\n') : []
+        const str = list[line];
+        // 用于判断是空格还是space
+        const match = str.match(/^[ \t]+/);
+        // 判断空格/tab的个数
+        let spaces = str.match(/^\s+/);
+        return {
+          tabSize: spaces[0].length,
+          isSpace: match[0].startsWith(" ")
+        }
+    }catch(e) {
+      return null
+    }
+}
+
 /**
  * 更新文件
  * @param filePath 当前文件路径
@@ -193,7 +216,16 @@ function replaceAndUpdate(filePath, arg, val, validateDuplicate, needWrite = tru
         const kvPair = varInStr.map((str, index) => {
           return `val${index + 1}: ${str.replace(/^\${([^\}]+)\}$/, '$1')}`;
         });
-        finalReplaceVal = `I18N.template(${val}, { ${kvPair.join(',\n')} })`;
+
+        // 多个变量情况下格式化
+        const { tabSize, isSpace } = getLineTableSize(code, arg.line) || {}
+        if(kvPair.length > 1 && !isNaN(tabSize)) {
+            const space = '\n' + (isSpace ? " " : "\t").repeat(tabSize + (isSpace ? (CONFIG.tabSize || 4) : 1))
+            const startSpace = '\n' + (isSpace ? " " : "\t").repeat(tabSize)
+            finalReplaceVal = `I18N.template(${val}, {${space}${kvPair.join(`,${space}`)}${startSpace}})`;
+        }else{
+            finalReplaceVal = `I18N.template(${val}, { ${kvPair.join(',\n')} })`;
+        }
 
         varInStr.forEach((str, index) => {
           finalReplaceText = finalReplaceText.replace(str, `{val${index + 1}}`);

package/src/translate/index.js

@@ -3,7 +3,7 @@
  * @Author: 郑泳健
  * @Date: 2022-06-01 13:56:18
  * @LastEditors: 郑泳健
- * @LastEditTime: 2022-12-28 15:47:31
+ * @LastEditTime: 2023-06-12 11:33:51
  */
 const {
     syncFiles,
@@ -25,6 +25,7 @@ function translate() {
     (async () => {
         const otpConfig = getProjectConfig()
         const distLang = otpConfig && otpConfig.distLangs
+        const baiduApiKey = otpConfig && otpConfig.baiduApiKey
 
         if (!Array.isArray(distLang)) {
             console.log(`请配置${OCTOPUS_CONFIG_FILE}里面的distLangs`)
@@ -42,7 +43,7 @@ function translate() {
             const langFlat = flatObject(currentLangMap);
             spinner.start('正在同步文件的key')
             // 删除掉多余的key，增加新的key，同时提取没有翻译过的key的列表
-            const { fileKeyValueList, addList } = await getAdjustLangObjAndAddList(lang, langFlat, zhCNflat);
+            const { fileKeyValueList, addList } = await getAdjustLangObjAndAddList(lang, langFlat, zhCNflat, baiduApiKey, spinner);
             spinner.succeed('同步文件的key成功')
             // 重写文件
             rewriteFiles(fileKeyValueList, lang);

package/src/utils/syncLang.js

@@ -1,5 +1,6 @@
 const fs = require('fs')
 const { otpPath } = require('./translate');
+const { getLangData } = require('../extract/getLangData')
 
 module.exports = (lang) => {
   try {
@@ -8,9 +9,7 @@ module.exports = (lang) => {
     list.forEach((i) => {
         const suffixCheck = ['.js', '.ts', '.jsx', 'tsx'].some(it => i.endsWith(it));
         if (suffixCheck && !['index.js', 'index.jsx', 'index.ts', 'index.tsx'].includes(i)) {
-            const str = fs.readFileSync(`${otpPath}/${lang}/${i}`, 'utf-8');
-            const replaceStr = str.replace(/export default|\;/g, '');
-            const json = eval("(" + replaceStr + ")");
+            const json = getLangData(`${otpPath}/${lang}/${i}`)
             const key = i.split('.')[0];
 
             langMap[key] = json;

package/src/utils/translate.js

@@ -3,7 +3,7 @@
  * @Author: 郑泳健
  * @Date: 2022-06-02 10:09:01
  * @LastEditors: 郑泳健
- * @LastEditTime: 2023-01-04 14:54:06
+ * @LastEditTime: 2023-06-12 11:32:52
  */
 const fs = require('fs');
 const path = require('path');
@@ -130,12 +130,12 @@ function getFileKeyValueList(adjustLangObj) {
  * @param {*} zhCNObj zh-CN 的key/value
  * @returns { fileKeyValueList: [{fileName: a, value: {"b.c": xx}}], addList: [["a.b.c": "dd"]] }
  */
-async function getAdjustLangObjAndAddList(lang, langObj = {}, zhCNObj = {}) {
+async function getAdjustLangObjAndAddList(lang, langObj = {}, zhCNObj = {}, baiduApiKey, spinner) {
     const langObjKeys = Object.keys(langObj);
     // 调整后的语言包key/value
     const adjustLangObj = {};
     // 需要新增的key/value
-    const needAddList = [];
+    let needAddList = [];
     // 全量的的key/value
     const allList = [];
     // 循环zh-CN的key，得到当前语言包的key
@@ -154,8 +154,10 @@ async function getAdjustLangObjAndAddList(lang, langObj = {}, zhCNObj = {}) {
 
         adjustLangObj[key] = langObj[key] || zhCNObj[key];
     }
-
-    const addList = await combinText(needAddList, lang);
+    if(baiduApiKey) {
+      spinner.text = `当前配置了百度翻译，预计翻译时间需要${(needAddList.length / 60)?.toFixed(2)}分钟，如果等不及，请先去掉百度翻译配置`
+    }
+    const addList = await combinText(needAddList, lang, spinner);
 
     return {
         fileKeyValueList: getFileKeyValueList(adjustLangObj),
@@ -167,9 +169,9 @@ async function getAdjustLangObjAndAddList(lang, langObj = {}, zhCNObj = {}) {
 /**
  * 合并需要翻译的中文，因为百度翻译限制一次性中文只能有3000字
  * 因为百度免费翻译有时候会抽风，会导致翻译结果出错，为了减少没被翻译的，所以现在设置一次性翻译200字
- * @param {*} needAddList 
+ * @param {*} needAddList
  */
-async function combinText(needAddList, lang) {
+async function combinText(needAddList, lang, spinner) {
     const otpConfig = getProjectConfig()
     const { baiduApiKey, baiduLangMap } = otpConfig || {}
     const { appId, appKey } = baiduApiKey || {}
@@ -183,11 +185,10 @@ async function combinText(needAddList, lang) {
     if (!appId || !appKey || !toLang) {
         return needAddList;
     }
-
     // 分组
     const groupList = groupByLength(needAddList, 200)
     // 分组翻译结果
-    const transformResultList = await getTransformResultList(groupList, appId, appKey, 'zh', toLang)
+    const transformResultList = await getTransformResultList(groupList, appId, appKey, 'zh', toLang, spinner)
 
     return needAddList.map((i, index) => {
         i[2] = transformResultList[index];
@@ -197,28 +198,30 @@ async function combinText(needAddList, lang) {
 
 /**
  * 对分组的结果进行翻译
- * @param {*} groupList 
- * @param {*} appId 
- * @param {*} appKey 
- * @param {*} fromLang 
- * @param {*} toLang 
- * @returns 
+ * @param {*} groupList
+ * @param {*} appId
+ * @param {*} appKey
+ * @param {*} fromLang
+ * @param {*} toLang
+ * @returns
  */
-async function getTransformResultList(groupList, appId, appKey, fromLang, toLang) {
-    let translatList = []
+async function getTransformResultList(groupList, appId, appKey, fromLang, toLang, spinner) {
+    let translatList = [];
+    let num = 1
     for (const i of groupList) {
+        spinner.text = `翻译进度${num}/${groupList.length}`
         const baiduResult = await baiduTranslation(appId, appKey, fromLang, toLang, JSON.stringify(i))
-
+        num++;
         try {
-            const splitBaiduResult = baiduResult?.[0]
-            const transResultList = JSON.parse(splitBaiduResult);
-            // 这里是判断百度翻译返回的长度是不是和传入的一样
-            const reduceNum = i.length - transResultList.length;
-            translatList = [...translatList, ...transResultList].concat(Array(reduceNum).fill(''))
+            const res = baiduResult?.[0]
+            // const transResultList = JSON.parse(splitBaiduResult);
+            // // 这里是判断百度翻译返回的长度是不是和传入的一样
+            // const reduceNum = i.length - transResultList.length;
+            translatList = [...translatList, res]
 
         } catch (e) {
             console.log(`百度翻译出现部分失败, 失败原因: ${e.message}`)
-            translatList = translatList.concat(Array(i.length).fill(''))
+            translatList = translatList.concat('')
         }
     }
 
@@ -229,32 +232,32 @@ async function getTransformResultList(groupList, appId, appKey, fromLang, toLang
  * 对数组进行分组
  * @param {*} groupList 原数组
  * @param {*} max 最大多少字
- * @returns 
+ * @returns
  */
 function groupByLength(groupList, max) {
     const list = [[]]
     let str = ''
     // 变成${max}个字符一组的数组，用于一次百度翻译
     groupList.forEach((it) => {
-        let [, text] = it;
-
-        if ((str + text).length < max) {
-            list[list.length - 1] = Array.isArray(list[list.length - 1]) ? [...list[list.length - 1], text] : [text]
-            str = str + text
-        } else {
-            list.push([text])
-            str = ''
-        }
+        const [, text] = it;
+        list.push(text)
+        // if ((str + text).length < max) {
+        //     list[list.length - 1] = Array.isArray(list[list.length - 1]) ? [...list[list.length - 1], text] : [text]
+        //     str = str + text
+        // } else {
+        //     list.push([text])
+        //     str = ''
+        // }
     })
     return list
 }
 
 /**
  * 百度翻译
- * @param {*} from 
- * @param {*} to 
- * @param {*} text 
- * @returns 
+ * @param {*} from
+ * @param {*} to
+ * @param {*} text
+ * @returns
  */
 async function baiduTranslation(appId, appKey, from, to, text) {
     return new Promise((resolve, reject) => {
@@ -263,15 +266,15 @@ async function baiduTranslation(appId, appKey, from, to, text) {
             return baiduTranslate(appId, appKey, to, from)(text)
                 .then(data => {
                     if (data && data.trans_result) {
-                        const result = data.trans_result.map(item => item.dst) || [];
+                        const result = data.trans_result.map(item => item.dst) || '';
                         resolve(result);
                     } else {
-                        resolve('[]')
+                        resolve('')
                     }
                 }).catch(err => {
-                    reject('[]');
+                    reject('');
                 });
-        }, 1000)
+        }, 1100)
     })
 }