@chaoswise/intl 1.2.0 → 1.2.1

package/bin/scripts/collect.js

@@ -7,12 +7,16 @@ const log = require('./util/log');
 const file = require('./util/file');
 const writeNewWordsFile = require('./util/writeNewWordsFile');
 const { readWordJson } = require('./util/getWord');
+const getGroupName = require('./util/getGroupName');
 
 const service = require('./service');
 
 async function collect() {
-  log.info('词条扫描中...')
+
+  log.info('工程扫描中...')
+
   const conf = getConf();
+  const groupName = getGroupName();
   const newWordsFileType = conf.newWordsFileType || 'excel';
 
   // 检查newWordsFileType
@@ -36,6 +40,8 @@ async function collect() {
 
   // 在国际化平台中获取所有已存在中文信息
   const res = await service.searchByZh(info.allWords);
+  // 在国际化平台记录特殊方法
+  await service.saveMethod({ groupName, specialMethod: info.specialMethod });
 
   if (res.code !== 10000) {
     log.error('请求数据出错:' + res.msg);
@@ -46,10 +52,13 @@ async function collect() {
 
   const replaceWords = {}; // { zh: id } 需要在代码中替换的词条id
   const newWords = {}; // { zh1: '待翻译', zh2: '请选择:中文1/中文2' }
+  const exist = {}; // 根据中文只查出一条数据的已有词条
   Object.entries(wordsMap).forEach(([word, value]) => {
     // 如果当前中文词条在平台中存在，且对应英文翻译有且只有一条，那么直接替换代码中的中文为当前id，否则生成临时key，让开发者手动确认
     if (value.length === 1) {
-      replaceWords[word] = value[0].key;
+      const { id, key, zh, en } = value[0];
+      replaceWords[word] = key;
+      exist[id] = { id, key, zh, en };
     } else {
       const id = uuidv4();
       replaceWords[word] = id;
@@ -65,11 +74,15 @@ async function collect() {
     }
   });
 
+
+  // 在国际化平台中保存所有已存在词条
+  await service.saveExist({groupName, exist});
+
   // 第二次遍历，传入replaceWords，对代码进行国际化通用API转化，把词条替换成数据库的id，或者脚本临时生成的uuid
   transformAst('collect', files, conf, replaceWords);
 
-  log.success('脚本执行成功');
-  log.success('自定义配置文件在项目根目录的.intlconfig.js中');
+  log.success('★★★ 脚本执行成功 ★★★');
+  log.info('国际化配置文件： .intlconfig.js，可根据需求自定义修改');
   // 本次扫描出新的待翻译词条，写入到newWords中
   if (Object.keys(newWords).length) {
     writeNewWordsFile(newWordsFileType, newWords);
@@ -79,7 +92,7 @@ async function collect() {
   if (warnLogs.length) {
     const fileName = `intl.logs.warn.${(new Date).toLocaleString().replace(/[\/ ]/g, '_')}.txt`;
     file.write(fileName, JSON.stringify(warnLogs, null, 2));
-    log.warnToLog(`警告日志文件:${fileName}`);
+    log.warn(`存在脚本无法处理的情况，具体查看 ${fileName} 手动处理`);
   }
 }
 

package/bin/scripts/conf/default.js

@@ -55,30 +55,30 @@ module.exports = function (excludes = []) {
       endOfLine: 'lf',
     },
 
-    // <Tag id={{ key: 'id' }} defaultMessage='中文' />
-    // intlTag 是 'Tag'
-    // intlTagIdPath 是 'id.key'
+    // <FormattedMessage id='id' defaultMessage='中文' />
+    // intlTag 是 'FormattedMessage'
+    // intlTagIdPath 是 'id'
     // intlTagDefaultWordPath 是 'defaultMessage'，并且如果不配置，默认是'defaultMessage'
-    intlTag: '',
-    intlTagIdPath: '',
-    intlTagDefaultWordPath: '',
+    intlTag: 'FormattedMessage',
+    intlTagIdPath: 'id',
+    intlTagDefaultWordPath: 'defaultMessage',
 
     // intl.formatMessage({
-    //   key: 'id',
+    //   id: 'id',
     //   defaultMessage: '默认值',
     // })
     // intlFunctionName 是 intl.formatMessage
-    // intlFunctionIdPath 是 '0.key'。 如果 配置成 'key' 也行，intlFunctionIdPath如果不以数字开头，会在前面加上'0.' 'key' 就会变成 '0.key'
+    // intlFunctionIdPath 是 '0.id'。 如果 配置成 'id' 也行，intlFunctionIdPath如果不以数字开头，会在前面加上'0.' 'id' 就会变成 '0.id'
     // intlFunctionDefaultWordPath 是 '0.defaultMessage',其他的说明同intlFunctionIdPath
-    intlFunctionName: '',
-    intlFunctionIdPath: '',
-    intlFunctionDefaultWordPath: '',
+    intlFunctionName: 'intl.formatMessage',
+    intlFunctionIdPath: 'id',
+    intlFunctionDefaultWordPath: 'defaultMessage',
 
     // 做过国际化的项目，中文config的路径。例如：'src/local/zh.json'
     localWordPath: '',
 
     // 配置 需要被脚本删除的依赖包的名字
-    removePkgName: [],
+    removePkgName: ['react-intl'],
 
     // 需要删除的函数和装饰器 的名称
     removeFunctionName: ['injectIntl'],
@@ -86,8 +86,8 @@ module.exports = function (excludes = []) {
     // package.json中项目名称的key
     groupNameKey: 'packageName',
 
-    // 特殊文件处理的正则  这里默认匹配router.config.js
-    specialFileReg: [/src\/config\/router\.config\.js/],
+    // 特殊文件处理数组的每一项为正则或者字符串  这里默认匹配router.config.js
+    specialFileReg: ['src/config/router.config.js'],
 
     // newWords文件的类型 json或者excel
     newWordsFileType: 'excel',

package/bin/scripts/conf/initConfig.js

@@ -10,7 +10,7 @@ module.exports = function initConfig() {
   const customConfig = getCustomConfig();
 
   if (customConfig) {
-    console.log(`${customConfigName}已存在，请手动删除本地已经有的配置文件再重新执行 npm run intl-init`);
+    log.error(`${customConfigName}已存在，请删除后重新执行`);
     return;
   }
 
@@ -33,5 +33,5 @@ module.exports = function initConfig() {
     prettier.format(code, { ...defaultConfig.prettier, parser: 'babel' })
   );
 
-  log.success(`初始化配置文件成功：.intlconfig.js`);
+  log.success(`★★★ 初始化配置文件成功：.intlconfig.js ★★★`);
 }

package/bin/scripts/service/index.js

@@ -3,7 +3,7 @@ const getConf = require('../conf');
 
 const conf = getConf();
 
-axios.defaults.baseURL = (conf.baseURL || '') + '/api/i18n/dictionary';
+axios.defaults.baseURL = (conf.baseURL || '') + '/api/i18n';
 
 axios.interceptors.response.use(
   function (response) {
@@ -20,10 +20,20 @@ axios.interceptors.response.use(
 
 // 在国际化平台中获取所有已存在中文信息
 exports.searchByZh = (zhs) => {
-  return axios.post('/searchByZh', zhs);
+  return axios.post('/dictionary/searchByZh', zhs);
 };
 
 // 根据词条id获取所有数据库词条信息
 exports.getJson = ({ groupName, downloadIds }) => {
-  return axios.post('/getJson', { groupName, downloadIds });
+  return axios.post('/dictionary/getJson', { groupName, downloadIds });
+};
+
+// 保存替换的特殊方法
+exports.saveMethod = (data) => {
+  return axios.post('/history/method/save', data);
+};
+
+// 保存已有词条
+exports.saveExist = (data) => {
+  return axios.post('/history/exist/save', data);
 };

package/bin/scripts/update.js

@@ -6,6 +6,7 @@ const log = require('./util/log');
 const file = require('./util/file');
 
 async function update() {
+  log.info('词条更新中...')
   const conf = getConf();
   const files = getTargetFiles(conf);
 
@@ -13,17 +14,17 @@ async function update() {
   const relationKey = file.readJson('relationKey.json') || {};
 
   const info = transformAst('update', files, conf, relationKey);
-  await downloadJson(info.downloadIds);
+  await downloadJson(info.downloadIds.filter(Boolean));
 
   const needDelete = Boolean(Object.keys(relationKey).length);
   if (needDelete) {
     file.delete('newWords.json');
     file.delete('relationKey.json');
 
-    log.success('newWords.json和relationKey.json 已删除');
+    // log.success('newWords.json和relationKey.json 已删除');
   }
 
-  log.success('脚本执行成功');
+  log.success('★★★ 脚本执行成功 ★★★');
 }
 
 // update();

package/bin/scripts/util/makeVisitorCollect.js

@@ -32,10 +32,7 @@ module.exports = function (
   { filePath, special },
 ) {
 
-  // jsx默认 defaultMessage
-  intlTagDefaultWordPath = intlTagDefaultWordPath || 'defaultMessage';
-
-  const { replaceWords, allWords, downloadIds } = returns;
+  const { replaceWords, allWords, downloadIds, specialMethod } = returns;
   const hacked = {};
 
   // 在没有replaceWords的情况下，不用log信息，这里统一处理
@@ -62,15 +59,17 @@ module.exports = function (
     return preFixPath + path;
   }
   // 插入注释
-  function insertFailCommon(node) {
+  function insertFailCommon(node, errorMsg) {
     const comment = node?.leadingComments?.value
-    if (comment && comment.trim() === commentStr) return;
-    t.addComment(node, 'leading', commentStr);
+    const errMsg = `${commentStr} ${errorMsg}`;
+    if (comment && comment.trim() === errMsg.trim()) return;
+    t.addComment(node, 'leading', errMsg);
   }
   // 在jsx中插入注释
-  function insertFailCommonInJsx(path) {
+  function insertFailCommonInJsx(path, errorMsg) {
     const comment = path?.node?.leadingComments?.value
-    if (comment && comment.trim() === commentStr) return;
+    const errMsg = `${commentStr} ${errorMsg}`;
+    if (comment && comment.trim() === errMsg.trim()) return;
     path.insertBefore(
       t.jsxExpressionContainer(
         {
@@ -78,7 +77,7 @@ module.exports = function (
           "innerComments": [
             {
               "type": "CommentBlock",
-              "value": commentStr
+              "value": errMsg
             }
           ]
         }
@@ -450,24 +449,43 @@ module.exports = function (
 
       let value = getWord(chaoswiseIntlId);
       if (!value) {
-        let defautValue = FormPath.getIn(chaoswiseIntlIdData, getFullPath(intlFunctionDefaultWordPath));
-        if (typeof defautValue === 'string') {
-          value = defautValue;
+        let defaultValue = FormPath.getIn(chaoswiseIntlIdData, getFullPath(intlFunctionDefaultWordPath));
+        if (typeof defaultValue === 'string' && defaultValue) {
+          value = defaultValue;
         } else {
-          if (intlFunctionIdPath && !chaoswiseIntlId) {
-            properLog.warn(`文件:${filePath} 替换的函数名intlFunctionName:${intlFunctionName} id路径intlFunctionIdPath:${intlFunctionIdPath} 未找到非空字符串`)
-          }
-          if (localWordPath && chaoswiseIntlId && !value) {
-            properLog.warn(`中文文件localWordPath:${localWordPath} 键:${chaoswiseIntlId} 未找到非空字符串`)
+          let errorMsg = '';
+
+          if (!intlFunctionIdPath) {
+            errorMsg = `intlFunctionIdPath未配置`;
+            properLog.warn(errorMsg);
+          } else {
+            if (!chaoswiseIntlId) {
+              errorMsg = `在 ${intlFunctionName}() 中未找到 ${intlFunctionIdPath} 对应的值`;
+              properLog.warn(`文件 ${filePath} 中，在 ${intlFunctionName}() 中未找到 ${intlFunctionIdPath} 对应的值`);
+            } else if(!localWordPath) {
+              // 中文json文件未配置
+              errorMsg = `国际化中文文件路径 localWordPath 未配置`;
+              properLog.warn(errorMsg);
+            } else {
+              // word找不到
+              errorMsg = `国际化中文文件 ${localWordPath} 未找到 ${chaoswiseIntlId} 对应的值`;
+              properLog.warn(errorMsg);
+            }
           }
-          if (intlFunctionDefaultWordPath) {
-            properLog.warn(`文件:${filePath} 替换的函数名intlFunctionName:${intlFunctionName} 默认中文路径intlFunctionDefaultWordPath:${intlFunctionDefaultWordPath} 未找到非空字符串`)
+          if (intlFunctionDefaultWordPath && !defaultValue) {
+            errorMsg = `在 ${intlFunctionName}() 中未找到 ${intlFunctionDefaultWordPath} 对应的值`;
+            properLog.warn(`文件 ${filePath} 中，在 ${intlFunctionName} 中未找到 ${intlFunctionDefaultWordPath} 对应的值`);
           }
-          insertFailCommon(node);
+          
+          insertFailCommon(node, errorMsg);
         }
       }
 
       if (value && isPrimary(value)) {
+        if (!specialMethod.includes(fnName)) {
+          specialMethod.push(fnName);
+        }
+        
         res.needReplace = true;
         res.value = value;
       }
@@ -591,29 +609,42 @@ module.exports = function (
           if (typeof defaultValue === 'string') {
             word = defaultValue;
           } else {
+            let errorMsg = '';
             if (!intlTagIdPath) {
-              properLog.warn(`intlTagIdPath未配置`);
+              errorMsg = `intlTagIdPath未配置`;
+              properLog.warn(errorMsg);
             } else {
               if (!id) {
-                properLog.warn(`文件:${filePath} id路径intlTagIdPath:${intlTagIdPath} 未找到非空字符串`);
+                errorMsg = `文件 ${filePath} 中，在<${intlTag} /> 中未找到 ${intlTagIdPath} 对应的值`;
+                properLog.warn(`在<${intlTag} /> 中未找到 ${intlTagIdPath} 对应的值`);
+              } else if(!localWordPath) {
+                // 中文json文件未配置
+                errorMsg = `国际化中文文件路径 localWordPath 未配置`;
+                properLog.warn(errorMsg);
               } else {
                 // word找不到
-                localWordPath && properLog.warn(`中文文件localWordPath:${localWordPath} 键:${id} 未找到非空字符串`);
+                errorMsg = `国际化中文文件 ${localWordPath} 未找到 ${id} 对应的值`;
+                properLog.warn(errorMsg);
               }
             }
-            if (defaultValue === false) {
-              properLog.warn(`文件:${filePath} 替换的标签intlTag:${intlTag} 默认中文路径intlTagDefaultWordPath:${intlTagDefaultWordPath} 未找到非空字符串`);
+            if (intlTagDefaultWordPath && defaultValue === false) {
+              errorMsg = `在<${intlTag} /> 中未找到 ${intlTagDefaultWordPath} 对应的值`;
+              properLog.warn(`文件 ${filePath} 在 <${intlTag} /> 中未找到 ${intlTagDefaultWordPath} 对应的值`);
             }
 
             if (['JSXFragment', 'JSXElement'].includes(parentNodeType)) {
-              insertFailCommonInJsx(path);
+              insertFailCommonInJsx(path, errorMsg);
             } else {
-              insertFailCommon(node);
+              insertFailCommon(node, errorMsg);
             }
 
           }
         }
         if (word && isPrimary(word)) {
+          if (!specialMethod.includes(jsxName)) {
+            specialMethod.push(jsxName);
+          }
+
           // 替换国际化标签，<FormatMessage id='zhongwenid' defaultMessage="中文" />  换成 {intl.get(id).d('中文')}
           let res = makeReplace(word);
 

package/bin/scripts/util/makeVisitorUpdate.js

@@ -100,7 +100,7 @@ module.exports = function f(
       (node.callee.type === 'MemberExpression' &&
         node.callee.object.name === i18nObject &&
         node.callee.property.name === i18nMethod) ||
-      (node.callee.type === 'Identifier' && node.callee.name === i18nMethod)
+      (!i18nObject && node.callee.type === 'Identifier' && node.callee.name === i18nMethod)
     ) {
       // 收集现有的 key
       const args = node.arguments;

package/bin/scripts/util/transformAst.js

@@ -81,6 +81,7 @@ module.exports = function (type, files = [], conf = {}, replaceWords) {
 
   const allWords = []; // 收集到的所有词条
   const downloadIds = []; // 需要从平台下载的词条id
+  const specialMethod = []; // 替换的国际化特殊方法
 
   // babel配置
   const transformOptions = {
@@ -113,7 +114,15 @@ module.exports = function (type, files = [], conf = {}, replaceWords) {
   files.forEach((file) => {
     const { filePath } = file;
 
-    if (specialFileReg.some(reg => reg.test(filePath))) {
+    if (
+      specialFileReg.some(item => {
+        if (typeof item === 'string') {
+          return item === filePath;
+        } else {
+          return item.test(filePath);
+        }
+      })
+    ) {
       file.special = true;
     }
     const isTSX = ['.ts', '.tsx'].includes(path.extname(filePath));
@@ -122,6 +131,7 @@ module.exports = function (type, files = [], conf = {}, replaceWords) {
       allWords,
       replaceWords: replaceWords || {},
       downloadIds,
+      specialMethod,
       hasImport: false, // 是否已经引入通用国际化API，import {init} from ...;
       hasTouch: false, // 是否存在需要替换的词条
     };
@@ -183,5 +193,6 @@ module.exports = function (type, files = [], conf = {}, replaceWords) {
   return {
     allWords,
     downloadIds,
+    specialMethod,
   };
 };

package/bin/scripts/util/writeNewWordsFile.js

@@ -26,5 +26,5 @@ module.exports = async function writeNewWordsFile(type, newWords) {
     file.writeXlsx(fileName, { Sheet1: [...oldNewWords, ...newWordsArr ] });
   }
 
-  log.success(`需要翻译的文件在项目根目录的${fileName}中`);
+  log.info(`待翻译词条请查看： ${fileName}中`);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chaoswise/intl",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "author": "cloudwiser",
   "description": "intl",
   "main": "lib/index.js",
@@ -83,5 +83,5 @@
     "react-dom": "^16.13.1"
   },
   "license": "MIT",
-  "gitHead": "e56a7289b5085c5d38813e85776dbd5f789606b0"
+  "gitHead": "e90f035c659bef6d8cfe7ae08cfbc6117f8b5a79"
 }