gen-api-types 1.0.5 → 1.0.9

package/README.en.md

@@ -1,112 +1,149 @@
-# gen-api-types
-
-#### Introduction
-
-🚀 A CLI tool for automatically generating request interface return types
-
-In TypeScript projects, you often need to write interface return types. However, it's troublesome to manually write them every time by referring to the API documentation. If you encounter third-party interfaces or incomplete documentation, you need to debug the interface first before writing the return types, which is quite a headache.
-
-With this tool, we can mark request interface classes and methods through TypeScript decorators, then dynamically call these interfaces and convert the returned data into TypeScript type definition files, which can be directly used in projects.
-
-> Note:
-> This tool needs to dynamically execute TypeScript code (calling interface modules in the project) and depends on the `tsx` execution tool. Please make sure to install `tsx` globally and ensure the `tsx` command is available.
-
-#### Installation
-
-1. npm installation
-
-```shell
-npm install tsx -g
-npm install gen-api-types -D
-```
-
-#### Usage
-
-##### 1. Mark interface class names and methods
-
-```ts
-import { gen_type_c, gen_type_m } from 'gen-api-types'
-
-@gen_type_c()
-export class TestApi {
-	@gen_type_m({ args: [100], typeName: 'XXX' })
-	static async getList(id: number): Promise<XXX> {
-		return asleep(1000).then(() => {
-			return { name: 'zs', id }
-		})
-	}
-
-	@gen_type_m()
-	static getWeather(): Promise<Response_TestApi_getWeather> {
-		return fetch('http://t.weather.sojson.com/api/weather/city/101030100').then(r => r.json())
-	}
-}
-```
-
-As shown in the code above:
-
-- `@gen_type_c` decorator function is used to mark interface classes. Since the tool dynamically analyzes all ts files in the specified directory, marking interface classes helps quickly locate them.
-- `@gen_type_m` decorator function marks the request methods that need to be converted. It can accept a configuration object with two fields:
-  1. `typeName: string` Interface return type name. If not specified, the default name will be: `Response_${ClassName}_${MethodName}`
-  2. `args: any[]` Method parameter list. The tool will pass this list when calling the request method.
-
-##### 2. Execute command
-
-```shell
-npx gen-api-types -o output_dir -O output_file_name ./api_dir1 ./api_dir2
-```
-
-Parameter description:
-
-```shell
-Usage: npx gen-api-types [options] [api_dirs...]
-
-Options:
-  -h, --help                  Output help information
-  -r, --project_root <path>   Project root directory
-  -O, --output_file <path>    Output file name
-  -o, --output_dir <path>     Output directory
-  -t, --ts_config_path <path> Path to tsconfig.json file
-```
-
-You can also use it by configuring scripts in package.json:
-
-```json
-{
-	"scripts": {
-		"gen_types": "gen-api-types -o output_dir -O output_file_name ./api_dir1 ./api_dir2"
-	}
-}
-```
-
-Command output:
-
-```shell
-🚀 Start generating API types...
-sourceFilesGlob [ 'src\\**\\*.ts' ]
-📋 Processing UserApi.getList ...
-📋 Processing UserApi.getWeather ...
-Request results:
-  ┌────────────────┬──────────────────────────────────────┐
-  │ (index)        │ Values                               │
-  ├────────────────┼──────────────────────────────────────┤
-  │ ✔️ successList │ 'UserApi.getList UserApi.getWeather' │
-  │ ❌ errorList   │ ''                                   │
-  └────────────────┴──────────────────────────────────────┘
-✅ API type generation completed
-```
-
-##### 3. Using the types
-
-By default, a type definition file index.d.ts is generated without exports:
-
-```ts
-type XXX = { name: string };
-type Response_UserApi_getWeather = {...}
-```
-
-You can configure `include` in tsconfig.json to reference the file, or directly reference it at the top of the interface module file with:
-
-```ts
-/// <reference path="./index.d.ts" />
-```
+# gen-api-types
+
+#### Introduction
+
+🚀 A CLI tool for automatically generating request interface return types
+
+In TypeScript projects, you often need to write interface return types. However, it's troublesome to manually write them every time by referring to the API documentation. If you encounter third-party interfaces or incomplete documentation, you need to debug the interface first before writing the return types, which is quite a headache.
+
+With this tool, we can mark request interface classes and methods through TypeScript decorators, then dynamically call these interfaces and convert the returned data into TypeScript type definition files, which can be directly used in projects.
+
+> Note:
+>
+> 1. Because this tool uses TypeScript decorators, and decorators currently (TypeScript 5.0) do not support decorating plain functions directly, APIs must be written as **API classes + static API methods**.
+> 2. This tool needs to dynamically execute TypeScript code (importing API classes and calling the marked static API methods), so it runs through the bundled `tsx` dependency. No global `tsx` installation is required.
+
+#### Installation
+
+1. npm installation
+
+```shell
+npm install gen-api-types -D
+```
+
+#### Usage
+
+##### 1. Mark interface class names and methods
+
+```ts
+import { gen_type_c, gen_type_m } from 'gen-api-types'
+
+@gen_type_c()
+export class TestApi {
+	@gen_type_m({ args: [100], typeName: 'XXX' })
+	static async getList(id: number): Promise<XXX> {
+		return asleep(1000).then(() => {
+			return { name: 'zs', id }
+		})
+	}
+
+	@gen_type_m()
+	static getWeather(): Promise<Response_TestApi_getWeather> {
+		return fetch('http://t.weather.sojson.com/api/weather/city/101030100').then(r => r.json())
+	}
+}
+```
+
+As shown in the code above:
+
+- `@gen_type_c` decorator function is used to mark interface classes. Since the tool dynamically analyzes all ts files in the specified directory, marking interface classes helps quickly locate them.
+- `@gen_type_m` decorator function marks the request methods that need to be converted. It can accept a configuration object with two fields:
+  1. `typeName: string` Interface return type name. If not specified, the default name will be: `Response_${ClassName}_${MethodName}`
+  2. `args: any[]` Method parameter list. The tool will pass this list when calling the request method.
+
+> Note:
+
+If TypeScript reports the decorator error: "The runtime will invoke the decorator with 2 arguments, but the decorator expects 3", set `compilerOptions.experimentalDecorators` to `true` in tsconfig.
+
+##### 2. Execute command
+
+```shell
+npx gen-api-types -o output_dir -O output_file_name ./api_dir1 ./api_dir2
+```
+
+Parameter description:
+
+```shell
+Usage: npx gen-api-types [options] [api_dirs...]
+
+Options:
+  -h, --help                  Output help information
+  -r, --project_root <path>   Project root directory
+  -O, --output_file <path>    Output file name
+  -o, --output_dir <path>     Output directory
+  -t, --ts_config_path <path> Path to tsconfig.json file
+  --isExported                Generate exported type declarations
+```
+
+You can also use it by configuring scripts in package.json:
+
+```json
+{
+	"scripts": {
+		"gen_types": "gen-api-types -o output_dir -O output_file_name ./api_dir1 ./api_dir2"
+	}
+}
+```
+
+Command output:
+
+```shell
+🚀 Start generating API types...
+sourceFilesGlob [ 'src\\**\\*.ts' ]
+📋 Processing UserApi.getList ...
+📋 Processing UserApi.getWeather ...
+Request results:
+  ┌────────────────┬──────────────────────────────────────┐
+  │ (index)        │ Values                               │
+  ├────────────────┼──────────────────────────────────────┤
+  │ ✔️ successList │ 'UserApi.getList UserApi.getWeather' │
+  │ ❌ errorList   │ ''                                   │
+  └────────────────┴──────────────────────────────────────┘
+✅ API type generation completed
+```
+
+##### 3. Using the types
+
+By default, a type definition file index.d.ts is generated, and the type declarations are not exported:
+
+```ts
+type XXX = { name: string };
+type Response_TestApi_getWeather = {...}
+```
+
+You can configure `include` in tsconfig.json to reference the file:
+
+```json
+// tsconfig.json
+{
+	"include": ["index.d.ts"]
+}
+```
+
+Or reference it directly at the top of the interface module file:
+
+```ts
+/// <reference path="./index.d.ts" />
+export class TestApi {
+	@gen_type_m()
+	static getWeather(): Promise<Response_TestApi_getWeather> {
+		return fetch('http://t.weather.sojson.com/api/weather/city/101030100').then(r => r.json())
+	}
+}
+
+// data is now typed as Response_TestApi_getWeather
+const data = await TestApi.getWeather()
+```
+
+If you want to generate exported type declarations, add `--isExported` when running the command:
+
+```shell
+npx gen-api-types --isExported -o output_dir -O output_file_name ./api_dir1 ./api_dir2
+```
+
+Generated output example:
+
+```ts
+export type XXX = { name: string };
+export type Response_TestApi_getWeather = {...}
+```

package/README.md

@@ -1,113 +1,150 @@
-# gen-api-types
-
-#### 介绍
-
-🚀 一个自动生成请求接口返回类型的 cli 小工具
-
-在 ts 项目中，经常需要编写接口返回类型。但是每次都要查看接口文档，手动编写非常麻烦。如果遇到一些第三方接口或者接口文档不全的情况，还需要先调试接口后，再编写接口返回类型，很令人头疼
-
-借助这个工具，我们可以通过 ts 装饰器来标记请求接口的类和方法，然后动态调用这些接口，并将接口返回的数据转换成 ts 类型文件，这样我们就可以在项目中直接使用了
-
-> 注意：
-> 该工具需要动态执行 ts 代码（调用项目中的接口模块），必须依赖 `tsx` 执行工具，请务必先全局安装 `tsx`，确保`tsx`命令可用。
-
-#### 安装教程
-
-1.npm 安装
-
-```shell
-npm install tsx -g
-npm install gen-api-types -D
-
-```
-
-#### 使用说明
-
-##### 1. 标记接口类名和方法
-
-```ts
-import { gen_type_c, gen_type_m } from 'gen-api-types'
-
-@gen_type_c()
-export class TestApi {
-	@gen_type_m({ args: [100], typeName: 'XXX' })
-	static async getList(id: number): Promise<XXX> {
-		return asleep(1000).then(() => {
-			return { name: 'zs', id }
-		})
-	}
-
-	@gen_type_m()
-	static getWeather(): Promise<Response_TestApi_getWeather> {
-		return fetch('http://t.weather.sojson.com/api/weather/city/101030100').then(r => r.json())
-	}
-}
-```
-
-如上面代码所示:
-
-- `@gen_type_c`装饰器函数，用来标记接口类。因为工具会动态分析指定目录下的所有 ts 文件，标记接口类，可以帮助我们快速定位接口类
-- `@gen_type_m`装饰器函数标记需要转换的请求方法。它可以接收一个配置对象，包含两个字段。
-  1.  `typeName: string` 接口返回类型名称，若不指定该字段，默认生成名称为： `Response_${类名}_${方法名}`
-  2.  `args：any[] ` 方法参数列表,工具调用请求方法时，会将参数列表传入
-
-##### 2. 执行命令
-
-```shell
-npx gen-api-types  -o output_dir -O output_file_name ./api_dir1 ./api_dir2
-```
-
-参数说明：
-
-```shell
- Usage: npx gen-api-types [options] [api_dirs...]
-
-Options:
-  -h, --help                  输出帮助信息
-  -r, --project_root <path>   项目根目录
-  -O, --output_file <path>    输出文件名
-  -o, --output_dir <path>     输出目录
-  -t, --ts_config_path <path> tsconfig.json 文件路径
-```
-
-当然，也可以通过配置 package.json 中的 scripts 来使用
-
-```json
-{
-	"scripts": {
-		"gen_types": "gen-api-types -o output_dir -O output_file_name ./api_dir1 ./api_dir2"
-	}
-}
-```
-
-命令输出：
-
-```shell
-🚀 开始生成API类型...
-sourceFilesGlob [ 'src\\**\\*.ts' ]
-📋 处理 UserApi.getList ...
-📋 处理 UserApi.getWeather ...
-请求结果：
-  ┌────────────────┬──────────────────────────────────────┐
-  │ (index)        │ Values                               │
-  ├────────────────┼──────────────────────────────────────┤
-  │ ✔️ successList │ 'UserApi.getList UserApi.getWeather' │
-  │ ❌ errorList   │ ''                                   │
-  └────────────────┴──────────────────────────────────────┘
-✅ API 类型生成完成
-```
-
-##### 3. 使用类型
-
-默认生成类型文件 index.d.ts,且没有导出
-
-```ts
-type XXX = { name: string };
-type Response_UserApi_getWeather = {...}
-```
-
-可在`tsconfig.json`中配置`include`引用文件,或者直接在接口模块文件顶部通引用:
-
-```ts
-/// <reference path="./index.d.ts" />
-```
+# gen-api-types
+
+#### 介绍
+
+🚀 一个自动生成请求接口返回类型的 cli 小工具
+
+在 ts 项目中，经常需要编写接口返回类型。但是每次都要查看接口文档，手动编写非常麻烦。如果遇到一些第三方接口或者接口文档不全的情况，还需要先调试接口后，再编写接口返回类型，很令人头疼
+
+借助这个工具，我们可以通过 ts 装饰器来标记请求接口的类和方法，然后动态调用这些接口，并将接口返回的数据转换成 ts 类型文件，这样我们就可以在项目中直接使用了
+
+> 注意：
+>
+> 1. 由于需要使用到ts装饰器特性，而装饰器目前（ts 5.0）不支持直接标记普通函数，所以我们的接口必须以 **接口类+静态api方法** 的形式书写
+> 2. 该工具需要动态执行 ts 代码（import接口类，然后调用标记的静态api方法），因此会通过内置依赖的 `tsx` 执行工具运行，无需额外全局安装 `tsx`。
+
+#### 安装教程
+
+1.npm 安装
+
+```shell
+npm install gen-api-types -D
+
+```
+
+#### 使用说明
+
+##### 1. 标记接口类名和方法
+
+```ts
+import { gen_type_c, gen_type_m } from 'gen-api-types'
+
+@gen_type_c()
+export class TestApi {
+	@gen_type_m({ args: [100], typeName: 'XXX' })
+	static async getList(id: number): Promise<XXX> {
+		return asleep(1000).then(() => {
+			return { name: 'zs', id }
+		})
+	}
+
+	@gen_type_m()
+	static getWeather(): Promise<Response_TestApi_getWeather> {
+		return fetch('http://t.weather.sojson.com/api/weather/city/101030100').then(r => r.json())
+	}
+}
+```
+
+如上面代码所示:
+
+- `@gen_type_c`装饰器函数，用来标记接口类。因为工具会动态分析指定目录下的所有 ts 文件，标记接口类，可以帮助我们快速定位接口类
+- `@gen_type_m`装饰器函数标记需要转换的请求方法。它可以接收一个配置对象，包含两个字段。
+  1.  `typeName: string` 接口返回类型名称，若不指定该字段，默认生成名称为： `Response_${类名}_${方法名}`
+  2.  `args：any[] ` 方法参数列表,工具调用请求方法时，会将参数列表传入
+
+> 注意：
+
+若使用装饰器时ts报错: "运行时将使用 2 个自变量调用修饰器，但修饰器需要 3 个",请将tsconfig中`compilerOptions.experimentalDecorators`设置为`true`
+
+##### 2. 执行命令
+
+```shell
+npx gen-api-types  -o output_dir -O output_file_name ./api_dir1 ./api_dir2
+```
+
+参数说明：
+
+```shell
+ Usage: npx gen-api-types [options] [api_dirs...]
+
+Options:
+  -h, --help                  输出帮助信息
+  -r, --project_root <path>   项目根目录
+  -O, --output_file <path>    输出文件名
+  -o, --output_dir <path>     输出目录
+  -t, --ts_config_path <path> tsconfig.json 文件路径
+  --isExported                生成导出的类型声明
+```
+
+当然，也可以通过配置 package.json 中的 scripts 来使用
+
+```json
+{
+	"scripts": {
+		"gen_types": "gen-api-types -o output_dir -O output_file_name ./api_dir1 ./api_dir2"
+	}
+}
+```
+
+命令输出：
+
+```shell
+🚀 开始生成API类型...
+sourceFilesGlob [ 'src\\**\\*.ts' ]
+📋 处理 TestApi.getList ...
+📋 处理 TestApi.getWeather ...
+请求结果：
+  ┌────────────────┬──────────────────────────────────────┐
+  │ (index)        │ Values                               │
+  ├────────────────┼──────────────────────────────────────┤
+  │ ✔️ successList │ 'TestApi.getList TestApi.getWeather' │
+  │ ❌ errorList   │ ''                                   │
+  └────────────────┴──────────────────────────────────────┘
+✅ API 类型生成完成
+```
+
+##### 3. 使用类型
+
+默认生成类型文件 index.d.ts，且类型声明没有导出
+
+```ts
+type XXX = { name: string };
+type Response_TestApi_getWeather = {...}
+```
+
+可在`tsconfig.json`中配置`include`引用文件
+
+```json
+// tsconfig.json
+{
+	"include": ["index.d.ts"]
+}
+```
+
+或者直接在接口模块文件顶部通过 reference 引用:
+
+```ts
+/// <reference path="./index.d.ts" />
+export class TestApi {
+	@gen_type_m()
+	static getWeather(): Promise<Response_TestApi_getWeather> {
+		return fetch('http://t.weather.sojson.com/api/weather/city/101030100').then(r => r.json())
+	}
+}
+
+//此时data的类型为Response_TestApi_getWeather
+const data = await TestApi.getWeather()
+```
+
+如果希望生成可导出的类型声明，可以在执行命令时添加 `--isExported`：
+
+```shell
+npx gen-api-types --isExported -o output_dir -O output_file_name ./api_dir1 ./api_dir2
+```
+
+生成结果示例：
+
+```ts
+export type XXX = { name: string };
+export type Response_TestApi_getWeather = {...}
+```

package/bin/index.js

@@ -1,31 +1,21 @@
-#!/usr/bin/env node
-
-const { exec,execFile,spawn } = require('child_process');
-const path = require('path');
-const { promisify } = require('util')
-const p_exec = promisify(exec);
-const args = process.argv.slice(2);
-; (async function () {
-
-  try {
-    await p_exec('tsx -v')
-    try {
-      const cli_path = path.resolve(__dirname,'../src/cli/index.ts')
-      // const cli_path = path.resolve(__dirname,'../dist/gen_api_types.cli.min.js')
-
-      const cp = spawn('tsx',[cli_path,...args],{ stdio: 'inherit',shell: true })
-      cp.on('error',err => console.error('执行 tsx 命令失败',err))
-
-
-
-    } catch (error) {
-      // console.error('执行 tsx 命令失败',error)
-    }
-
-
-  } catch (error) {
-    console.error('请安装 tsx',error)
-  }
-
-})();
-
+#!/usr/bin/env node
+
+const { spawn } = require('child_process');
+const path = require('path');
+
+const args = process.argv.slice(2);
+const cliPath = path.resolve(__dirname, '../src/cli/index.ts');
+const tsxCliPath = require.resolve('tsx/cli');
+
+const cp = spawn(process.execPath, [tsxCliPath, cliPath, ...args], {
+  stdio: 'inherit',
+});
+
+cp.on('exit', code => {
+  process.exit(code ?? 1);
+});
+
+cp.on('error', err => {
+  console.error('执行 gen-api-types 失败', err);
+  process.exit(1);
+});