@wx-sab/renkei 1.2.5 → 1.3.1

package/README.md

@@ -157,8 +157,174 @@ export default defineConfig([
 ]);
 ```
 
+### CLI 命令
+
+```bash
+# 生成所有服务的所有接口
+renkei api
+
+# 只生成指定服务的接口
+renkei api -s dp-service
+
+# 只生成指定文件夹的接口（命令行方式）
+renkei api -f "用户管理,订单管理"
+
+# 交互式选择要生成的文件夹
+renkei api -i
+
+# 组合使用：交互式选择指定服务的文件夹
+renkei api -s dp-service -i
+```
+
+### 交互式选择文件夹
+
+当运行 `renkei api -i` 时，工具会：
+
+1. 分析每个服务的 swagger/apifox 文档
+2. 提取所有文件夹信息（基于 `x-apifox-folder` 字段）
+3. 显示交互式多选界面，默认选中"全部"选项
+4. 用户可以选择：
+   - 保持选中"全部"：生成所有接口
+   - 取消"全部"，选择具体文件夹：只生成选中的接口
+
+示例输出：
+```
+正在分析服务: dp-service
+
+发现以下文件夹:
+  1. 用户管理 (15 个接口)
+  2. 订单管理 (23 个接口)
+  3. 商品管理 (18 个接口)
+  4. 支付管理 (12 个接口)
+
+? 请选择要生成的文件夹 (空格选择，回车确认) (Press <space> to select, <a> to toggle all, <i> to invert selection)
+❯◉ 全部 (共 68 个接口)
+ ── 具体文件夹 ──
+ ◯ 用户管理 (15 个接口)
+ ◯ 订单管理 (23 个接口)
+ ◯ 商品管理 (18 个接口)
+ ◯ 支付管理 (12 个接口)
+```
+
+**操作说明：**
+- 默认选中"全部"，生成所有接口
+- 按 `空格` 取消"全部"，然后选择具体文件夹
+- 按 `a` 切换全选/全不选
+- 按 `i` 反选
+- 按 `回车` 确认选择
+
+### 文件夹过滤功能
+
+支持三种方式指定要生成的文件夹：
+
+#### 1. 配置文件方式
+
+在配置文件中通过 `folders` 字段指定：
+
+```typescript
+import { defineConfig } from "@wx-sab/renkei";
+
+export default defineConfig([
+  {
+    serviceName: "dp-service",
+    apifoxProjectId: "2954843",
+    // 只生成这两个文件夹的接口
+    folders: ["用户管理", "订单管理"],
+    customRequestUrl: (routeData) => {
+      return "/" + routeData["x-apifox-folder"].split("/")[0] + routeData.route;
+    },
+  }
+]);
+```
+
+#### 2. 命令行参数方式
+
+使用 `-f` 或 `--folder` 参数：
+
+```bash
+# 只生成指定文件夹的接口
+renkei api -f "用户管理,订单管理"
+
+# 指定服务和文件夹
+renkei api -s dp-service -f "用户管理,订单管理"
+```
+
+#### 3. 交互式选择方式（推荐）
+
+使用 `-i` 或 `--interactive` 参数：
+
+```bash
+# 交互式选择所有服务的文件夹
+renkei api -i
+
+# 交互式选择指定服务的文件夹
+renkei api -s dp-service -i
+```
+
+#### 注意事项
+
+1. **文件夹名称匹配**：文件夹名称基于 swagger/apifox 文档中的 `x-apifox-folder` 字段，取第一级目录名称
+2. **优先级**：交互式选择 > 命令行参数 > 配置文件
+3. **空数组**：如果 `folders` 为空数组或不设置，则生成所有接口
+4. **多服务**：每个服务可以独立配置不同的文件夹列表
+
 ## Examples
 
+### 文件夹过滤示例
+
+#### 场景1：只生成特定模块的接口
+
+```typescript
+import { defineConfig } from "@wx-sab/renkei";
+
+export default defineConfig([
+  {
+    serviceName: "dp-service",
+    apifoxProjectId: "2954843",
+    // 只生成用户管理和订单管理模块的接口
+    folders: ["用户管理", "订单管理"],
+    customRequestUrl: (routeData) => {
+      return "/" + routeData["x-apifox-folder"].split("/")[0] + routeData.route;
+    },
+  }
+]);
+```
+
+#### 场景2：多服务配置，每个服务过滤不同文件夹
+
+```typescript
+import { defineConfig } from "@wx-sab/renkei";
+
+export default defineConfig([
+  {
+    serviceName: "dp-service",
+    apifoxProjectId: "2954843",
+    folders: ["用户管理", "订单管理"],
+    customRequestUrl: (routeData) => {
+      return "/" + routeData["x-apifox-folder"].split("/")[0] + routeData.route;
+    },
+  },
+  {
+    serviceName: "cop-profile",
+    apifoxProjectId: "1234567",
+    folders: ["个人中心", "权限管理"],
+    customRequestUrl: (routeData) => {
+      return "/cop-profile" + routeData.route;
+    },
+  }
+]);
+```
+
+#### 场景3：命令行快速过滤
+
+```bash
+# 快速生成特定文件夹的接口，无需修改配置文件
+renkei api -s dp-service -f "用户管理,订单管理,商品管理"
+
+# 交互式选择，适合不确定有哪些文件夹时使用
+renkei api -i
+```
+
 ### 自定义接口的 mock 服务
 ```ts
 import { request } from '@/utils/request'

package/lib/commands/api.js

@@ -1,37 +1,92 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
+const promises_1 = __importDefault(require("fs/promises"));
 const path_1 = __importDefault(require("path"));
 const commander_1 = __importDefault(require("commander"));
 const generate_1 = require("../core/generate");
 const constants_1 = require("../core/constants");
-/**
- * 读取项目中的配置文件
- */
-const readProjectConfigFile = () => {
+const folder_selector_1 = require("../core/folder-selector");
+const config_utils_1 = require("../core/config-utils");
+const readProjectConfigFile = () => __awaiter(void 0, void 0, void 0, function* () {
     for (const file of constants_1.CONFIG_FILE_NAMES) {
         const fullFilePath = path_1.default.resolve(process.cwd(), file);
-        if (fs_1.default.existsSync(fullFilePath)) {
+        try {
+            yield promises_1.default.access(fullFilePath);
             if (fullFilePath.endsWith('.ts')) {
                 return require(fullFilePath).default;
             }
             return require(fullFilePath);
         }
+        catch (_a) {
+            continue;
+        }
     }
     return null;
-};
-const parse = new commander_1.default.Command('api').option('-s, --service <service>', '只获取指定的服务，多个服务用","分隔', ',').action((param, options) => {
-    var _a;
-    // 只生成指定服务
+});
+const parseCommandOptions = (param) => {
+    var _a, _b;
     const services = (((_a = param.service) === null || _a === void 0 ? void 0 : _a.split(',')) || []).filter(Boolean);
-    const config = readProjectConfigFile();
+    const folders = (((_b = param.folder) === null || _b === void 0 ? void 0 : _b.split(',')) || []).filter(Boolean);
+    return { services, folders };
+};
+const handleInteractiveSelection = (config, services) => __awaiter(void 0, void 0, void 0, function* () {
+    const _configs = (0, config_utils_1.collectConfig)(config).filter((conf) => {
+        if (services.length > 0) {
+            return services.includes(conf.serviceName);
+        }
+        return true;
+    });
+    try {
+        const folderSelections = yield (0, folder_selector_1.selectFoldersForServices)(_configs);
+        (0, config_utils_1.applyFoldersToConfig)(config, folderSelections, services);
+        return true;
+    }
+    catch (error) {
+        console.error('交互式选择失败:', error.message);
+        return false;
+    }
+});
+const handleCommandLineFolders = (config, services, folders) => {
+    const folderMap = new Map();
+    (0, config_utils_1.collectConfig)(config).forEach((conf) => {
+        if (services.length === 0 || services.includes(conf.serviceName)) {
+            folderMap.set(conf.serviceName, folders);
+        }
+    });
+    (0, config_utils_1.applyFoldersToConfig)(config, folderMap, services);
+};
+const parse = new commander_1.default.Command('api')
+    .option('-s, --service <service>', '只获取指定的服务，多个服务用","分隔', ',')
+    .option('-f, --folder <folder>', '只获取指定的文件夹，多个文件夹用","分隔', ',')
+    .option('-i, --interactive', '启用交互式选择文件夹', false)
+    .action((param) => __awaiter(void 0, void 0, void 0, function* () {
+    const { services, folders } = parseCommandOptions(param);
+    const config = yield readProjectConfigFile();
     if (!config) {
         console.warn('未找到配置文件');
         return;
     }
+    if (param.interactive) {
+        const success = yield handleInteractiveSelection(config, services);
+        if (!success) {
+            return;
+        }
+    }
+    else if (folders.length > 0) {
+        handleCommandLineFolders(config, services, folders);
+    }
     (0, generate_1.generateApis)(config, services);
-});
+}));
 exports.default = parse;

package/lib/core/config-utils.d.ts

@@ -0,0 +1,8 @@
+import { GenerateConfig, ServiceConfig } from './interface';
+export declare const SKIP_ROUTE_MARKER: "__SKIP__";
+export declare const collectConfig: (conf: GenerateConfig | GenerateConfig[], collects?: GenerateConfig[]) => GenerateConfig[];
+export interface FolderSelectionResult {
+    serviceName: string;
+    folders: string[];
+}
+export declare const applyFoldersToConfig: (conf: ServiceConfig | ServiceConfig[], folderSelections: Map<string, string[]>, services?: string[]) => void;

package/lib/core/config-utils.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyFoldersToConfig = exports.collectConfig = exports.SKIP_ROUTE_MARKER = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+exports.SKIP_ROUTE_MARKER = '__SKIP__';
+const collectConfig = (conf, collects = []) => {
+    if (!conf)
+        return collects;
+    if (Array.isArray(conf)) {
+        conf.forEach((con) => (0, exports.collectConfig)(con, collects));
+    }
+    else {
+        collects.push(lodash_1.default.omit(conf, 'projects'));
+        if (Array.isArray(conf.projects)) {
+            conf.projects.forEach((project) => (0, exports.collectConfig)(Object.assign(Object.assign({}, lodash_1.default.omit(conf, 'projects')), project), collects));
+        }
+    }
+    return collects;
+};
+exports.collectConfig = collectConfig;
+const applyFoldersToConfig = (conf, folderSelections, services = []) => {
+    if (Array.isArray(conf)) {
+        conf.forEach((c) => (0, exports.applyFoldersToConfig)(c, folderSelections, services));
+    }
+    else {
+        const serviceName = conf.serviceName;
+        const selectedFolders = folderSelections.get(serviceName);
+        if (selectedFolders && selectedFolders.length > 0) {
+            conf.folders = selectedFolders;
+        }
+        if (Array.isArray(conf.projects)) {
+            conf.projects.forEach((p) => {
+                const projectServiceName = p.serviceName || serviceName;
+                const projectFolders = folderSelections.get(projectServiceName);
+                if (projectFolders && projectFolders.length > 0) {
+                    p.folders = projectFolders;
+                }
+            });
+        }
+    }
+};
+exports.applyFoldersToConfig = applyFoldersToConfig;

package/lib/core/config-utils.test.d.ts

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

package/lib/core/config-utils.test.js

@@ -0,0 +1,204 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const config_utils_1 = require("./config-utils");
+(0, vitest_1.describe)('config-utils', () => {
+    (0, vitest_1.describe)('collectConfig', () => {
+        (0, vitest_1.it)('should return empty array for null/undefined config', () => {
+            // 测试边界情况：null 和 undefined 输入
+            (0, vitest_1.expect)((0, config_utils_1.collectConfig)(null)).toEqual([]);
+            (0, vitest_1.expect)((0, config_utils_1.collectConfig)(undefined)).toEqual([]);
+        });
+        (0, vitest_1.it)('should collect single config', () => {
+            const config = {
+                serviceName: 'test-service',
+                sourceType: 'apifox',
+                apifoxProjectId: '12345'
+            };
+            const result = (0, config_utils_1.collectConfig)(config);
+            (0, vitest_1.expect)(result).toHaveLength(1);
+            (0, vitest_1.expect)(result[0].serviceName).toBe('test-service');
+        });
+        (0, vitest_1.it)('should collect array of configs', () => {
+            const configs = [
+                { serviceName: 'service1', sourceType: 'apifox', apifoxProjectId: '123' },
+                { serviceName: 'service2', sourceType: 'swagger' }
+            ];
+            const result = (0, config_utils_1.collectConfig)(configs);
+            (0, vitest_1.expect)(result).toHaveLength(2);
+            (0, vitest_1.expect)(result[0].serviceName).toBe('service1');
+            (0, vitest_1.expect)(result[1].serviceName).toBe('service2');
+        });
+        (0, vitest_1.it)('should flatten nested projects', () => {
+            const config = {
+                serviceName: 'parent-service',
+                sourceType: 'apifox',
+                apifoxProjectId: '123',
+                projects: [
+                    { serviceName: 'child-service-1' },
+                    { serviceName: 'child-service-2' }
+                ]
+            };
+            const result = (0, config_utils_1.collectConfig)(config);
+            (0, vitest_1.expect)(result).toHaveLength(3);
+            (0, vitest_1.expect)(result[0].serviceName).toBe('parent-service');
+            (0, vitest_1.expect)(result[1].serviceName).toBe('child-service-1');
+            (0, vitest_1.expect)(result[2].serviceName).toBe('child-service-2');
+        });
+        (0, vitest_1.it)('should omit projects field from collected configs', () => {
+            const config = {
+                serviceName: 'parent-service',
+                sourceType: 'apifox',
+                apifoxProjectId: '123',
+                projects: [
+                    { serviceName: 'child-service' }
+                ]
+            };
+            const result = (0, config_utils_1.collectConfig)(config);
+            (0, vitest_1.expect)(result[0]).not.toHaveProperty('projects');
+            (0, vitest_1.expect)(result[1]).not.toHaveProperty('projects');
+        });
+        (0, vitest_1.it)('should merge parent config with child projects', () => {
+            const config = {
+                serviceName: 'parent-service',
+                sourceType: 'apifox',
+                apifoxProjectId: '123',
+                output: '/custom/output',
+                projects: [
+                    { serviceName: 'child-service' }
+                ]
+            };
+            const result = (0, config_utils_1.collectConfig)(config);
+            (0, vitest_1.expect)(result[1].serviceName).toBe('child-service');
+            (0, vitest_1.expect)(result[1].sourceType).toBe('apifox');
+            (0, vitest_1.expect)(result[1].apifoxProjectId).toBe('123');
+            (0, vitest_1.expect)(result[1].output).toBe('/custom/output');
+        });
+        (0, vitest_1.it)('should handle deeply nested projects', () => {
+            const config = {
+                serviceName: 'root-service',
+                sourceType: 'swagger',
+                projects: [
+                    {
+                        serviceName: 'level-1',
+                        projects: [
+                            { serviceName: 'level-2' }
+                        ]
+                    }
+                ]
+            };
+            const result = (0, config_utils_1.collectConfig)(config);
+            (0, vitest_1.expect)(result).toHaveLength(3);
+            (0, vitest_1.expect)(result[0].serviceName).toBe('root-service');
+            (0, vitest_1.expect)(result[1].serviceName).toBe('level-1');
+            (0, vitest_1.expect)(result[2].serviceName).toBe('level-2');
+        });
+        (0, vitest_1.it)('should preserve existing collects array', () => {
+            const config = {
+                serviceName: 'new-service'
+            };
+            const existing = [
+                { serviceName: 'existing-service' }
+            ];
+            const result = (0, config_utils_1.collectConfig)(config, existing);
+            (0, vitest_1.expect)(result).toHaveLength(2);
+            (0, vitest_1.expect)(result[0].serviceName).toBe('existing-service');
+            (0, vitest_1.expect)(result[1].serviceName).toBe('new-service');
+        });
+    });
+    (0, vitest_1.describe)('applyFoldersToConfig', () => {
+        (0, vitest_1.it)('should apply folders to single config', () => {
+            const config = {
+                serviceName: 'test-service'
+            };
+            const folderSelections = new Map();
+            folderSelections.set('test-service', ['folder1', 'folder2']);
+            (0, config_utils_1.applyFoldersToConfig)(config, folderSelections);
+            (0, vitest_1.expect)(config.folders).toEqual(['folder1', 'folder2']);
+        });
+        (0, vitest_1.it)('should not modify config if no folders selected', () => {
+            const config = {
+                serviceName: 'test-service'
+            };
+            const folderSelections = new Map();
+            (0, config_utils_1.applyFoldersToConfig)(config, folderSelections);
+            (0, vitest_1.expect)(config.folders).toBeUndefined();
+        });
+        (0, vitest_1.it)('should apply folders to array of configs', () => {
+            const configs = [
+                { serviceName: 'service1' },
+                { serviceName: 'service2' }
+            ];
+            const folderSelections = new Map();
+            folderSelections.set('service1', ['folder1']);
+            folderSelections.set('service2', ['folder2']);
+            (0, config_utils_1.applyFoldersToConfig)(configs, folderSelections);
+            (0, vitest_1.expect)(configs[0].folders).toEqual(['folder1']);
+            (0, vitest_1.expect)(configs[1].folders).toEqual(['folder2']);
+        });
+        (0, vitest_1.it)('should apply folders to nested projects', () => {
+            const config = {
+                serviceName: 'parent-service',
+                projects: [
+                    { serviceName: 'child-service' }
+                ]
+            };
+            const folderSelections = new Map();
+            folderSelections.set('parent-service', ['parent-folder']);
+            folderSelections.set('child-service', ['child-folder']);
+            (0, config_utils_1.applyFoldersToConfig)(config, folderSelections);
+            (0, vitest_1.expect)(config.folders).toEqual(['parent-folder']);
+            (0, vitest_1.expect)(config.projects[0].folders).toEqual(['child-folder']);
+        });
+        (0, vitest_1.it)('should use parent serviceName for projects without serviceName', () => {
+            const config = {
+                serviceName: 'parent-service',
+                projects: [
+                    {}
+                ]
+            };
+            const folderSelections = new Map();
+            folderSelections.set('parent-service', ['shared-folder']);
+            (0, config_utils_1.applyFoldersToConfig)(config, folderSelections);
+            (0, vitest_1.expect)(config.folders).toEqual(['shared-folder']);
+            (0, vitest_1.expect)(config.projects[0].folders).toEqual(['shared-folder']);
+        });
+        (0, vitest_1.it)('should not apply empty folder selection to projects', () => {
+            const config = {
+                serviceName: 'parent-service',
+                projects: [
+                    { serviceName: 'child-service', folders: ['existing-folder'] }
+                ]
+            };
+            const folderSelections = new Map();
+            folderSelections.set('child-service', []);
+            (0, config_utils_1.applyFoldersToConfig)(config, folderSelections);
+            (0, vitest_1.expect)(config.projects[0].folders).toEqual(['existing-folder']);
+        });
+        (0, vitest_1.it)('should not modify config when folder selection is empty', () => {
+            const config = {
+                serviceName: 'test-service',
+                folders: ['existing-folder']
+            };
+            const folderSelections = new Map();
+            folderSelections.set('test-service', []);
+            (0, config_utils_1.applyFoldersToConfig)(config, folderSelections);
+            (0, vitest_1.expect)(config.folders).toEqual(['existing-folder']);
+        });
+        (0, vitest_1.it)('should preserve services array parameter', () => {
+            const config = {
+                serviceName: 'test-service'
+            };
+            const folderSelections = new Map();
+            folderSelections.set('test-service', ['folder1']);
+            const services = [];
+            (0, config_utils_1.applyFoldersToConfig)(config, folderSelections, services);
+            (0, vitest_1.expect)(config.folders).toEqual(['folder1']);
+        });
+    });
+    (0, vitest_1.describe)('SKIP_ROUTE_MARKER', () => {
+        (0, vitest_1.it)('should be defined as constant', () => {
+            (0, vitest_1.expect)(config_utils_1.SKIP_ROUTE_MARKER).toBe('__SKIP__');
+        });
+    });
+});

package/lib/core/folder-selector.d.ts

@@ -0,0 +1,10 @@
+import { GenerateConfig } from './interface';
+export interface FolderInfo {
+    name: string;
+    path: string;
+    count: number;
+}
+export declare const fetchSwaggerDocument: (config: GenerateConfig) => Promise<any>;
+export declare const extractFoldersFromSwagger: (swaggerDoc: any) => FolderInfo[];
+export declare const selectFolders: (folders: FolderInfo[]) => Promise<string[]>;
+export declare const selectFoldersForServices: (configs: GenerateConfig[]) => Promise<Map<string, string[]>>;