@karry.sun/yapi-gen 0.1.0 → 0.2.0

package/README.md

@@ -5,36 +5,48 @@
 ## 安装
 
 ```bash
-pnpm add -D yapi-gen yapi-to-typescript
+pnpm add -D @karry.sun/yapi-gen
 ```
 
+本包已内置 yapi-to-typescript，无需单独安装。
+
 ## 快速开始
 
-### 1. 初始化配置
+1. **安装依赖**（在要生成接口的项目根目录）  
+   ```bash
+   pnpm add -D @karry.sun/yapi-gen
+   ```
 
-在项目根目录执行：
+2. **生成配置文件**（若还没有 `yapi-gen.config.ts`）  
+   ```bash
+   pnpm yapi-gen init
+   ```  
+   会生成 `yapi-gen.config.ts`，用编辑器打开，按需修改：
+   - `serverUrl`：YApi 服务器地址  
+   - `projects[0].token`：YApi 项目 token（建议用 `process.env.YAPI_TOKEN`）  
+   - `requestAdapter`：`'axios'`（Vue/defHttp）或 `'nuxt-bbm'`（Nuxt），或 `'custom'` 并填写 `requestFunctionFilePath`  
+   - `outputFilePath`：生成文件的目录规则（默认按分类生成到 `src/yapi/cat_xxx/index.ts`）
 
-```bash
-pnpm yapi-gen init
-```
+3. **生成接口代码**  
+   ```bash
+   pnpm yapi-gen
+   ```  
+   或在 `package.json` 的 `scripts` 里加 `"gen:api": "yapi-gen"`，然后执行：  
+   ```bash
+   pnpm gen:api
+   ```
 
-会生成 `yapi-gen.config.ts`，按需修改 `serverUrl`、`token`、`requestAdapter`、`outputFilePath` 等。
+4. **在业务代码中引用**  
+   生成的文件在 `outputFilePath` 配置的路径下，按分类或单文件导出请求函数与类型，直接从对应路径 import 使用即可。
 
-### 2. 选择请求适配方式
+
+5. 选择请求适配方式
 
 - **内置预设（推荐）**：在配置中设置 `requestAdapter: 'axios'` 或 `requestAdapter: 'nuxt-bbm'`，无需在各仓库维护 `request.ts`，运行 `yapi-gen` 时会自动生成并写入 `src/yapi/request.ts`（路径可配）。
   - **axios**：适用于封装了 axios 的项目（如 defHttp）。可选 `requestAdapter: { type: 'axios', axiosInstancePath: '/@/utils/http/axios' }` 指定实例路径，默认 `'/@/utils/http/axios'`（defHttp 常见路径）。
   - **nuxt-bbm**：适用于 Nuxt 项目，使用 Layer 的 `#imports` 或 `@bitunix/bbm` 的 request。可选 `requestAdapter: { type: 'nuxt-bbm', requestImportPath: '#imports' }`，默认 `'#imports'`。
 - **自定义**：设置 `requestAdapter: 'custom'` 并配置 `requestFunctionFilePath`，在对应文件中自行实现适配逻辑；或参考包内 `templates/request-*.ts` 复制后修改。
 
-### 3. 生成接口代码
-
-```bash
-pnpm yapi-gen
-```
-
-会在当前目录查找 `yapi-gen.config.ts`（或 `.yapi-genrc.ts` 等），生成临时 ytt 配置并执行 `ytt`，输出到你在 `outputFilePath` 中配置的目录。
-
 ## 配置说明
 
 `yapi-gen.config.ts` 使用 `defineYapiGenConfig` 导出单条配置（或数组，多条会合并为 `defineConfig([...])`）。主要字段与 [yapi-to-typescript 配置](https://fjc0k.github.io/yapi-to-typescript/handbook/config.html) 对齐：
@@ -57,11 +69,6 @@ pnpm yapi-gen
 
 YApi 的 **token** 建议通过环境变量注入，例如在 `projects[].token` 中写 `process.env.YAPI_TOKEN || 'fallback'`。
 
-## 在现有项目中使用
-
-- **web-finance-admin（defHttp）**：在 `yapi-gen.config.ts` 中设置 `requestAdapter: 'axios'`（或 `{ type: 'axios', axiosInstancePath: '/@/utils/http/axios' }`），无需再维护 `request.ts`；或继续使用 `requestAdapter: 'custom'` 并保留现有 `requestFunctionFilePath`。
-- **pc（Nuxt / @bitunix/bbm）**：设置 `requestAdapter: 'nuxt-bbm'`（或 `{ type: 'nuxt-bbm', requestImportPath: '#imports' }`），无需再维护 `request.ts`；或使用 `custom` 并指向现有文件。
-
 ## 配置文件查找顺序
 
 CLI 会按以下顺序查找配置（找到即用）：

package/dist/resolve-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-config.d.ts","sourceRoot":"","sources":["../src/resolve-config.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAyB,MAAM,iBAAiB,CAAC;AAiFhF;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,GAAG,iBAAiB,CA0CvF"}
+{"version":3,"file":"resolve-config.d.ts","sourceRoot":"","sources":["../src/resolve-config.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,iBAAiB,EAAyB,MAAM,iBAAiB,CAAC;AA4FhF;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,GAAG,iBAAiB,CA2CvF"}

package/dist/resolve-config.js

@@ -1,8 +1,20 @@
 /**
  * 在运行 ytt 前解析配置：处理 requestAdapter 预设，生成并写入 request 文件，得到 ytt 可用的配置
  */
-import { existsSync, mkdirSync, writeFileSync } from 'fs';
-import { resolve, dirname } from 'path';
+import { existsSync, mkdirSync, writeFileSync, readFileSync } from 'fs';
+import { resolve, dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+function getPackageName() {
+    try {
+        const __dirname = dirname(fileURLToPath(import.meta.url));
+        const pkgPath = join(__dirname, '..', 'package.json');
+        const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
+        return (pkg && pkg.name) || 'yapi-gen';
+    }
+    catch {
+        return 'yapi-gen';
+    }
+}
 const DEFAULT_REQUEST_FILE_PATH = 'src/yapi/request.ts';
 const DEFAULT_AXIOS_INSTANCE_PATH = "/@/utils/http/axios";
 const DEFAULT_NUXT_REQUEST_IMPORT_PATH = '#imports';
@@ -46,7 +58,7 @@ function normalizeRequestAdapter(adapter) {
     }
     return { type: 'custom' };
 }
-function getAxiosAdapterFileContent(axiosInstancePath, exportName) {
+function getAxiosAdapterFileContent(packageName, axiosInstancePath, exportName) {
     const importLine = exportName === 'default'
         ? `import defHttp from '${axiosInstancePath}';`
         : `import { defHttp } from '${axiosInstancePath}';`;
@@ -54,18 +66,18 @@ function getAxiosAdapterFileContent(axiosInstancePath, exportName) {
  * 由 yapi-gen 预设 "axios" 自动生成，请勿直接修改。
  * 如需自定义请求逻辑，请将配置改为 requestAdapter: 'custom' 并维护 requestFunctionFilePath 指向的文件。
  */
-import { createAxiosAdapter } from 'yapi-gen/adapters/axios';
+import { createAxiosAdapter } from '${packageName}/adapters/axios';
 ${importLine}
 
 export default createAxiosAdapter(defHttp);
 `;
 }
-function getNuxtBbmAdapterFileContent(requestImportPath) {
+function getNuxtBbmAdapterFileContent(packageName, requestImportPath) {
     return `/**
  * 由 yapi-gen 预设 "nuxt-bbm" 自动生成，请勿直接修改。
  * 如需自定义请求逻辑，请将配置改为 requestAdapter: 'custom' 并维护 requestFunctionFilePath 指向的文件。
  */
-import { createNuxtAdapter } from 'yapi-gen/adapters/nuxt-bbm';
+import { createNuxtAdapter } from '${packageName}/adapters/nuxt-bbm';
 import { request } from '${requestImportPath}';
 
 export default createNuxtAdapter(request);
@@ -79,8 +91,9 @@ export function resolveConfig(config, cwd) {
     const resolved = { ...config };
     const adapter = normalizeRequestAdapter(resolved.requestAdapter);
     const requestFilePath = resolved.requestFunctionFilePath ?? adapter.requestFunctionFilePath ?? DEFAULT_REQUEST_FILE_PATH;
+    const packageName = getPackageName();
     if (adapter.type === 'axios') {
-        const content = getAxiosAdapterFileContent(adapter.axiosInstancePath, adapter.axiosExportName ?? 'defHttp');
+        const content = getAxiosAdapterFileContent(packageName, adapter.axiosInstancePath, adapter.axiosExportName ?? 'defHttp');
         const absolutePath = resolve(cwd, requestFilePath);
         const dir = dirname(absolutePath);
         if (!existsSync(dir)) {
@@ -92,7 +105,7 @@ export function resolveConfig(config, cwd) {
         return resolved;
     }
     if (adapter.type === 'nuxt-bbm') {
-        const content = getNuxtBbmAdapterFileContent(adapter.requestImportPath);
+        const content = getNuxtBbmAdapterFileContent(packageName, adapter.requestImportPath);
         const absolutePath = resolve(cwd, requestFilePath);
         const dir = dirname(absolutePath);
         if (!existsSync(dir)) {

package/dist/run.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAiGA,wBAAgB,GAAG,CAAC,OAAO,GAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,MAAM,CAkC/F"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAmIA,wBAAgB,GAAG,CAAC,OAAO,GAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,MAAM,CAmC/F"}

package/dist/run.js

@@ -1,11 +1,25 @@
 /**
  * CLI 执行逻辑：解析用户配置、生成 ytt 包装配置并执行 ytt
+ * 从本包依赖的 yapi-to-typescript 调用 ytt，无需使用方单独安装
  */
 import { spawnSync } from 'child_process';
 import { existsSync, mkdirSync, writeFileSync } from 'fs';
-import { resolve, dirname, basename, relative } from 'path';
+import { resolve, dirname, basename, relative, join } from 'path';
 import { fileURLToPath } from 'url';
+import { createRequire } from 'module';
+import { readFileSync } from 'fs';
 const __dirname = dirname(fileURLToPath(import.meta.url));
+const require = createRequire(import.meta.url);
+function getPackageName() {
+    try {
+        const pkgPath = join(__dirname, '..', 'package.json');
+        const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
+        return (pkg && pkg.name) || 'yapi-gen';
+    }
+    catch {
+        return 'yapi-gen';
+    }
+}
 const CONFIG_NAMES = [
     'yapi-gen.config.ts',
     'yapi-gen.config.mts',
@@ -33,6 +47,7 @@ function findConfig(cwd) {
  * 该文件会 import 用户配置并传入 defineConfig
  */
 function getWrapperContent(cwd, configPath) {
+    const packageName = getPackageName();
     const absoluteConfig = resolve(cwd, configPath);
     const configDir = dirname(absoluteConfig);
     const configBase = basename(absoluteConfig).replace(/\.[^.]+$/, '') || 'yapi-gen.config';
@@ -41,7 +56,7 @@ function getWrapperContent(cwd, configPath) {
     const relativeImport = (rel ? rel + '/' : '') + configBase;
     return `/* 由 yapi-gen 自动生成，请勿修改 */
 import { defineConfig } from 'yapi-to-typescript';
-import { resolveConfig } from 'yapi-gen';
+import { resolveConfig } from '${packageName}';
 
 const userConfig = await import('${relativeImport}');
 const raw = userConfig.default ?? userConfig;
@@ -57,19 +72,38 @@ function runInit(cwd) {
         console.log('[yapi-gen] 已存在 yapi-gen.config.ts，跳过创建');
     }
     else {
-        const tpl = `import { defineYapiGenConfig } from 'yapi-gen';
+        const packageName = getPackageName();
+        const tpl = `/**
+ * YApi 接口代码生成配置
+ * 生成后执行: pnpm yapi-gen 或 pnpm gen:api
+ */
+import { defineYapiGenConfig } from '${packageName}';
 
 export default defineYapiGenConfig({
   serverUrl: 'https://yapi.example.com',
   serverType: 'yapi',
-  // 请求适配：'axios' | 'nuxt-bbm' | 'custom'，使用预设时可不填 requestFunctionFilePath
+  // 请求适配：'axios' | 'nuxt-bbm' | 'custom'
   requestAdapter: 'axios',
-  // requestFunctionFilePath: 'src/yapi/request.ts',  // custom 时必填；预设时可选，默认 src/yapi/request.ts
+  // axios 时可选指定实例路径，默认 '/@/utils/http/axios'
+  // requestAdapter: { type: 'axios', axiosInstancePath: '/@/utils/http/axios' },
   outputFilePath: (interfaceInfo, changeCase) => {
     const catId = interfaceInfo.catid ?? 0;
     return \`src/yapi/cat_\${catId}/index.ts\`;
   },
   dataKey: 'result',
+  preproccessInterface(interfaceInfo) {
+    // 可选：按环境变量过滤接口。YTT_INTERFACE_IDS=1,2,3 或 YTT_CATEGORY_IDS=401,413
+    const ids = process.env.YTT_INTERFACE_IDS;
+    const catIds = process.env.YTT_CATEGORY_IDS;
+    if (ids) {
+      const allowList = ids.split(',').map((s) => parseInt(s.trim(), 10));
+      if (!allowList.includes(interfaceInfo._id)) return false;
+    } else if (catIds) {
+      const allowList = catIds.split(',').map((s) => s.trim());
+      if (!allowList.includes(String(interfaceInfo.catid))) return false;
+    }
+    return interfaceInfo;
+  },
   projects: [
     {
       token: process.env.YAPI_TOKEN || 'your-project-token',
@@ -86,7 +120,7 @@ export default defineYapiGenConfig({
 });
 `;
         writeFileSync(configPath, tpl, 'utf-8');
-        console.log('[yapi-gen] 已创建 yapi-gen.config.ts，请按需修改 serverUrl、token 等');
+        console.log('[yapi-gen] 已创建 yapi-gen.config.ts，请修改 serverUrl、token 后执行 pnpm yapi-gen 生成接口');
     }
     return 0;
 }
@@ -108,10 +142,11 @@ export function run(options = {}) {
     const wrapperPath = resolve(wrapperDir, WRAPPER_FILENAME);
     const content = getWrapperContent(cwd, configPath);
     writeFileSync(wrapperPath, content, 'utf-8');
-    const result = spawnSync('npx', ['ytt', '-c', wrapperPath], {
+    // 使用本包依赖的 yapi-to-typescript 的 CLI，不依赖使用方安装
+    const yttCliPath = require.resolve('yapi-to-typescript/lib/cjs/cli.js');
+    const result = spawnSync(process.execPath, [yttCliPath, '-c', wrapperPath], {
         cwd,
         stdio: 'inherit',
-        shell: true,
     });
     return result.status ?? 1;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@karry.sun/yapi-gen",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "基于 yapi-to-typescript 的 YApi 前端代码生成 CLI，支持可配置的请求适配器与多项目复用",
   "type": "module",
   "main": "dist/index.js",
@@ -34,14 +34,6 @@
   "dependencies": {
     "yapi-to-typescript": "^3.38.0"
   },
-  "peerDependencies": {
-    "yapi-to-typescript": ">=3.0.0"
-  },
-  "peerDependenciesMeta": {
-    "yapi-to-typescript": {
-      "optional": true
-    }
-  },
   "devDependencies": {
     "typescript": "^5.0.0"
   },