td-web-cli 0.1.12 → 0.1.14

package/README.md

@@ -1,6 +1,6 @@
 # 项目名称
 
-一个基于 Node.js 和 TypeScript 的高效 CLI 工具，用于提升工作效率。
+一个基于 node.js 和 typeScript 的高效 cli 工具，用于提升工作效率。
 
 ---
 
@@ -18,11 +18,11 @@
 
 ## 环境要求
 
-- Node.js >= 20.x（推荐使用 22.x 或更高版本）
+- node.js >= 20.x（推荐使用 22.x 或更高版本）
 - npm >= 10.x
-- TypeScript >= 5.x
+- typeScript >= 5.x
 
-> **注意**：部分依赖可能要求 Node.js 20 及以上版本，请根据实际情况调整。
+> **注意**：部分依赖可能要求 node.js 20 及以上版本，请根据实际情况调整。
 
 ---
 
@@ -47,8 +47,8 @@ npm install
 
 ### 代码结构
 
-- `src/` - TypeScript 源代码目录
-- `dist/` - 编译后的 JavaScript 输出目录
+- `src/` - typeScript 源代码目录
+- `dist/` - 编译后的 javaScript 输出目录
 - `release.js` - 发布脚本（可直接运行或编译后运行）
 
 ### 运行开发环境
@@ -59,7 +59,7 @@ npm link
 td-web-cli  # 确保本机未全局安装该工具
 ```
 
-通过 `npm link`，本地调试 CLI 命令 `td-web-cli`。
+通过 `npm link`，本地调试 cli 命令 `td-web-cli`。
 
 ---
 
@@ -67,7 +67,7 @@ td-web-cli  # 确保本机未全局安装该工具
 
 ### 命令行执行
 
-执行 CLI 工具：
+执行 cli 工具：
 
 ```bash
 td-web-cli
@@ -75,13 +75,13 @@ td-web-cli
 
 ### 功能说明
 
-- 将 Excel 表格转换为对应的 JSON 文件，简化数据处理流程。
+- 多语言 excel 转 json 工具。[功能说明](./docs/i18n/excel2json.md)
 
 ---
 
 ## 构建
 
-使用 TypeScript 编译项目：
+使用 typeScript 编译项目：
 
 ```bash
 npm run build
@@ -105,7 +105,7 @@ npm run release
 - 依赖安装
 - 项目构建
 - 发布到 npm
-- 提交并推送 Git 代码
+- 提交并推送 git 代码
 
 ---
 
@@ -113,17 +113,17 @@ npm run release
 
 ```
 .
-├── src/                  # TypeScript 源代码
+├── src/                  # typeScript 源代码
 │   └── index.ts          # 入口文件
 ├── dist/                 # 编译输出目录
 ├── release.js            # 发布脚本
 ├── setting.json          # 配置文件
 ├── package.json          # 项目配置
-├── tsconfig.json         # TypeScript 配置
+├── tsconfig.json         # typeScript 配置
 ├── README.md             # 项目说明文件
-├── .gitignore            # Git 忽略文件
-├── .prettierignore       # Prettier 忽略文件
-├── .prettierrc           # Prettier 配置文件
+├── .gitignore            # git 忽略文件
+├── .prettierignore       # prettier 忽略文件
+├── .prettierrc           # prettier 配置文件
 └── package-lock.json     # 依赖锁定文件
 ```
 

package/dist/modules/i18n/excel2json/index.d.ts

@@ -3,6 +3,7 @@ import { Command } from 'commander';
  * excel转json功能主函数
  * 读取用户输入的excel路径，解析内容，根据配置生成多语言json文件
  * 并对配置文件中所有语言对应的词条进行语言检测
+ * 如果有相同的json key，则在key前面加上6位编码，保证唯一性
  * @param program Commander命令行实例
  */
 export declare function excel2json(program: Command): Promise<void>;

package/dist/modules/i18n/excel2json/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/i18n/excel2json/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAyLpC;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,OAAO,EAAE,OAAO,iBA8ThD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/i18n/excel2json/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA0LpC;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,OAAO,EAAE,OAAO,iBAoVhD"}

package/dist/modules/i18n/excel2json/index.js

@@ -3,7 +3,7 @@ import XLSX from 'xlsx';
 import fs from 'fs';
 import { fileURLToPath } from 'url';
 import path from 'path';
-import { getTimestamp, logger, loggerError, normalizeError, languageToolCheck, getLanguageTool, } from '../../../utils/index.js';
+import { getTimestamp, logger, loggerError, normalizeError, languageToolCheck, getLanguageTool, formatKey, } from '../../../utils/index.js';
 // 获取当前文件目录
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -138,6 +138,7 @@ function parseCheckResultPerEntry(checkResult, texts) {
  * excel转json功能主函数
  * 读取用户输入的excel路径，解析内容，根据配置生成多语言json文件
  * 并对配置文件中所有语言对应的词条进行语言检测
+ * 如果有相同的json key，则在key前面加上6位编码，保证唯一性
  * @param program Commander命令行实例
  */
 export async function excel2json(program) {
@@ -242,20 +243,26 @@ export async function excel2json(program) {
         }
         const defaultColNum = Number(defaultColIndex);
         // 初始化所有语言词条对象（包括默认语言）
+        // 用于存储最终的翻译key-value对，key可能会被重新编码以避免重复
         const langTranslations = {};
         Object.values(colIndexToLangKey).forEach((langKey) => {
             langTranslations[langKey] = {};
         });
         logger.info('开始解析数据行', true);
+        // 记录所有出现过的key，检测重复，格式：langKey => Set of keys
+        const langKeySets = {};
+        Object.keys(langTranslations).forEach((langKey) => {
+            langKeySets[langKey] = new Set();
+        });
         // 遍历数据行，提取所有语言词条
         // key统一用默认语言列的值，其他语言对应的列为翻译内容
-        const langKeysMap = {}; // 语言key => 词条数组
+        const langKeysMap = {}; // 语言key => 词条数组（用于检测）
         Object.keys(langTranslations).forEach((langKey) => {
             langKeysMap[langKey] = [];
         });
         for (let i = 1; i < rows.length; i++) {
             const row = rows[i];
-            const keyCell = row[defaultColNum];
+            let keyCell = row[defaultColNum];
             if (keyCell === undefined || keyCell === null || keyCell === '')
                 continue;
             let key = String(keyCell).trim();
@@ -263,6 +270,11 @@ export async function excel2json(program) {
             // 跳过空key，避免写入无效数据
             if (key.length === 0)
                 continue;
+            // 判断默认语言key是否重复，若重复则重新编码
+            if (langKeySets[defaultLang].has(key)) {
+                key = formatKey(key);
+            }
+            langKeySets[defaultLang].add(key);
             // 默认语言的词条即key本身
             langTranslations[defaultLang][key] = key;
             langKeysMap[defaultLang].push(key);
@@ -274,7 +286,13 @@ export async function excel2json(program) {
                 const valCell = row[colIdx];
                 if (valCell !== undefined && valCell !== null && valCell !== '') {
                     const valStr = String(valCell);
-                    langTranslations[langKey][key] = valStr;
+                    // 判断该语言的key是否重复，若重复则重新编码key
+                    let finalKey = key;
+                    if (langKeySets[langKey].has(finalKey)) {
+                        finalKey = formatKey(finalKey);
+                    }
+                    langKeySets[langKey].add(finalKey);
+                    langTranslations[langKey][finalKey] = valStr;
                     langKeysMap[langKey].push(valStr);
                 }
                 else {

package/dist/utils/index.d.ts

@@ -147,5 +147,18 @@ export interface CheckResult {
  * @throws 接口请求失败时抛出错误，错误信息包含接口地址和异常堆栈
  */
 export declare function languageToolCheck(text: string, language?: string): Promise<CheckResult>;
+/**
+ * 对字符串重新编码，字符串前面加上6位的特殊编码（格式：字母#三个字母#）
+ * 例如：a#BCD#yourString
+ * @param key 需要进行重新编码的字符串
+ * @returns 带有特殊编码前缀的字符串
+ */
+export declare function formatKey(key: string): string;
+/**
+ * 对重新编码的字符串进行解码，去除前面6位特殊编码部分
+ * @param key 需要解码的字符串
+ * @returns 去除特殊编码前缀后的字符串
+ */
+export declare function decodeKey(key: string): string;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAMA;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAmBrC;AAED;;GAEG;AACH,KAAK,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAE1C;;GAEG;AACH,UAAU,aAAa;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC;IAE3C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AA8ED;;;GAGG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,iBAAiB,CAAyB;IAClD,OAAO,CAAC,GAAG,CAAS;IAEpB;;;OAGG;gBACS,OAAO,CAAC,EAAE,aAAa;IAUnC;;;;;OAKG;IACH,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,UAAQ,GAAG,IAAI;IAsClE;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,UAAQ,GAAG,IAAI;IAIlD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,UAAQ,GAAG,IAAI;IAIlD;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,UAAQ,GAAG,IAAI;CAGpD;AAED;;;GAGG;AACH,eAAO,MAAM,MAAM,QAEjB,CAAC;AAEH;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE;IAAE,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;CAAE,EAChE,MAAM,SAAc,EACpB,YAAY,UAAQ,GACnB,IAAI,CAEN;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,OAAO,KAAG,KAW7C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB,EAAE,CAAC;AAEJ;;;;;GAKG;AACH,wBAAsB,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC,CAS7D;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE;QAEJ,EAAE,EAAE,MAAM,CAAC;QACX,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,KAAK,EAAE,CAAC;IACjB,QAAQ,EAAE;QAER,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,QAAQ,EAAE;QAER,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,MAAM,EACZ,QAAQ,SAAU,GACjB,OAAO,CAAC,WAAW,CAAC,CAetB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAMA;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAmBrC;AAED;;GAEG;AACH,KAAK,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAE1C;;GAEG;AACH,UAAU,aAAa;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC;IAE3C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AA8ED;;;GAGG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,iBAAiB,CAAyB;IAClD,OAAO,CAAC,GAAG,CAAS;IAEpB;;;OAGG;gBACS,OAAO,CAAC,EAAE,aAAa;IAUnC;;;;;OAKG;IACH,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,UAAQ,GAAG,IAAI;IAsClE;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,UAAQ,GAAG,IAAI;IAIlD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,UAAQ,GAAG,IAAI;IAIlD;;;;OAIG;IACH,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,UAAQ,GAAG,IAAI;CAGpD;AAED;;;GAGG;AACH,eAAO,MAAM,MAAM,QAEjB,CAAC;AAEH;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE;IAAE,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;CAAE,EAChE,MAAM,SAAc,EACpB,YAAY,UAAQ,GACnB,IAAI,CAEN;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,OAAO,KAAG,KAW7C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB,EAAE,CAAC;AAEJ;;;;;GAKG;AACH,wBAAsB,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC,CAS7D;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE;QAEJ,EAAE,EAAE,MAAM,CAAC;QACX,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,KAAK,EAAE,CAAC;IACjB,QAAQ,EAAE;QAER,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,QAAQ,EAAE;QAER,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,MAAM,EACZ,QAAQ,SAAU,GACjB,OAAO,CAAC,WAAW,CAAC,CAetB;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAiB7C;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAW7C"}

package/dist/utils/index.js

@@ -253,3 +253,38 @@ export async function languageToolCheck(text, language = 'en-US') {
         throw new Error(`${url}接口报错：${normalizeError(error).stack}`);
     }
 }
+/**
+ * 对字符串重新编码，字符串前面加上6位的特殊编码（格式：字母#三个字母#）
+ * 例如：a#BCD#yourString
+ * @param key 需要进行重新编码的字符串
+ * @returns 带有特殊编码前缀的字符串
+ */
+export function formatKey(key) {
+    const letters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
+    const codeTemplate = '{0}#{1}{2}{3}#';
+    // 先解码，防止重复添加前缀
+    const decodedKey = decodeKey(key);
+    // 随机选取4个字母替换模板中的占位符
+    const getRandomLetter = () => letters[Math.floor(Math.random() * letters.length)];
+    const code = codeTemplate
+        .replace('{0}', getRandomLetter())
+        .replace('{1}', getRandomLetter())
+        .replace('{2}', getRandomLetter())
+        .replace('{3}', getRandomLetter());
+    return code + decodedKey;
+}
+/**
+ * 对重新编码的字符串进行解码，去除前面6位特殊编码部分
+ * @param key 需要解码的字符串
+ * @returns 去除特殊编码前缀后的字符串
+ */
+export function decodeKey(key) {
+    if (!key) {
+        return '';
+    }
+    // 匹配开头格式：字母#三个字母#
+    // ^ 开头， [a-zA-Z] 一个字母， \# 字符 #， [a-zA-Z]{3} 三个字母， \# 字符 #
+    const prefixRegex = /^[a-zA-Z]\#[a-zA-Z]{3}\#/;
+    // 去除前缀
+    return key.replace(prefixRegex, '');
+}

package/docs/i18n/excel2json.md

@@ -0,0 +1,67 @@
+# 多语言 excel 转 json 工具
+
+该工具基于配置文件，实现将多语言 excel 文件转换为对应的 json 翻译文件，并支持语言检测和重复 key 处理，方便多语言项目的词条管理与质量控制。
+
+---
+
+## 主要功能
+
+1. **配置文件读取与解析**
+   - 从本地 `setting.json` 文件读取国际化配置，包括默认语言、语言映射和语言长代码。
+
+2. **excel 表头语言列匹配**
+   - 根据配置自动识别 excel 表头中的语言列，支持大小写不敏感匹配和语言名称模糊匹配。
+
+3. **excel 文件读取与数据解析**
+   - 读取用户指定路径的 excel 文件，提取第一个工作表的内容。
+   - 解析表头和数据行，提取多语言词条。
+
+4. **重复 json key 处理**
+   - 对默认语言列的 key 进行去重处理，若存在重复，则在 key 前添加随机生成的6位编码前缀，确保 json key 唯一。
+   - 其他语言的 key 也进行同样处理，避免冲突。
+
+5. **批量语言检测**
+   - 将所有语言词条拼接成字符串，一次性调用语言检测接口，减少请求次数，提高检测效率。
+   - 解析检测结果，拆分到每条词条对应的错误信息。
+
+6. **生成多语言 json 文件**
+   - 为每个语言生成对应的 json 翻译文件，默认语言文件不生成。
+
+7. **生成语言检测结果 excel 文件**
+   - 生成包含所有语言检测错误信息的 excel 文件，方便查看和修正。
+
+8. **命令行交互与日志记录**
+   - 通过命令行交互输入 excel 文件路径。
+   - 详细日志记录执行过程、错误和警告，便于排查问题。
+
+---
+
+## 使用说明
+
+1. 准备好符合格式的 excel 文件，第一行为表头，包含语言列（如 `en`, `zh-CN` 等）。
+2. 配置好 `setting.json`，包含国际化相关配置。
+3. 运行工具，输入 excel 文件路径。
+4. 程序将自动解析 excel，生成多语言 json 文件和语言检测结果 excel。
+5. 结果文件输出在 excel 文件所在目录的 `lang_时间戳` 文件夹中。
+
+---
+
+## 代码结构简述
+
+- `formatKey` / `decodeKey`：处理重复 key，添加或去除随机编码前缀。
+- `loadConfig`：读取并校验配置文件。
+- `matchLangKey`：匹配 excel 表头语言列。
+- `batchCheckTexts` / `parseCheckResultPerEntry`：批量调用语言检测并解析结果。
+- `excel2json`：主函数，完成 excel 读取、解析、语言检测、文件生成等流程。
+
+---
+
+## 备注
+
+- 默认语言的 json 文件不会生成，默认语言词条作为 key 使用。
+- 语言检测依赖在线服务，若获取语言列表失败则使用本地配置。
+- 重复 key 处理确保生成的 json 文件中不会有冲突的键名。
+
+---
+
+欢迎反馈和贡献！

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "td-web-cli",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "description": "A CLI tool for efficiency",
   "main": "dist/index.js",
   "type": "module",
@@ -9,7 +9,8 @@
   },
   "files": [
     "dist",
-    "setting.json"
+    "setting.json",
+    "docs/**/*.md"
   ],
   "scripts": {
     "build": "tsc",