@wx-sab/renkei 1.3.4 → 2.0.0-alpha.1

package/lib/cli.js

@@ -30,6 +30,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = __importDefault(require("commander"));
 const TSNode = __importStar(require("ts-node"));
 const api_1 = __importDefault(require("./commands/api"));
+const migrate_1 = __importDefault(require("./commands/migrate"));
 TSNode.register({
     // 不加载本地的 tsconfig.json
     skipProject: true,
@@ -39,8 +40,8 @@ TSNode.register({
     compilerOptions: {
         strict: false,
         target: "es6",
-        module: "ESNext",
-        moduleResolution: "Bundler",
+        module: "node16",
+        moduleResolution: "node16",
         declaration: false,
         removeComments: false,
         esModuleInterop: true,
@@ -53,4 +54,5 @@ TSNode.register({
 commander_1.default.program
     .version(require("../package.json").version, "-v, --version")
     .addCommand(api_1.default)
+    .addCommand(migrate_1.default)
     .parse();

package/lib/commands/migrate.d.ts

@@ -0,0 +1,4 @@
+import commander from "commander";
+export declare const runMigrateCommand: (dir: string, dry: boolean) => void;
+declare const parse: commander.Command;
+export default parse;

package/lib/commands/migrate.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runMigrateCommand = void 0;
+const commander_1 = __importDefault(require("commander"));
+const migrate_1 = require("../core/migrate");
+const runMigrateCommand = (dir, dry) => {
+    (0, migrate_1.migrateImports)(dir, dry);
+};
+exports.runMigrateCommand = runMigrateCommand;
+const parse = new commander_1.default.Command("migrate")
+    .description("把 service 的具名 import 迁移为 namespace import,配合函数式产物做方法级 tree shaking(调用点 XxxService.method() 不变)")
+    .argument("[dir]", "要扫描的目录", "src")
+    .option("--dry", "只打印将要修改的内容,不写入文件", false)
+    .action((dir, options) => {
+    (0, exports.runMigrateCommand)(dir, options.dry);
+});
+exports.default = parse;

package/lib/core/migrate.d.ts

@@ -0,0 +1,13 @@
+export interface MigrateStats {
+    changed: number;
+    files: number;
+    skipped: number;
+}
+export type Logger = (message: string) => void;
+/**
+ * 扫描目录,把 service 的具名 import 迁移为 namespace import。
+ * @param root  扫描根目录
+ * @param dry   true 只打印不写入
+ * @param log   日志输出(默认 console.log),便于测试注入
+ */
+export declare function migrateImports(root: string, dry: boolean, log?: Logger): MigrateStats;

package/lib/core/migrate.js

@@ -0,0 +1,128 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrateImports = void 0;
+/**
+ * 把 service 的具名 import 批量迁移为 namespace import,
+ * 配合函数式产物做方法级 tree shaking,调用点 XxxService.method() 写法不变。
+ *
+ *   import { CopUpms } from "@/services/cop-upms"
+ *      ↓
+ *   import * as CopUpms from "@/services/cop-upms"
+ *
+ * 分流规则(只动 from 路径含 /services/ 的具名 import):
+ *   - 大写开头单具名(旧 namespace 名,如 CopUpms) → 自动改 import * as
+ *   - 小写开头单具名(扁平函数,如 post_xxx)        → 忽略(已是函数式,无需迁移)
+ *   - 多具名 / 带 as 别名                          → 跳过并给出改法提示(确保不漏迁)
+ *
+ * 局限:基于正则,不感知注释/字符串,会一并改写注释里的 import 文本(对运行无影响)。
+ */
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const TARGET_EXT = new Set([".ts", ".tsx", ".js", ".jsx", ".vue", ".mjs"]);
+const SKIP_DIR = new Set(["node_modules", "dist", "lib", "build", ".git"]);
+// 抓所有 services 路径的具名 import,花括号内容(inner)另行判断
+const SERVICES_IMPORT_RE = /import\s*\{\s*([^}]+?)\s*\}\s*from\s*(['"])([^'"]*\/services\/[^'"]+)\2/g;
+const UPPER_SINGLE = /^[A-Z]\w*$/; // 大写开头单具名 → 旧 namespace 名,自动改
+const LOWER_SINGLE = /^[a-z_$][\w$]*$/; // 小写开头单具名 → 扁平函数 import,忽略
+function buildHint(inner, q, from) {
+    const asMatch = inner.match(/^([A-Za-z_$][\w$]*)\s+as\s+([A-Za-z_$][\w$]*)$/);
+    if (asMatch) {
+        // 单具名 + as: import { CopUpms as Upms } → import * as Upms
+        return `建议改为: import * as ${asMatch[2]} from ${q}${from}${q}`;
+    }
+    if (inner.includes(",")) {
+        const names = inner.split(",").map((s) => s.trim());
+        const uppers = names.filter((n) => UPPER_SINGLE.test(n));
+        const lowers = names.filter((n) => LOWER_SINGLE.test(n));
+        const parts = [];
+        if (uppers.length)
+            parts.push(`import * as ${uppers[0]} from ${q}${from}${q}`);
+        if (lowers.length)
+            parts.push(`import { ${lowers.join(", ")} } from ${q}${from}${q}`);
+        if (!parts.length)
+            return `需手动拆分: ${names.join(", ")}`;
+        const tail = names.length === uppers.length + lowers.length ? "" : "(其余含 as/复杂项需手动)";
+        return `建议拆为: ${parts.join("  +  ")} ${tail}`.trim();
+    }
+    return "需手动处理";
+}
+/**
+ * 扫描目录,把 service 的具名 import 迁移为 namespace import。
+ * @param root  扫描根目录
+ * @param dry   true 只打印不写入
+ * @param log   日志输出(默认 console.log),便于测试注入
+ */
+function migrateImports(root, dry, log = console.log) {
+    const stats = { changed: 0, files: 0, skipped: 0 };
+    const walk = (dir) => {
+        let entries;
+        try {
+            entries = fs_1.default.readdirSync(dir);
+        }
+        catch (_a) {
+            return;
+        }
+        for (const name of entries) {
+            const p = path_1.default.join(dir, name);
+            let st;
+            try {
+                st = fs_1.default.statSync(p);
+            }
+            catch (_b) {
+                continue;
+            }
+            if (st.isDirectory()) {
+                if (SKIP_DIR.has(name))
+                    continue;
+                walk(p);
+            }
+            else if (TARGET_EXT.has(path_1.default.extname(name))) {
+                const src = fs_1.default.readFileSync(p, "utf8");
+                SERVICES_IMPORT_RE.lastIndex = 0;
+                const fixes = [];
+                const skips = [];
+                let m;
+                while ((m = SERVICES_IMPORT_RE.exec(src))) {
+                    const inner = (m[1] || "").trim();
+                    const q = m[2];
+                    const from = m[3];
+                    if (UPPER_SINGLE.test(inner)) {
+                        fixes.push({ name: inner, q, from, idx: m.index, raw: m[0] });
+                    }
+                    else if (LOWER_SINGLE.test(inner)) {
+                        // 扁平函数 import,已是函数式,无需迁移
+                    }
+                    else {
+                        skips.push({ raw: m[0], hint: buildHint(inner, q, from) });
+                    }
+                }
+                if (fixes.length) {
+                    stats.files++;
+                    let out = src;
+                    let offset = 0;
+                    for (const r of fixes) {
+                        const repl = `import * as ${r.name} from ${r.q}${r.from}${r.q}`;
+                        out = out.slice(0, r.idx + offset) + repl + out.slice(r.idx + offset + r.raw.length);
+                        offset += repl.length - r.raw.length;
+                        stats.changed++;
+                        log(`${dry ? "[dry] " : "[fix] "}${p}\n       ${r.raw.trim()}  →  import * as ${r.name} from ${r.q}${r.from}${r.q}`);
+                    }
+                    if (!dry)
+                        fs_1.default.writeFileSync(p, out);
+                }
+                for (const s of skips) {
+                    stats.skipped++;
+                    log(`${dry ? "[dry] " : "[skip]"}${p}\n       ${s.raw.trim()}\n       ${s.hint}`);
+                }
+            }
+        }
+    };
+    walk(path_1.default.resolve(root));
+    log(`\n完成: 改写 ${stats.changed} 处 import(${stats.files} 个文件), 跳过 ${stats.skipped} 处需手动处理` +
+        `${dry ? " —— [dry-run 未写入]" : " —— 已写入"}`);
+    return stats;
+}
+exports.migrateImports = migrateImports;

package/lib/core/migrate.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/core/migrate.test.js

@@ -0,0 +1,95 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const migrate_1 = require("./migrate");
+let tmp;
+(0, vitest_1.beforeEach)(() => {
+    tmp = fs_1.default.mkdtempSync(path_1.default.join(os_1.default.tmpdir(), "migrate-"));
+});
+(0, vitest_1.afterEach)(() => {
+    fs_1.default.rmSync(tmp, { recursive: true, force: true });
+});
+const write = (file, content) => {
+    const p = path_1.default.join(tmp, file);
+    fs_1.default.mkdirSync(path_1.default.dirname(p), { recursive: true });
+    fs_1.default.writeFileSync(p, content);
+};
+const read = (file) => fs_1.default.readFileSync(path_1.default.join(tmp, file), "utf8");
+const noLog = () => { };
+(0, vitest_1.describe)("migrateImports", () => {
+    (0, vitest_1.it)("改写大写开头的单具名 service import", () => {
+        write("a.ts", 'import { CopUpms } from "@/services/cop-upms";\n');
+        const stats = (0, migrate_1.migrateImports)(tmp, false, noLog);
+        (0, vitest_1.expect)(stats.changed).toBe(1);
+        (0, vitest_1.expect)(read("a.ts")).toContain('import * as CopUpms from "@/services/cop-upms"');
+    });
+    (0, vitest_1.it)("同一文件多处 import 都被改写", () => {
+        write("a.ts", 'import { CopUpms } from "@/services/cop-upms";\nimport { DpService } from "@/services/dp-service";\n');
+        const stats = (0, migrate_1.migrateImports)(tmp, false, noLog);
+        (0, vitest_1.expect)(stats.changed).toBe(2);
+        (0, vitest_1.expect)(read("a.ts")).toContain('import * as CopUpms from "@/services/cop-upms"');
+        (0, vitest_1.expect)(read("a.ts")).toContain('import * as DpService from "@/services/dp-service"');
+    });
+    (0, vitest_1.it)("多具名跳过并给出拆分提示,不写入", () => {
+        const src = 'import { CopUpms, otherUtil } from "@/services/cop-upms";\n';
+        write("a.ts", src);
+        const logs = [];
+        const stats = (0, migrate_1.migrateImports)(tmp, false, (m) => logs.push(m));
+        (0, vitest_1.expect)(stats.changed).toBe(0);
+        (0, vitest_1.expect)(stats.skipped).toBe(1);
+        (0, vitest_1.expect)(read("a.ts")).toBe(src);
+        (0, vitest_1.expect)(logs.join("\n")).toContain("建议拆为");
+        (0, vitest_1.expect)(logs.join("\n")).toContain("otherUtil");
+    });
+    (0, vitest_1.it)("as 别名跳过并给出 namespace 建议", () => {
+        write("a.ts", 'import { CopUpms as Upms } from "@/services/cop-upms";\n');
+        const logs = [];
+        const stats = (0, migrate_1.migrateImports)(tmp, false, (m) => logs.push(m));
+        (0, vitest_1.expect)(stats.skipped).toBe(1);
+        (0, vitest_1.expect)(stats.changed).toBe(0);
+        (0, vitest_1.expect)(logs.join("\n")).toContain("import * as Upms");
+    });
+    (0, vitest_1.it)("忽略小写开头的函数式 import(已是函数式)", () => {
+        const src = 'import { post_account_roles } from "@/services/cop-upms";\n';
+        write("a.ts", src);
+        const stats = (0, migrate_1.migrateImports)(tmp, false, noLog);
+        (0, vitest_1.expect)(stats.changed).toBe(0);
+        (0, vitest_1.expect)(stats.skipped).toBe(0);
+        (0, vitest_1.expect)(read("a.ts")).toBe(src);
+    });
+    (0, vitest_1.it)("忽略非 services 路径的 import", () => {
+        const src = 'import { someUtil } from "@/utils/helper";\n';
+        write("a.ts", src);
+        const stats = (0, migrate_1.migrateImports)(tmp, false, noLog);
+        (0, vitest_1.expect)(stats.changed).toBe(0);
+        (0, vitest_1.expect)(read("a.ts")).toBe(src);
+    });
+    (0, vitest_1.it)("dry-run 不写入文件", () => {
+        const src = 'import { CopUpms } from "@/services/cop-upms";\n';
+        write("a.ts", src);
+        const stats = (0, migrate_1.migrateImports)(tmp, true, noLog);
+        (0, vitest_1.expect)(stats.changed).toBe(1);
+        (0, vitest_1.expect)(read("a.ts")).toBe(src);
+    });
+    (0, vitest_1.it)("跳过 node_modules / dist 等目录", () => {
+        write("node_modules/pkg/x.ts", 'import { CopUpms } from "@/services/cop-upms";\n');
+        write("dist/build.ts", 'import { CopUpms } from "@/services/cop-upms";\n');
+        write("src/a.ts", 'import { CopUpms } from "@/services/cop-upms";\n');
+        const stats = (0, migrate_1.migrateImports)(tmp, false, noLog);
+        (0, vitest_1.expect)(stats.changed).toBe(1);
+        (0, vitest_1.expect)(read("src/a.ts")).toContain("import * as CopUpms");
+        (0, vitest_1.expect)(read("node_modules/pkg/x.ts")).not.toContain("import * as");
+    });
+    (0, vitest_1.it)("递归扫描子目录", () => {
+        write("src/views/user/a.ts", 'import { CopUpms } from "@/services/cop-upms";\n');
+        const stats = (0, migrate_1.migrateImports)(tmp, false, noLog);
+        (0, vitest_1.expect)(stats.changed).toBe(1);
+        (0, vitest_1.expect)(read("src/views/user/a.ts")).toContain("import * as CopUpms");
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wx-sab/renkei",
-  "version": "1.3.4",
+  "version": "2.0.0-alpha.1",
   "description": "解析swagger转为ts代码，日本动漫《游戏王》中的‘Renkei’，意为连携或协作。",
   "main": "./lib/index.js",
   "bin": {

package/templates/api.ejs

@@ -56,47 +56,45 @@ enum ContentType {
   UrlEncoded = 'application/x-www-form-urlencoded',
 }
 
-export class <%~ serviceName %> {
-  /**
-   * 常规 Mock 服务地址
-   */
-  static private mockService = '<%~ config.customMockService?.(config) || '' %>';
-  static setMockService (service) {
-    <%~ serviceName %>.mockService = service;
-  }
+/**
+ * 常规 Mock 服务地址
+ */
+let mockService = '<%~ config.customMockService?.(config) || '' %>';
+export function setMockService (service: string) {
+  mockService = service;
+}
 
-  /**
-   * 开启Mock
-   */
-  static private isMock = false;
-  static enableMock(enable: boolean = true) {
-    <%~ serviceName %>.isMock = enable;
-  }
+/**
+ * 开启Mock
+ */
+let isMock = false;
+export function enableMock(enable: boolean = true) {
+  isMock = enable;
+}
 
-  /**
-   * 如果开启 mock, 替换请求的url
-   * @param {String} path 请求接口路径
-   * @param {Boolean} mock 是否开启 Mock
-   * @param {String} customMockUrl 自定义mock链接
-   */
-  static generateUrl(params: {
-    path: string,
-    mock?: boolean,
-    customMockUrl?: string
-  }): string {
-    if (<%~ serviceName %>.isMock || params.mock) {
-      return params.customMockUrl || (<%~ serviceName %>.mockService + params.path)
-    }
-    return params.path;
+/**
+ * 如果开启 mock, 替换请求的url
+ * @param {String} path 请求接口路径
+ * @param {Boolean} mock 是否开启 Mock
+ * @param {String} customMockUrl 自定义mock链接
+ */
+function generateUrl(params: {
+  path: string,
+  mock?: boolean,
+  customMockUrl?: string
+}): string {
+  if (isMock || params.mock) {
+    return params.customMockUrl || (mockService + params.path)
   }
+  return params.path;
+}
 
-  <% routes.combined && routes.combined.forEach(({ routes = [], moduleName }) => { %>
-    <% routes.forEach((route) => { %>
-      <% if (route.routeName.usage !== SKIP_ROUTE_MARKER) { %>
-        <%~ includeFile('./procedure-call.ejs', { ...it, route }) %>
-      <% } %>
-    <% }) %>
+<% routes.combined && routes.combined.forEach(({ routes = [], moduleName }) => { %>
+  <% routes.forEach((route) => { %>
+    <% if (route.routeName.usage !== SKIP_ROUTE_MARKER) { %>
+      <%~ includeFile('./procedure-call.ejs', { ...it, route }) %>
+    <% } %>
   <% }) %>
-}
+<% }) %>
 
 export { <%~ modelNamespace %> }

package/templates/procedure-call.ejs

@@ -157,8 +157,8 @@ const wrappedDataArgs = _
 <%~ routeDocs.lines %>
 
  */
-static public <%~ route.routeName.usage %> = async (<%~ wrappedDataArgs %>): Promise<<%~ getWrapperFullType(type) %>> => {
-    const url = <%~ serviceName %>.generateUrl({
+export const <%~ route.routeName.usage %> = async (<%~ wrappedDataArgs %>): Promise<<%~ getWrapperFullType(type) %>> => {
+    const url = generateUrl({
         path: `<%~ path %>`, 
         mock: config.mock,
         customMockUrl: `<%~ route.raw.mockUrl || '' %>`