@zzclub/z-cli 0.5.4 → 0.6.1

package/CHANGELOG.md

@@ -1,6 +1,30 @@
 # Changelog
 
 
+## v0.6.1
+
+[compare changes](https://github.com/aatrooox/z-cli/compare/v0.6.0...v0.6.1)
+
+### 📖 Documentation
+
+- 更新文档说明 ([259328c](https://github.com/aatrooox/z-cli/commit/259328c))
+
+### ❤️ Contributors
+
+- Aatrox <gnakzz@qq.com>
+
+## v0.6.0
+
+[compare changes](https://github.com/aatrooox/z-cli/compare/v0.5.4...v0.6.0)
+
+### 🚀 Enhancements
+
+- 改造i18n，使其能够直接提取中文 ([bb05eac](https://github.com/aatrooox/z-cli/commit/bb05eac))
+
+### ❤️ Contributors
+
+- Aatrox <gnakzz@qq.com>
+
 ## v0.5.4
 
 [compare changes](https://github.com/aatrooox/z-cli/compare/v0.5.3...v0.5.4)

package/README.md

@@ -31,12 +31,95 @@ npm i -g @zzclub/z-cli
 
 ## i18n 规则说明
 
-1. 只提取 `.vue` 文件
-2. 匹配规则，如：$t('i18n.module-name.placeholder.month') => `/\$t\(['"]i18n\.([^'"]+)['"]\)/g`
-   1. 默认忽略 common。如 $t('i18n.common.placeholder.month') 会被忽略
-   2. 以逗号分割，第一位 i18n 是固定的。 第二位为 文件名。 最后一位为属性key。 第二至最后之间，为 object 的 key
-   3. 最后的文件名称为 `module-name.js` 内容为 `{ placeholder: { month: "month"}} `
-   4. 保存位置如果没传。就会保存在 `.vue` 同级目录下
+### 文件
+
+只提取 `.vue` 文件
+
+### `$t`解析及生成规则
+
+提取正则： `/\$t\(['"]i18n\.([^'"]+)['"]\)/g`
+
+举例：
+
+```js
+$t('i18n.module-name.placeholder.month')
+```
+
+- module-name 会被解析为文件名称 => `module-name.js`
+- 后面的内容会被解析为对象的属性 => `{ placeholder: { month: "month"}} `
+- 保存位置如果没传。就会保存在 `.vue` 同级目录下
+- 默认忽略 module-name 为 `common` => `$t('i18n.common.xxx')`
+
+### 中文注释规范及提取规则
+
+```vue
+<template>
+  <!--i18n addTitle=你好呀 a=不错   b=叭叭叭 c=哈哈哈  -->
+  <CommonEditForm :page-type="pageType" :title-config="titleConfig" :custom-components-code="$t('i18n.monthlyForecast.pageTitle.addTitle')" :is-out="2">
+    <div>{{ $t('i18n.monthlyForecast.form.a') }}</div>
+    <div>{{ $t('i18n.monthlyForecast.form.b') }}</div>
+    <!--i18n select=真棒 -->
+    <div>{{ $t('i18n.monthlyForecast.placeholder.select') }}</div>
+  </CommonEditForm>
+
+</template>
+
+<!-- js 区域 -->
+<script>
+   import {formatDate} from "@/common/utils"
+   import CommonEditForm from "@/pages/ifpf/costForecast/monthlyForecast/views/common-edit-form.vue"
+
+   export default {
+       name: 'ifpfExchangeRateMaintainAdd',
+       components:{
+           CommonEditForm,
+       },
+       data() {
+           return {
+               pageType: 'edit',
+               titleConfig: {
+                   title: this.$t('i18n.monthlyForecast.pageTitle.addTitle'),//测试
+                   icon: this.$t('i18n.monthlyForecast.pageTitle.icon'), // 图标
+                   date: formatDate.formatDateOnly(new Date()),
+                   info: this.$t('i18n.monthlyForecast.pageTitle.addInfo')//你好
+               },
+           };
+       }
+   };
+</script>
+
+```
+
+解析后：
+
+```js
+export default {
+  pageTitle: {
+    addTitle: "测试",
+    icon: "图标",
+    addInfo: "你好"
+  },
+  form: {
+    a: "不错",
+    b: "叭叭叭"
+  },
+  placeholder: {
+    select: "真棒"
+  }
+}
+```
+- template 中的注释，比如以 `<!--i18n` 开头
+- template 中的中文内容以 `空格` 分割，以 `=` 号拼接key=value, 如 `addTitle=你好呀 a=不错`
+- template 中支持多个注释信息
+- template 中的key=value和$t中最后一个key对应
+- js 中支持两种注释信息提取
+  - `$t()` 后紧跟 `//` , `//`后的中文内容都被视为默认值
+  - `$t()` 后存在 `,` 、`空格` 这两种符号，然后再跟 `//`, `//`后的中文内容都被视为默认值
+
+**解析完成后，自行把文件挪到到 zh-CN 文件夹下**
+
+**然后使用 `translate` 命令进行中译英**
+
 
 ## 翻译功能配置说明
 ### 初始化翻译平台appId和key
@@ -131,8 +214,10 @@ zz translate -d ./demo
     ├── test2.js
     └── test3.js
 
-
 ```
+
+**翻译时可能存在翻译失败的情况，重新运行  translate 命令即可**
+
 ## 压缩图片
 
 使用help命令查看所有支持的功能

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zzclub/z-cli",
-  "version": "0.5.4",
+  "version": "0.6.1",
   "description": "all-in-one 工具箱，专为提升日常及工作效率而生",
   "main": "src/index.js",
   "type": "module",

package/src/command/i18n.js

@@ -68,14 +68,14 @@ const i18nCmd = {
           for (const file of filePaths) {
             const content = fs.readFileSync(file, 'utf-8');
             const fileName = path.basename(file, '.vue');
-            const i18nKeys = extractI18nKeys(content);
+            const { keys: i18nKeys, commentMap } = extractI18nKeys(content);
             
             if (i18nKeys.length > 0) {
               file_spinner.succeed(`从 ${chalk.yellow(fileName)} 中提取了 ${chalk.green(i18nKeys.length)} 个国际化键值`);
               
               // 处理每个提取的键值
               for (const key of i18nKeys) {
-                await processI18nKey(key, i18nMap);
+                await processI18nKey(key, i18nMap, commentMap);
               }
             }
           }
@@ -109,7 +109,7 @@ const i18nCmd = {
       
       const content = fs.readFileSync(filePath, 'utf-8');
       const fileName = path.basename(filePath, '.vue');
-      const i18nKeys = extractI18nKeys(content);
+      const { keys: i18nKeys, commentMap } = extractI18nKeys(content);
       
       if (i18nKeys.length > 0) {
         const i18nMap = {};
@@ -118,7 +118,7 @@ const i18nCmd = {
         
         // 处理每个提取的键值
         for (const key of i18nKeys) {
-          await processI18nKey(key, i18nMap);
+          await processI18nKey(key, i18nMap, commentMap);
         }
         
         // 如果没有指定输出目录，使用当前处理的文件所在目录
@@ -163,25 +163,81 @@ function getAllVueFiles(dirPath, filePaths) {
  * 从 Vue 文件内容中提取国际化键值
  * @param {string} content 文件内容
  * @param {string} ignorePrefix 要忽略的前缀
- * @returns {Array} 提取的键值数组
+ * @returns {Object} 提取的键值数组和注释映射
  */
 function extractI18nKeys(content, ignorePrefix = "common") {
+  // 原有正则表达式，提取键名
   const regex = /\$t\(['"]i18n\.([^'"]+)['"]\)/g;
+  // 提取键名和注释中的中文
+  const regexWithComment = /\$t\(['"]i18n\.([^'"]+)['"]\)[\s,]*\/\/\s*([\u4e00-\u9fa5].*?)(?=\n|$)/g;
+  // 新增：提取HTML注释中的i18n信息
+  const regexHtmlComment = /<!--i18n\s+(.*?)-->/g;
+  
   const keys = [];
+  const commentMap = {}; // 存储键名和对应的注释内容
   let match;
   
+  // 提取HTML注释中的i18n信息
+  while ((match = regexHtmlComment.exec(content)) !== null) {
+    const commentContent = match[1].trim();
+    // 解析注释内容中的多个键值对
+    const keyValuePairs = commentContent.split(/\s+/);
+    
+    for (const pair of keyValuePairs) {
+      const [key, value] = pair.split('=');
+      if (key && value) {
+        // 将简短键（如addTitle）与完整键（如monthlyForecast.pageTitle.addTitle）进行匹配
+        // 这里我们需要在后续处理中找到对应的完整键
+        commentMap[key] = value;
+      }
+    }
+  }
+  
+  // 提取带注释的国际化键
+  while ((match = regexWithComment.exec(content)) !== null) {
+    const key = match[1];
+    const comment = match[2].trim();
+    
+    // 如果设置了忽略前缀且键以该前缀开头，则跳过
+    if (ignorePrefix && key.startsWith(`${ignorePrefix}.`)) {
+      continue;
+    }
+    
+    keys.push(key);
+    // JS注释优先级高于HTML注释
+    commentMap[key] = comment;
+    
+    // 同时为简短键名存储注释
+    const shortKey = key.split('.').pop();
+    if (!commentMap[shortKey]) {
+      commentMap[shortKey] = comment;
+    }
+  }
+  
+  // 提取不带注释的国际化键
   while ((match = regex.exec(content)) !== null) {
     const key = match[1];
+    
     // 如果设置了忽略前缀且键以该前缀开头，则跳过
     if (ignorePrefix && key.startsWith(`${ignorePrefix}.`)) {
       continue;
     }
+    
     keys.push(key);
+    
+    // 检查是否有对应的HTML注释
+    const shortKey = key.split('.').pop();
+    if (commentMap[shortKey] && !commentMap[key]) {
+      commentMap[key] = commentMap[shortKey];
+    }
   }
   
-  return [...new Set(keys)]; // 去重
+  // 返回去重后的键名数组和注释映射
+  return {
+    keys: [...new Set(keys)],
+    commentMap
+  };
 }
-
 function unquoteKeys(json) {
   return json.replace(/"(\\[^]|[^\\"])*"\s*:?/g, function (match) {
     if (/:$/.test(match)) {
@@ -196,8 +252,9 @@ function unquoteKeys(json) {
  * 处理单个国际化键值
  * @param {string} key 键值
  * @param {Object} i18nMap 国际化映射对象
+ * @param {Object} commentMap 注释映射
  */
-async function processI18nKey(key, i18nMap) {
+async function processI18nKey(key, i18nMap, commentMap = {}) {
   // 解析键值 fee-forecast-maintain.placeholder.yearNum
   const parts = key.split('.');
   
@@ -223,8 +280,8 @@ async function processI18nKey(key, i18nMap) {
 
   // 设置最终的键值
   if (!current[lastKey]) {
-    // 使用键名作为默认值
-    current[lastKey] = lastKey;
+    // 如果有注释，使用注释作为值，否则使用键名
+    current[lastKey] = commentMap[key] || lastKey;
   }
 }