@kezh/my-custom-js-converter 1.4.0 → 1.5.0

package/.claude/plan.md

@@ -1,53 +1,65 @@
-# 实现 @ 路径别名支持
+# 日志优化方案
 
-## 目标
-在 `config.js` 中添加开关配置，支持 `@` 写法：`const mod = require('@/util/@3.0.0/mod.js')`，其中 `@` 代表项目根目录（baseDir）。
+## 现状问题
 
-## 修改文件
+1. **格式不统一** — 有的用 `=>` 分隔，有的直接打印数组，风格混乱
+2. **缺少层级结构** — 所有日志平铺输出，无法区分步骤/阶段
+3. **信息不完整** — `scanf dirs => ` 和数组分两行打印，`the map is not found!` 没有上下文
+4. **缺少状态标识** — 没有成功/失败/警告等视觉区分
+5. **中英混杂** — `路径不存在[...]忽略` vs `scanf dirs` vs `the map is not found!`
+6. **缺少汇总** — 处理完成后没有统计摘要
 
-### 1. `src/config/main_config.ts` — 添加配置项
-在 `EncodeConfig` 中添加 `useAlias: boolean` 开关（默认 `false`）。
+## 优化方案
 
-### 2. `src/config/index.ts` — 添加默认值
-在 `defConfig.encode` 中添加 `useAlias: false`。
+### 1. 新建 `src/util/logger.ts` — 统一日志工具
 
-### 3. `src/scanf/index.ts` — `scanfRequieMod` 支持 @ 路径
-当 `modPath` 以 `@/` 或 `@\\` 开头时，将 `@` 替换为 `baseDir`（项目根目录），然后再进行路径解析。
-
-修改逻辑：
 ```typescript
-export function scanfRequieMod(baseDir: string, modPath: string): string {
-  // 支持 @ 别名：@/xxx => baseDir/xxx
-  if (modPath.startsWith("@/") || modPath.startsWith("@\\")) {
-    modPath = modPath.replace(/^@[/\\]/, baseDir + path.sep);
-  }
-  // ... 原有逻辑不变
+export function createLogger(scope: string) {
+  return {
+    info(msg: string)  { console.log(`[${scope}] ✔ ${msg}`); },
+    warn(msg: string)  { console.log(`[${scope}] ⚠ ${msg}`); },
+    error(msg: string) { console.log(`[${scope}] ✖ ${msg}`); },
+    step(title: string) {
+      console.log(`\n[${scope}] ── ${title} ${'─'.repeat(Math.max(0, 50 - title.length))}`);
+    },
+  };
 }
 ```
 
-### 4. `src/util/ast.ts` — `importMods` 支持 @ 路径生成
-decode 时生成 require 语句，如果 `config.encode.useAlias` 为 `true`，则生成 `@/...` 格式而非相对路径。
+简洁、无外部依赖、终端友好。
 
-需要将 `config` 传入 `importMods` 函数，或在函数内读取全局 config。
+### 2. 日志对照表
 
-修改逻辑：
-```typescript
-// 当 useAlias 开启时，使用 @ 别名路径替代相对路径
-if (useAlias) {
-  const aliasPath = srcPath.replace(baseDir, "").replace(/\\/g, "/");
-  requireFrom = "@" + aliasPath;
-} else {
-  requireFrom = relative(outDir, srcPath.replace(/(index)?\.js$/, "")).replace(/[\\]+/g, "/");
-}
-```
+| 原始 | 优化后 |
+|---|---|
+| `console.log("scanf dirs => ")` + `console.log(targetDirs)` | `logger.info('scanf dirs: ' + targetDirs.join(', '))` |
+| `console.log(\`scanf file => ${inPath}\`)` | `logger.info(\`scanf file: ${inPath}\`)` |
+| `console.log(\`output file => ${outPath}\`)` | `logger.info(\`output: ${outPath}\`)` |
+| `console.log(\`output => ${outPath}\`)` | `logger.info(\`output: ${outPath}\`)` |
+| `console.log(\`input map => ${inPath}\`)` | `logger.info(\`read map: ${inPath}\`)` |
+| `console.log("the map is not found!")` | `logger.warn('map file not found')` |
+| `console.log(\`output map => ${outPath}\`)` | `logger.info(\`write map: ${outPath}\`)` |
+| `console.log(\`not found entry => ${entry}\`)` | `logger.warn(\`entry not found: ${entry}\`)` |
+| `console.log(\`路径不存在[${dirPath}]忽略\`)` | `logger.warn(\`dir not found, skipping: ${dirPath}\`)` |
+| `console.log(\`ignore module => ${item.id.name}\`)` | `logger.info(\`ignore module: ${item.id.name}\`)` |
+
+### 3. 增加步骤分隔和汇总
+
+**encode** 流程增加：
+- 步骤标题：扫描目录 → 查找文件 → 编码处理
+- 汇总：处理文件数、方法总数、版本号
+
+**decode** 流程增加：
+- 步骤标题：扫描目录 → 查找文件 → 解码处理
+- 汇总：处理文件数
 
-### 5. `src/decode/index.ts` — 传递 config 给 importMods
-`importMods` 调用处需要传递 config 信息。
+### 4. 修改文件清单
 
-## 实现顺序
-1. 修改 `MainConfig` 添加 `useAlias` 字段
-2. 修改 `initConfig` 添加默认值
-3. 修改 `scanfRequieMod` 支持 `@` 路径解析
-4. 修改 `importMods` 支持 `@` 路径生成
-5. 修改 `decode/index.ts` 传递 config
-6. 编译验证
+| 文件 | 变更 |
+|---|---|
+| `src/util/logger.ts` | **新建** — 日志工具模块 |
+| `src/encode/index.ts` | 替换 4 处 console.log，增加步骤和汇总 |
+| `src/decode/index.ts` | 替换 4 处 console.log，增加步骤和汇总 |
+| `src/context/map_context.ts` | 替换 3 处 console.log |
+| `src/scanf/index.ts` | 替换 1 处 console.log |
+| `src/util/ast.ts` | 替换 1 处 console.log |

package/TASKS.md

@@ -1,36 +1,2 @@
 # 任务
-编写体验优化，当前编写导入模块仅支持`const mod = require('../../util/@3.0.0/mod.js');`，我希望能够在`config.js`配置中加入开关配置，支持@写法：`const mod = require('@/util/@3.0.0/mod.js');`
-
-# 实现方案
-
-在 `EncodeConfig` 中添加 `useAlias: boolean` 开关：
-- `useAlias: true` — encode 阶段解析 `@/` 路径别名（`@` 代表项目根目录），decode 阶段生成 `@/` 路径
-- `useAlias: false`（默认）— 使用传统的相对路径
-
-### 修改的文件
-
-| 文件 | 改动 |
-|------|------|
-| `src/config/main_config.ts` | `EncodeConfig` 添加 `useAlias` 字段 |
-| `src/config/index.ts` | 默认 `useAlias: false`；`__dirname` 不含 `node_modules` 时回退到 `process.cwd()`；尝试 `config.js` 和 `config.json` 两种配置文件 |
-| `src/scanf/index.ts` | `scanfRequieMod` 添加 `rootDir` 参数，支持 `@/` 路径解析 |
-| `src/util/ast.ts` | `getRequireModPaths` 传递 `rootDir`；`importMods` 根据 `useAlias` 生成 `@/` 或相对路径；修复相对路径缺少 `./` 前缀的问题 |
-| `src/util/parent_path.ts` | `getParentRootDir` 在 junction symlink 场景下回退到 `config.baseDir` |
-| `src/context/map_context.ts` | `buildMapContext` 根据 `useAlias` 条件传递 `rootDir` |
-| `src/decode/index.ts` | 传递 `config.encode.useAlias` 给 `importMods` |
-
-# 测试结果 ✅
-
-### useAlias: true
-- **Encode**: `@/src/util/index` 正确解析为绝对路径，方法正确内联并添加 `__modName` 后缀
-- **Decode**: 生成 `require("@/src/util")` 和 `require("@/src/helper")`，`__modName` 后缀正确移除
-
-### useAlias: false
-- **Encode**: 相对路径 `./util/index` 正常解析
-- **Decode**: 生成 `require("./util")` 和 `require("./helper")`，路径以 `./` 开头
-
-### 修复的问题
-1. `useAlias` 无效 — `scanfRequieMod` 缺少 `rootDir` 参数，`@` 路径无法解析
-2. `Error: src\@\util\index.js is not exists!` — junction symlink 导致 `__dirname` 不含 `node_modules`，`getParentRootDir()` 返回 undefined
-3. `require("util")` 缺少 `./` 前缀 — `path.relative()` 返回的路径不以 `./` 开头，Node.js 会当作 npm 包名
-4. 配置文件查找失败 — 只尝试 `config.js`，不尝试 `config.json`
+项目encode和decode输出日志可读性差，请帮我优化日志。

package/core/context/map_context.js

@@ -11,6 +11,8 @@ const ast_1 = require("../util/ast");
 const parent_path_1 = require("../util/parent_path");
 const config_1 = require("../config");
 const os_1 = require("os");
+const logger_1 = require("../util/logger");
+const logger = (0, logger_1.createLogger)("map");
 class MapContext {
     constructor(srcPath = "", entry = "", outDir = "", initMap = false) {
         this.map = new map_config_1.MapConfig();
@@ -59,7 +61,7 @@ class MapContext {
     }
     static readFromLocal(inDir) {
         const inPath = path_1.default.join(inDir, MapContext.SAVE_FILE);
-        console.log(`input map => ${inPath}`);
+        logger.info(`read map: ${inPath}`);
         try {
             const json = fs_1.default.readFileSync(inPath, { encoding: "utf-8" });
             const map = JSON.parse(json);
@@ -68,7 +70,7 @@ class MapContext {
             return mapContext;
         }
         catch (err) {
-            console.log("the map is not found!");
+            logger.warn("map file not found");
             // console.log(err);
         }
         return new MapContext();
@@ -81,7 +83,7 @@ class MapContext {
     }
     writeToLocal() {
         const outPath = path_1.default.join(this.outDir, MapContext.SAVE_FILE);
-        console.log(`output map => ${outPath}`);
+        logger.info(`write map: ${outPath}`);
         const json = JSON.stringify(this.map, null, 4);
         try {
             fs_1.default.accessSync(this.outDir);
@@ -95,7 +97,7 @@ class MapContext {
         const srcAst = (0, ast_1.parseSrcAst)(inPath);
         const srcMethodNames = (0, ast_1.getObjectMethodNames)((0, ast_1.getObjectMethodsByEntryAndMethodNames)(srcAst, entry));
         if (!srcMethodNames.length) {
-            console.log(`not found entry => ${entry}`);
+            logger.warn(`entry not found: ${entry}`);
             this.appendModMap(new map_config_1.Mod(inPath, new map_config_1.Dependencies()), root, entry);
             return;
         }

package/core/decode/index.js

@@ -26,19 +26,26 @@ const map_context_1 = require("../context/map_context");
 const scanf_1 = require("../scanf");
 const ast_1 = require("../util/ast");
 const version_1 = require("../util/version");
+const logger_1 = require("../util/logger");
+const logger = (0, logger_1.createLogger)("decode");
 (function decoding(config) {
     return __awaiter(this, void 0, void 0, function* () {
         const targetDirs = (0, scanf_1.scanfCodeDirs)(config.baseDir, config.target);
-        console.log("scanf dirs => ");
-        console.log(targetDirs);
+        logger.step("扫描目录");
+        logger.info(`目标目录: ${targetDirs.join(", ")}`);
         const codeFiles = (0, scanf_1.scanfCodeFiles)(targetDirs, config.decode.file);
-        for (const inPath of codeFiles) {
-            console.log(`scanf file => ${inPath}`);
+        logger.info(`找到 ${codeFiles.length} 个编码文件 (${config.decode.file})`);
+        for (let i = 0; i < codeFiles.length; i++) {
+            const inPath = codeFiles[i];
             const outPath = path_1.default.join(path_1.default.dirname(inPath), config.decode.output);
             const settingDir = path_1.default.join(path_1.default.dirname(inPath), config.settingDir);
+            logger.step(`解码处理 [${i + 1}/${codeFiles.length}]`);
+            logger.info(`源文件: ${inPath}`);
             yield decoding$0(inPath, outPath, config, settingDir);
-            console.log(`output => ${outPath}`);
+            logger.info(`输出: ${outPath}`);
         }
+        logger.step("完成");
+        logger.info(`共处理 ${codeFiles.length} 个文件`);
     });
 })(config_1.config);
 /**

package/core/encode/index.js

@@ -11,18 +11,24 @@ const map_context_1 = require("../context/map_context");
 const ast_1 = require("../util/ast");
 const version_1 = require("../util/version");
 const core_1 = require("@babel/core");
+const logger_1 = require("../util/logger");
+const logger = (0, logger_1.createLogger)("encode");
 (function encoding(config) {
     const encodeConfig = config.encode;
     const targetDirs = (0, scanf_1.scanfCodeDirs)(config.baseDir, config.target);
-    console.log("scanf dirs => ");
-    console.log(targetDirs);
+    logger.step("扫描目录");
+    logger.info(`目标目录: ${targetDirs.join(", ")}`);
     const codeFiles = (0, scanf_1.scanfCodeFiles)(targetDirs, encodeConfig.file);
-    codeFiles.forEach((inPath) => {
+    logger.info(`找到 ${codeFiles.length} 个入口文件 (${encodeConfig.file})`);
+    let totalMethods = 0;
+    codeFiles.forEach((inPath, index) => {
         const workDir = path_1.default.dirname(inPath);
         const settingDir = path_1.default.join(workDir, config.settingDir);
-        console.log(`scanf file => ${inPath}`);
+        logger.step(`编码处理 [${index + 1}/${codeFiles.length}]`);
+        logger.info(`源文件: ${inPath}`);
         const mapContext = new map_context_1.MapContext(inPath, encodeConfig.entry, settingDir, true);
         const methods = encoding$0(mapContext, encodeConfig.entry);
+        totalMethods += methods.length;
         // 读取或创建版本号
         const version = (0, version_1.readOrCreateVersion)(settingDir);
         // 在onFormReady方法中注入版本日志
@@ -30,17 +36,19 @@ const core_1 = require("@babel/core");
         // 将onFormReady和onFormSubmit排到最前面
         reorderMethods(methods);
         const outPath = path_1.default.join(workDir, encodeConfig.output);
-        console.log(`output file => ${outPath}`);
         (0, ast_1.outputObjectMethods)(outPath, methods);
+        logger.info(`方法数: ${methods.length}, 版本: ${version}`);
+        logger.info(`输出: ${outPath}`);
         // 版本号递增并写入
         (0, version_1.incrementVersion)(settingDir);
     });
+    logger.step("完成");
+    logger.info(`共处理 ${codeFiles.length} 个文件, ${totalMethods} 个方法`);
 })(config_1.config);
 function encoding$0(mapContext, entry) {
     const modNames = mapContext.getModNames();
     return modNames.flatMap((name) => {
         const srcAst = (0, ast_1.parseSrcAst)(mapContext.getAbsoluteSrcPathByMod(name));
-        // console.log(`import => ${name}`);
         const srcMethods = [];
         const self = name === "self";
         if (self) {

package/core/scanf/index.js

@@ -8,6 +8,8 @@ exports.scanfCodeDirs = scanfCodeDirs;
 exports.scanfRequieMod = scanfRequieMod;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const logger_1 = require("../util/logger");
+const logger = (0, logger_1.createLogger)("scanf");
 function scanfCodeFiles(dirPaths, filterName = "") {
     if (typeof dirPaths === "string") {
         return scanfCodeFiles$0(dirPaths, filterName);
@@ -20,7 +22,7 @@ function scanfCodeFiles(dirPaths, filterName = "") {
 function scanfCodeFiles$0(dirPath, filterName = "") {
     const filePaths = [];
     if (!fs_1.default.existsSync(dirPath)) {
-        console.log(`路径不存在[${dirPath}]忽略`);
+        logger.warn(`dir not found, skipping: ${dirPath}`);
         return filePaths;
     }
     const files = fs_1.default.readdirSync(dirPath, {

package/core/util/ast.js

@@ -25,6 +25,8 @@ const path_1 = require("path");
 const os_1 = require("os");
 const parent_path_1 = require("./parent_path");
 const config_1 = require("../config");
+const logger_1 = require("./logger");
+const logger = (0, logger_1.createLogger)("ast");
 function parseSrcAst(srcPath) {
     if (!srcPath) {
         return;
@@ -70,7 +72,7 @@ function getRequireModPaths(baseDir, srcAst, ignoreMod, rootDir) {
                     if (item.init.callee.name === "require") {
                         if (core_1.types.isIdentifier(item.id)) {
                             if (ignoreMod === null || ignoreMod === void 0 ? void 0 : ignoreMod.includes(item.id.name)) {
-                                console.log(`ignore module => ${item.id.name}`);
+                                logger.info(`ignore module: ${item.id.name}`);
                             }
                             else {
                                 return true;

package/core/util/logger.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 统一日志工具模块
+ * 提供带 scope 前缀和状态图标的日志函数
+ */
+export interface Logger {
+    info(msg: string): void;
+    warn(msg: string): void;
+    error(msg: string): void;
+    step(title: string): void;
+}
+/**
+ * 创建带 scope 前缀的 logger
+ * @param scope - 日志前缀，如 'encode' / 'decode'
+ */
+export declare function createLogger(scope: string): Logger;

package/core/util/logger.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * 统一日志工具模块
+ * 提供带 scope 前缀和状态图标的日志函数
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLogger = createLogger;
+/**
+ * 创建带 scope 前缀的 logger
+ * @param scope - 日志前缀，如 'encode' / 'decode'
+ */
+function createLogger(scope) {
+    return {
+        info(msg) {
+            console.log(`[${scope}] ✔ ${msg}`);
+        },
+        warn(msg) {
+            console.log(`[${scope}] ⚠ ${msg}`);
+        },
+        error(msg) {
+            console.log(`[${scope}] ✖ ${msg}`);
+        },
+        step(title) {
+            const line = "─".repeat(Math.max(0, 50 - title.length));
+            console.log(`\n[${scope}] ── ${title} ${line}`);
+        }
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kezh/my-custom-js-converter",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "自定义代码转换器",
   "main": "index.js",
   "bin": {

package/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/config/index.ts","./src/config/main_config.ts","./src/config/map_config.ts","./src/context/map_context.ts","./src/decode/index.ts","./src/encode/index.ts","./src/scanf/index.ts","./src/util/ast.ts","./src/util/parent_path.ts","./src/util/version.ts"],"version":"6.0.3"}
+{"root":["./src/config/index.ts","./src/config/main_config.ts","./src/config/map_config.ts","./src/context/map_context.ts","./src/decode/index.ts","./src/encode/index.ts","./src/scanf/index.ts","./src/util/ast.ts","./src/util/logger.ts","./src/util/parent_path.ts","./src/util/version.ts"],"version":"6.0.3"}