gen-api-types 1.0.8 → 1.0.10

package/README.en.md

@@ -51,6 +51,10 @@ As shown in the code above:
   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

package/README.md

@@ -52,6 +52,10 @@ export class TestApi {
   1.  `typeName: string` 接口返回类型名称，若不指定该字段，默认生成名称为： `Response_${类名}_${方法名}`
   2.  `args：any[] ` 方法参数列表,工具调用请求方法时，会将参数列表传入
 
+> 注意：
+
+若使用装饰器时ts报错: "运行时将使用 2 个自变量调用修饰器，但修饰器需要 3 个",请将tsconfig中`compilerOptions.experimentalDecorators`设置为`true`
+
 ##### 2. 执行命令
 
 ```shell

package/bin/index.js

@@ -1,8 +1,12 @@
 #!/usr/bin/env node
 
-const { spawn } = require('child_process');
-const path = require('path');
+import { spawn } from 'node:child_process';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { createRequire } from 'node:module';
 
+const require = createRequire(import.meta.url);
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const args = process.argv.slice(2);
 const cliPath = path.resolve(__dirname, '../src/cli/index.ts');
 const tsxCliPath = require.resolve('tsx/cli');

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "gen-api-types",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "一个自动生成请求接口返回类型的 cli 小工具",
   "main": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "type": "module",
   "bin": {
     "gen-api-types": "bin/index.js",
     "gat": "bin/index.js"

package/src/argv/index.ts

@@ -50,7 +50,7 @@ export const { positionals, values: { project_root, output_file, output_dir, ts_
 
 if (help) {
   console.log(`
-  Usage: tsx cli.js [options] [positionals]
+  gen-api-types [options] [positionals
 
   Options:
     -h, --help                  输出帮助信息

package/src/constant/index.ts

@@ -1,3 +1,5 @@
 export const GEN_TYPE_METADATA_KEY = Symbol('gen:type:metadata');
+/** 标记方法的装饰器名称 */
 export const M_DECO_NAME = 'gen_type_m';
+/** 标记类的装饰器名称 */
 export const C_DECO_NAME = 'gen_type_c';

package/src/decotators/index.ts

@@ -25,7 +25,6 @@ export function gen_type_m({ args = [], typeName }: GenTypeOptions = {}) {
 
 /**
  * 标记类
- * @returns 
  */
 export function gen_type_c() {
   return function <T>(target: T) {

package/src/index.ts

@@ -1,2 +1,3 @@
+export { C_DECO_NAME, M_DECO_NAME } from './constant';
 export * from './decotators';
 

package/tsconfig.json

@@ -1,9 +1,9 @@
 {
 	"exclude": [],
-	"include": ["src", "test"],
+	"include": ["src", "test"], //把这些源码/声明文件加入项目
 	"compilerOptions": {
 		/* Visit https://aka.ms/tsconfig to read more about this file */
-		"types": ["node"],
+		"types": ["node"], //它主要用来控制自动引入哪些 @types 包 或类型包
 		/* Projects */
 		// "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
 		// "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */