td-octopus 0.0.17 → 0.0.20

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.17",
+  "version": "0.0.20",
   "description": "I18N tool",
   "author": "Anthony Li",
   "bin": {

package/src/back/index.js

@@ -3,191 +3,198 @@
  * @Author: 郑泳健
  * @Date: 2022-06-01 13:56:18
  * @LastEditors: 郑泳健
- * @LastEditTime: 2023-01-11 15:14:00
+ * @LastEditTime: 2023-01-18 15:25:47
  */
 const path = require('path')
 const fs = require('fs')
 const ts = require('typescript');
+const shell = require('shelljs');
 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.
+const I18N_REGEX = /I18N(\.[a-zA-Z0-9_]+)+/g
 
-  // 匹配I18N.template()里面的内容
-  const TEMPLATE_INNER_REGEX =  /I18N\.template\(([\s\S]*?})\)/g
+// 匹配I18N.template()里面的内容
+const TEMPLATE_INNER_REGEX = /I18N\.template\(([\s\S]*?})\)/g
 
-  // 匹配{}之间的内容
-  const JSON_KEY_REGEX = /{([\s\S]*?)}/g
+// 匹配{}之间的内容
+const JSON_KEY_REGEX = /{([\s\S]*?)}/g
 
-  // 匹配{}之间的value
-  const JSON_VALYR_REGEX = /(?<=: )[^,}]+/g
+// 匹配{}之间的value
+const JSON_VALYR_REGEX = /(?<=: )[^,}]+/g
 
-  /**
-   * 获取需要back的所有文件目录
-   * @returns
-   */
-  function getFilePaths() {
+/**
+ * 获取需要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)
+        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;
+        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);
+        return (isFile(file) && flag);
     });
-  }
-
-  /**
-   * 获取I18N.template里面{}每个value对应的value
-   * @param {*} str {val1: h, val2: m, val3: s}
-   * @returns [h, m, s]
-   */
-  function getTemplateValue(str) {
+}
+
+/**
+ * 获取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;
+        const values = str.match(JSON_VALYR_REGEX)
+        return values;
     } catch (e) {
-      throw e;
+        throw e;
     }
-  }
-
-  /**
-   * 如果文件中存在I18N.template，先转换一下
-   * @param {*} code
-   * @param {*} flatObj
-   * @returns
-   */
-  function transformTemplate(filePath, code, flatObj) {
+}
+
+/**
+ * 如果文件中存在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
+        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 + '`')
+                }
             })
-
-            code = code.replace(i, '`' + matchText + '`')
-          }
-        })
-      }
-      return { code, sum }
+        }
+        return { code, sum }
     } catch (e) {
-      throw e;
+        throw e;
     }
-  }
-
-  /**
-   * 获取I18N.xx.xx所对应的中文
-   * @param {*} filePath 文件路径
-   * @param {*} str
-   * @param {*} flatObj
-   * @returns { key: I18N.xx, value: '测试' }
-   */
-  function getValueByI18N(filePath, str, flatObj) {
+}
+
+/**
+ * 获取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)} 未发现有对应的中文文案，请检查`);
-          }
+        const matchs = str.match(I18N_REGEX);
+        if (!Array.isArray(matchs) || !matchs.length) {
+            return [];
         }
-        return total
-      }, [])
 
-      return matchList
+        const matchList = matchs.reduce((total, item) => {
+            if (!['I18N.template', 'I18N.setLang'].includes(item)) {
+                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;
+        throw e;
     }
-  }
-
-  /**
-   * 获取需要被重写的文件
-   * @param {*} filePath 文件路径
-   * @param {*} flatObj 所有key对应的中文
-   * @returns
-   */
-  function getNeedRewriteFiles(filePath, flatObj) {
+}
+
+/**
+ * 获取需要被重写的文件
+ * @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 }) => {
-          const replaceVal = value && value.includes("'") ? '"' + value + '"'  : "'" + value + "'"
-          code = code.replace(key, replaceVal)
-        })
-      }
+        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 }) => {
+                // 兼容翻译的文案中有\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)
+            })
+        }
 
-      return {
-        filePath,
-        code,
-        sum
-      }
+        return {
+            filePath,
+            code,
+            sum
+        }
     } catch (e) {
-      throw e;
+        throw e;
     }
-  }
+}
 
-  // 同步不同的语言包
-  function back() {
+// 同步不同的语言包
+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)} 文件回滚完毕`);
-        }
-      })
+        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)} 文件回滚完毕`);
+            }
+        })
+
+        console.log('正在删除zh-CN文件夹下的文件');
+        shell.rm('-rf', path.resolve(process.cwd(), './.octopus/zh-CN/*'));
+        console.log('已成功删除zh-CN文件夹下的文件');
     } catch (e) {
-      failInfo(e.message)
+        failInfo(e.message)
     }
-  }
+}
 
-  module.exports = {
+module.exports = {
     back
-  }
+}

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/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;