feat: 输出文件放到src目录

BREAKING CHANGE: client服务改为从相对路径引用

Author: geekact

.gitignore

@@ -13,5 +13,4 @@ coverage/
 *.d.mts
 *.js.map
 /adapters
-openapi/openapi.yaml
-openapi/openapi.json
+openapi/

README.md

@@ -33,7 +33,7 @@ export default defineConfig({
 
 ## 2. 执行指令
 
-指令的作用是把openapi文档转换为前端服务，代码会自动合并到库文件中
+指令的作用是把openapi文档转换为前端服务，生成的文件会自动放到 src/openapi 目录
 
 ```bash
 npx openapi
@@ -44,8 +44,8 @@ npx openapi
 使用合适的请求适配器创建好服务后，就可以导出给各个模块使用了
 
 ```typescript
-// ./src/services/http.ts
-import { OpenapiClient } from 'foca-openapi';
+// ./src/openapi/index.ts
+import { OpenapiClient } from './openapi/openapi';
 import { fetchAdapter } from 'foca-openapi/adapters/fetch';
 
 const adapter = fetchAdapter({ baseURL: 'http://api.com' });
@@ -69,6 +69,7 @@ export const client = new OpenapiClient(adapter);
 如果一个项目需要融合多个openapi文档，则可以用数组的形式配置
 
 ```typescript
+// openapi.config.ts
 import { defineConfig } from 'foca-openapi';
 
 export default defineConfig([
@@ -88,7 +89,9 @@ export default defineConfig([
 执行指令后就会生成两个类
 
 ```typescript
-import { OpenapiClientFoo, OpenapiClientBar } from 'foca-openapi';
+// ./src/openapi/index.ts
+import { OpenapiClientFoo } from './foo';
+import { OpenapiClientBar } from './bar';
 
 export const fooClient = new OpenapiClientFoo(adapter1);
 export const barClient = new OpenapiClientBar(adapter2);
@@ -144,6 +147,15 @@ npx openapi --config my-custom.config.ts
 
 openapi本地或者远程文件，支持格式：`yaml | json`
 
+### outputFile
+
+类型 `string`<br>
+
+输出文件路径
+
+- 如果没有配置项目名，默认值：`./src/openapi/openapi.ts`
+- 如果配置了项目名，默认值：`./src/openapi/${projectName}.ts`
+
 ### includeUriPrefix
 
 类型：`string | string[] | RegExp | RegExp[]`

package.json

@@ -5,7 +5,7 @@
   "scripts": {
     "test": "vitest",
     "generate": "aomex openapi-yaml && aomex openapi-json",
-    "build": "tsup && sh scripts/build-success.sh",
+    "build": "tsup",
     "prepare": "husky",
     "prepublishOnly": "pnpm build",
     "deploy:main": "sh scripts/develop-deploy-main.sh",

scripts/build-success.sh

@@ -1,15 +1,13 @@
 #!/usr/bin/env node
 
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
 import timers from 'node:timers/promises';
 import { Listr } from 'listr2';
 import minimist from 'minimist';
 import colors from 'yoctocolors';
 import { OpenAPIV3 } from 'openapi-types';
 import type { OpenapiClientConfig } from './define-config';
 import { pathToOpenapi } from './lib/path-to-openapi';
-import { rebuildDist } from './lib/rebuild-dist';
+import { saveToFile } from './lib/save-to-file';
 import { generateTemplate } from './lib/generate-template';
 import { filterTag } from './lib/filter-tag';
 import { filterUrl } from './lib/filter-url';
@@ -29,7 +27,7 @@ const toArray = (value: any) => (Array.isArray(value) ? value : [value]);
 const spinner = (silent ? new SilentSpinner([]) : new Listr([])) as Listr<{
   configs: OpenapiClientConfig[];
   docs: OpenAPIV3.Document[];
-  projects: Record<string, { dts: string; js: string }>;
+  projects: Record<string, string>;
 }>;
 
 spinner.add({
@@ -105,17 +103,13 @@ spinner.add({
 });
 
 spinner.add({
-  title: '写入npm包',
-  task: async (ctx, task) => {
-    task.title += ` ${colors.gray(`import { ${Object.keys(ctx.projects).join(', ')} } from 'foca-openapi'`)}`;
-    const root = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
-    const jsContent = Object.values(ctx.projects)
-      .map(({ js }) => js)
-      .join('\n');
-    const dtsContent = Object.values(ctx.projects)
-      .map(({ dts }) => dts)
-      .join('\n');
-    await rebuildDist(root, jsContent, dtsContent, Object.keys(ctx.projects));
+  title: '写入指定文件',
+  task: async (ctx) => {
+    await Promise.all(
+      ctx.configs.map((config) => {
+        return saveToFile(config, ctx.projects);
+      }),
+    );
   },
 });
 

src/bin.ts

@@ -47,6 +47,13 @@ export interface OpenapiClientConfig {
    * 加载完openapi文档后的事件，允许直接对文档进行修改
    */
   onDocumentLoaded?: (doc: OpenAPIV3.Document) => OpenAPIV3.Document | void;
+  /**
+   * 输出文件路径。
+   *
+   * - 如果没有配置项目名，默认值：`./src/openapi/openapi.ts`
+   * - 如果配置了项目名，默认值：`./src/openapi/${projectName}.ts`
+   */
+  outputFile?: string;
 }
 
 export type DefineConfigOptions =

src/define-config.ts

@@ -10,7 +10,7 @@ export const generateTemplate = async (
   docs: OpenAPIV3.Document,
   config: Pick<OpenapiClientConfig, 'projectName' | 'classMode'>,
 ) => {
-  const { projectName, classMode = 'rest' } = config;
+  const { projectName = '', classMode = 'rest' } = config;
   const className = `OpenapiClient${upperFirst(camelCase(projectName))}`;
   const metas = documentToMeta(docs);
 
@@ -21,28 +21,27 @@ export const generateTemplate = async (
         ? generateUriModelClassWithGroup(className, metas)
         : generateUriModelClass(className, metas);
 
-  const dts = `
+  const content = `
+    import { BaseOpenapiClient } from 'foca-openapi';
+
     ${generateNamespaceTpl(className, metas)}
-    ${classTpl.dts}
+    ${classTpl}
     ${generatePathRelationTpl(className, metas)}
+    ${generateContentTypeTpl(metas)}
 `;
 
-  const js = `
-  ${classTpl.js}
-  ${generateContentTypeTpl(className, metas)}
-  `;
-
   return {
-    [className]: {
-      dts: await prettier.format(dts, { parser: 'typescript', printWidth: 120 }),
-      js: await prettier.format(js, { parser: 'typescript', printWidth: 120 }),
-    },
+    [projectName]: await prettier.format(content, {
+      parser: 'typescript',
+      printWidth: 120,
+      semi: true,
+    }),
   };
 };
 
 export const generateNamespaceTpl = (className: string, metas: Metas) => {
   return `
-declare namespace ${className} {
+export namespace ${className} {
   ${methods
     .flatMap((method) => {
       let content = metas[method].flatMap((meta) => {
@@ -51,7 +50,7 @@ declare namespace ${className} {
         (<const>['query', 'params', 'body', 'response']).forEach((key) => {
           const interfaceName = upperFirst(camelCase(meta.key + '_' + key));
           if (meta[key].types.length) {
-            opts.push(`type ${interfaceName} = ${meta[key].types.join(' | ')}\n`);
+            opts.push(`export type ${interfaceName} = ${meta[key].types.join(' | ')}\n`);
           }
         });
 
@@ -64,9 +63,8 @@ declare namespace ${className} {
 };
 
 export const generateMethodModeClass = (className: string, metas: Metas) => {
-  return {
-    dts: `
-declare class ${className}<T extends object = object> extends BaseOpenapiClient<T> {
+  return `
+export class ${className}<T extends object = object> extends BaseOpenapiClient<T> {
   ${methods
     .map((method) => {
       if (!metas[method].length) return '';
@@ -90,62 +88,41 @@ declare class ${className}<T extends object = object> extends BaseOpenapiClient<
 
       return `${method}<K extends keyof ${className}_${method}_paths>(
         uri: K, ...rest: ${opts}
-      ): Promise<${className}_${method}_paths[K]['response']>`;
-    })
-    .join('\n')}
-}`,
-    js: `
-var ${className} = class extends BaseOpenapiClient {
-  ${methods
-    .map((method) => {
-      if (!metas[method].length) return '';
-      return `${method}(uri, opts) {
-        return this.request(uri, "get", opts);
-      }`;
+      ): Promise<${className}_${method}_paths[K]['response']> {
+        return this.request(uri, "get", ...rest);
+      }
+      `;
     })
     .join('\n')}
 
-  pickContentTypes(uri, method) {
-    return contentTypes${className}[method + " " + uri] || [void 0, void 0];
+  protected override pickContentTypes(uri: string, method: string) {
+    return contentTypes[method + " " + uri] || [void 0, void 0];
   }
-};`,
-  };
+}`;
 };
 
 export const generateUriModelClass = (className: string, metas: Metas) => {
-  return {
-    dts: `
-declare class ${className}<T extends object = object> extends BaseOpenapiClient<T> {
+  return `
+export class ${className}<T extends object = object> extends BaseOpenapiClient<T> {
   ${methods
     .flatMap((method) => {
       return metas[method].map((meta) => {
         const optional =
           meta.query.optional && meta.params.optional && meta.body.optional;
 
         return `
-        ${generateComments(meta)}${camelCase(meta.key)}(opts${optional ? '?' : ''}: ${className}_${method}_paths['${meta.uri}']['request'] & BaseOpenapiClient.UserInputOpts<T>): Promise<${className}_${method}_paths['${meta.uri}']['response']>`;
-      });
-    })
-    .join('\n')}
-}`,
-    js: `
-var ${className} = class extends BaseOpenapiClient {
-  ${methods
-    .flatMap((method) => {
-      return metas[method].map((meta) => {
-        return `
-        ${generateComments(meta)}${camelCase(meta.key)}(opts) {
+        ${generateComments(meta)}${camelCase(meta.key)}(opts${optional ? '?' : ''}: ${className}_${method}_paths['${meta.uri}']['request'] & BaseOpenapiClient.UserInputOpts<T>): Promise<${className}_${method}_paths['${meta.uri}']['response']> {
           return this.request('${meta.uri}', "${method}", opts);
-        }`;
+        }
+        `;
       });
     })
     .join('\n')}
 
-  pickContentTypes(uri, method) {
-    return contentTypes${className}[method + " " + uri] || [void 0, void 0];
-  }
-};`,
-  };
+    protected override pickContentTypes(uri: string, method: string) {
+      return contentTypes[method + " " + uri] || [void 0, void 0];
+    }
+}`;
 };
 
 export const generateUriModelClassWithGroup = (className: string, metas: Metas) => {
@@ -155,12 +132,11 @@ export const generateUriModelClassWithGroup = (className: string, metas: Metas)
     ),
   ];
 
-  return {
-    dts: `
-declare class ${className}<T extends object = object> extends BaseOpenapiClient<T> {
+  return `
+export class ${className}<T extends object = object> extends BaseOpenapiClient<T> {
   ${namespaces
     .map((ns) => {
-      return `readonly ${snakeCase(ns)}: {
+      return `readonly ${snakeCase(ns)} = {
       ${methods
         .flatMap((method) => {
           return metas[method]
@@ -169,44 +145,26 @@ declare class ${className}<T extends object = object> extends BaseOpenapiClient<
               const optional =
                 meta.query.optional && meta.params.optional && meta.body.optional;
 
-              return `${generateComments(meta)}${camelCase(meta.key)}(opts${optional ? '?' : ''}: ${className}_${method}_paths['${meta.uri}']['request'] & BaseOpenapiClient.UserInputOpts<T>): Promise<${className}_${method}_paths['${meta.uri}']['response']>`;
-            });
-        })
-        .join('\n')}
-    }`;
-    })
-    .join('\n')}
-}`,
-    js: `
-var ${className} = class extends BaseOpenapiClient {
-  ${namespaces
-    .map((ns) => {
-      return `${snakeCase(ns)} = {
-      ${methods
-        .flatMap((method) => {
-          return metas[method]
-            .filter((meta) => meta.tags.includes(ns))
-            .map((meta) => {
-              return `${generateComments(meta)}${camelCase(meta.key)}: (opts) => {
+              return `${generateComments(meta)}${camelCase(meta.key)}(opts${optional ? '?' : ''}: ${className}_${method}_paths['${meta.uri}']['request'] & BaseOpenapiClient.UserInputOpts<T>): Promise<${className}_${method}_paths['${meta.uri}']['response']> {
                 return this.request('${meta.uri}', '${method}', opts);
-              },`;
+              }`;
             });
         })
-        .join('\n')}
-      }`;
+        .join(',\n')}
+    }`;
     })
     .join('\n')}
 
-  pickContentTypes(uri, method) {
-    return contentTypes${className}[method + ' ' + uri] || [void 0, void 0];
-  }
-};`,
-  };
+    protected override pickContentTypes(uri: string, method: string) {
+      return contentTypes[method + " " + uri] || [void 0, void 0];
+    }
+}`;
 };
 
-export const generateContentTypeTpl = (className: string, metas: Metas) => {
+export const generateContentTypeTpl = (metas: Metas) => {
   return `
-  const contentTypes${className} = {
+  const contentTypes: Record<string, [BaseOpenapiClient.UserInputOpts['requestBodyType'],
+    BaseOpenapiClient.UserInputOpts['responseType']]> = {
   ${methods
     .map((method) => {
       if (!metas[method].length) return '';