yapi-apifox-to-typescript 4.2.3 → 5.0.1

package/lib/esm/cli.js

@@ -1,257 +1,168 @@
 #!/usr/bin/env node
-import _taggedTemplateLiteralLoose from "@babel/runtime/helpers/esm/taggedTemplateLiteralLoose";
-import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
-
-var _templateObject, _templateObject2;
-
-import _regeneratorRuntime from "@babel/runtime/regenerator";
-import * as TSNode from 'ts-node';
-import consola from 'consola';
-import fs from 'fs-extra';
-import ora from 'ora';
-import path from 'path';
-import prompt from 'prompts';
-import yargs from 'yargs';
-import { dedent, wait } from 'vtils';
-import { Generator } from './Generator';
+import { __require } from "./_virtual/_rolldown/runtime.js";
+import { dedent, wait } from "./mini-ut.js";
+import { Generator } from "./Generator.js";
+import * as TSNode from "ts-node";
+import consola from "consola";
+import fs from "fs-extra";
+import ora from "ora";
+import path from "path";
+import prompt from "prompts";
+import yargs from "yargs";
+//#region src/cli.ts
 TSNode.register({
-  // 不加载本地的 tsconfig.json
-  skipProject: true,
-  // 仅转译，不做类型检查
-  transpileOnly: true,
-  // 自定义编译选项
-  compilerOptions: {
-    strict: false,
-    target: 'es2017',
-    module: 'commonjs',
-    moduleResolution: 'node',
-    declaration: false,
-    removeComments: false,
-    esModuleInterop: true,
-    allowSyntheticDefaultImports: true,
-    importHelpers: false,
-    // 转换 js，支持在 ytt.config.js 里使用最新语法
-    allowJs: true,
-    lib: ['es2017']
-  }
+	skipProject: true,
+	transpileOnly: true,
+	compilerOptions: {
+		strict: false,
+		target: "es2017",
+		module: "commonjs",
+		moduleResolution: "node",
+		declaration: false,
+		removeComments: false,
+		esModuleInterop: true,
+		allowSyntheticDefaultImports: true,
+		importHelpers: false,
+		allowJs: true,
+		lib: ["es2017"]
+	}
 });
-export function run(_x, _x2) {
-  return _run.apply(this, arguments);
+async function run(cmd, options) {
+	let useCustomConfigFile = false;
+	let cwd;
+	let configTSFile;
+	let configJSFile;
+	let configFile;
+	let configFileExist;
+	if (!options?.configFile) {
+		cwd = process.cwd();
+		configTSFile = path.join(cwd, "ytt.config.ts");
+		configJSFile = path.join(cwd, "ytt.config.js");
+		const configTSFileExist = await fs.pathExists(configTSFile);
+		const configJSFileExist = !configTSFileExist && await fs.pathExists(configJSFile);
+		configFileExist = configTSFileExist || configJSFileExist;
+		configFile = configTSFileExist ? configTSFile : configJSFile;
+	} else {
+		useCustomConfigFile = true;
+		configFile = options.configFile;
+		cwd = path.dirname(configFile);
+		configFileExist = await fs.pathExists(configFile);
+	}
+	if (cmd === "help") console.log(`\n${dedent`
+        # 用法
+          初始化配置文件: ytt init
+          生成代码: ytt
+          查看帮助: ytt help
+
+        # GitHub
+          https://github.com/kekexunxun/yapi-to-typescript
+      `}\n`);
+	else if (cmd === "init") {
+		if (configFileExist) {
+			consola.info(`检测到配置文件: ${configFile}`);
+			if (!(await prompt({
+				message: "是否覆盖已有配置文件?",
+				name: "override",
+				type: "confirm"
+			})).override) return;
+		}
+		let outputConfigFile;
+		let outputConfigFileType;
+		if (useCustomConfigFile) {
+			outputConfigFile = configFile;
+			outputConfigFileType = configFile.endsWith(".js") ? "js" : "ts";
+		} else {
+			const answers = await prompt({
+				message: "选择配置文件类型?",
+				name: "configFileType",
+				type: "select",
+				choices: [{
+					title: "TypeScript(ytt.config.ts)",
+					value: "ts"
+				}, {
+					title: "JavaScript(ytt.config.js)",
+					value: "js"
+				}]
+			});
+			outputConfigFile = answers.configFileType === "js" ? configJSFile : configTSFile;
+			outputConfigFileType = answers.configFileType;
+		}
+		await fs.outputFile(outputConfigFile, dedent`
+        import { defineConfig } from 'yapi-apifox-to-typescript'
+
+        export default defineConfig([
+          {
+            serverUrl: 'http://foo.bar',
+            typesOnly: false,
+            target: '${outputConfigFileType === "js" ? "javascript" : "typescript"}',
+            reactHooks: {
+              enabled: false,
+            },
+            prodEnvName: 'production',
+            outputFilePath: 'src/api/index.${outputConfigFileType}',
+            requestFunctionFilePath: 'src/api/request.${outputConfigFileType}',
+            dataKey: 'data',
+            projects: [
+              {
+                token: 'hello',
+                categories: [
+                  {
+                    id: 0,
+                    getRequestFunctionName(interfaceInfo, changeCase) {
+                      // 以接口全路径生成请求函数名
+                      return changeCase.camelCase(interfaceInfo.path)
+
+                      // 若生成的请求函数名存在语法关键词报错、或想通过某个关键词触发 IDE 自动引入提示，可考虑加前缀，如:
+                      // return changeCase.camelCase(\`api_\${interfaceInfo.path}\`)
+
+                      // 若生成的请求函数名有重复报错，可考虑将接口请求方式纳入生成条件，如:
+                      // return changeCase.camelCase(\`\${interfaceInfo.method}_\${interfaceInfo.path}\`)
+                    },
+                  },
+                ],
+              },
+            ],
+          },
+        ])
+      `);
+		consola.success("写入配置文件完毕");
+	} else {
+		if (!configFileExist) return consola.error(`找不到配置文件: ${useCustomConfigFile ? configFile : `${configTSFile} 或 ${configJSFile}`}`);
+		consola.success(`找到配置文件: ${configFile}`);
+		let config;
+		let generator;
+		let spinner;
+		try {
+			config = __require(configFile).default;
+			generator = new Generator(config, { cwd });
+			spinner = ora("正在获取数据并生成代码...").start();
+			const delayNotice = wait(5e3);
+			delayNotice.then(() => {
+				spinner.text = `正在获取数据并生成代码... (若长时间处于此状态，请检查是否有接口定义的数据过大导致拉取或解析缓慢)`;
+			});
+			await generator.prepare();
+			delayNotice.cancel();
+			const output = await generator.generate();
+			spinner.stop();
+			consola.success("获取数据并生成代码完毕");
+			await generator.write(output);
+			consola.success("写入文件完毕");
+			await generator.destroy();
+			await config.hooks?.success?.();
+		} catch (err) {
+			spinner?.stop();
+			await generator?.destroy();
+			await config?.hooks?.fail?.();
+			/* istanbul ignore next */
+			consola.error(err);
+		}
+		await config?.hooks?.complete?.();
+	}
 }
 /* istanbul ignore next */
-
-function _run() {
-  _run = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(cmd, options) {
-    var useCustomConfigFile, cwd, configTSFile, configJSFile, configFile, configFileExist, configTSFileExist, configJSFileExist, answers, outputConfigFile, outputConfigFileType, _answers, _config2, _config2$hooks, config, generator, spinner, _hooks, delayNotice, output, _spinner, _generator, _config, _config$hooks;
-
-    return _regeneratorRuntime.wrap(function _callee$(_context) {
-      while (1) {
-        switch (_context.prev = _context.next) {
-          case 0:
-            useCustomConfigFile = false;
-
-            if (options != null && options.configFile) {
-              _context.next = 18;
-              break;
-            }
-
-            cwd = process.cwd();
-            configTSFile = path.join(cwd, 'ytt.config.ts');
-            configJSFile = path.join(cwd, 'ytt.config.js');
-            _context.next = 7;
-            return fs.pathExists(configTSFile);
-
-          case 7:
-            configTSFileExist = _context.sent;
-            _context.t0 = !configTSFileExist;
-
-            if (!_context.t0) {
-              _context.next = 13;
-              break;
-            }
-
-            _context.next = 12;
-            return fs.pathExists(configJSFile);
-
-          case 12:
-            _context.t0 = _context.sent;
-
-          case 13:
-            configJSFileExist = _context.t0;
-            configFileExist = configTSFileExist || configJSFileExist;
-            configFile = configTSFileExist ? configTSFile : configJSFile;
-            _context.next = 24;
-            break;
-
-          case 18:
-            useCustomConfigFile = true;
-            configFile = options.configFile;
-            cwd = path.dirname(configFile);
-            _context.next = 23;
-            return fs.pathExists(configFile);
-
-          case 23:
-            configFileExist = _context.sent;
-
-          case 24:
-            if (!(cmd === 'help')) {
-              _context.next = 28;
-              break;
-            }
-
-            console.log("\n" + dedent(_templateObject || (_templateObject = _taggedTemplateLiteralLoose(["\n        # \u7528\u6CD5\n          \u521D\u59CB\u5316\u914D\u7F6E\u6587\u4EF6: ytt init\n          \u751F\u6210\u4EE3\u7801: ytt\n          \u67E5\u770B\u5E2E\u52A9: ytt help\n\n        # GitHub\n          https://github.com/kekexunxun/yapi-to-typescript\n      "]))) + "\n");
-            _context.next = 87;
-            break;
-
-          case 28:
-            if (!(cmd === 'init')) {
-              _context.next = 51;
-              break;
-            }
-
-            if (!configFileExist) {
-              _context.next = 36;
-              break;
-            }
-
-            consola.info("\u68C0\u6D4B\u5230\u914D\u7F6E\u6587\u4EF6: " + configFile);
-            _context.next = 33;
-            return prompt({
-              message: '是否覆盖已有配置文件?',
-              name: 'override',
-              type: 'confirm'
-            });
-
-          case 33:
-            answers = _context.sent;
-
-            if (answers.override) {
-              _context.next = 36;
-              break;
-            }
-
-            return _context.abrupt("return");
-
-          case 36:
-            if (!useCustomConfigFile) {
-              _context.next = 41;
-              break;
-            }
-
-            outputConfigFile = configFile;
-            outputConfigFileType = configFile.endsWith('.js') ? 'js' : 'ts';
-            _context.next = 46;
-            break;
-
-          case 41:
-            _context.next = 43;
-            return prompt({
-              message: '选择配置文件类型?',
-              name: 'configFileType',
-              type: 'select',
-              choices: [{
-                title: 'TypeScript(ytt.config.ts)',
-                value: 'ts'
-              }, {
-                title: 'JavaScript(ytt.config.js)',
-                value: 'js'
-              }]
-            });
-
-          case 43:
-            _answers = _context.sent;
-            outputConfigFile = _answers.configFileType === 'js' ? configJSFile : configTSFile;
-            outputConfigFileType = _answers.configFileType;
-
-          case 46:
-            _context.next = 48;
-            return fs.outputFile(outputConfigFile, dedent(_templateObject2 || (_templateObject2 = _taggedTemplateLiteralLoose(["\n        import { defineConfig } from 'yapi-apifox-to-typescript'\n\n        export default defineConfig([\n          {\n            serverUrl: 'http://foo.bar',\n            typesOnly: false,\n            target: '", "',\n            reactHooks: {\n              enabled: false,\n            },\n            prodEnvName: 'production',\n            outputFilePath: 'src/api/index.", "',\n            requestFunctionFilePath: 'src/api/request.", "',\n            dataKey: 'data',\n            projects: [\n              {\n                token: 'hello',\n                categories: [\n                  {\n                    id: 0,\n                    getRequestFunctionName(interfaceInfo, changeCase) {\n                      // \u4EE5\u63A5\u53E3\u5168\u8DEF\u5F84\u751F\u6210\u8BF7\u6C42\u51FD\u6570\u540D\n                      return changeCase.camelCase(interfaceInfo.path)\n\n                      // \u82E5\u751F\u6210\u7684\u8BF7\u6C42\u51FD\u6570\u540D\u5B58\u5728\u8BED\u6CD5\u5173\u952E\u8BCD\u62A5\u9519\u3001\u6216\u60F3\u901A\u8FC7\u67D0\u4E2A\u5173\u952E\u8BCD\u89E6\u53D1 IDE \u81EA\u52A8\u5F15\u5165\u63D0\u793A\uFF0C\u53EF\u8003\u8651\u52A0\u524D\u7F00\uFF0C\u5982:\n                      // return changeCase.camelCase(`api_${interfaceInfo.path}`)\n\n                      // \u82E5\u751F\u6210\u7684\u8BF7\u6C42\u51FD\u6570\u540D\u6709\u91CD\u590D\u62A5\u9519\uFF0C\u53EF\u8003\u8651\u5C06\u63A5\u53E3\u8BF7\u6C42\u65B9\u5F0F\u7EB3\u5165\u751F\u6210\u6761\u4EF6\uFF0C\u5982:\n                      // return changeCase.camelCase(`${interfaceInfo.method}_${interfaceInfo.path}`)\n                    },\n                  },\n                ],\n              },\n            ],\n          },\n        ])\n      "], ["\n        import { defineConfig } from 'yapi-apifox-to-typescript'\n\n        export default defineConfig([\n          {\n            serverUrl: 'http://foo.bar',\n            typesOnly: false,\n            target: '", "',\n            reactHooks: {\n              enabled: false,\n            },\n            prodEnvName: 'production',\n            outputFilePath: 'src/api/index.", "',\n            requestFunctionFilePath: 'src/api/request.", "',\n            dataKey: 'data',\n            projects: [\n              {\n                token: 'hello',\n                categories: [\n                  {\n                    id: 0,\n                    getRequestFunctionName(interfaceInfo, changeCase) {\n                      // \u4EE5\u63A5\u53E3\u5168\u8DEF\u5F84\u751F\u6210\u8BF7\u6C42\u51FD\u6570\u540D\n                      return changeCase.camelCase(interfaceInfo.path)\n\n                      // \u82E5\u751F\u6210\u7684\u8BF7\u6C42\u51FD\u6570\u540D\u5B58\u5728\u8BED\u6CD5\u5173\u952E\u8BCD\u62A5\u9519\u3001\u6216\u60F3\u901A\u8FC7\u67D0\u4E2A\u5173\u952E\u8BCD\u89E6\u53D1 IDE \u81EA\u52A8\u5F15\u5165\u63D0\u793A\uFF0C\u53EF\u8003\u8651\u52A0\u524D\u7F00\uFF0C\u5982:\n                      // return changeCase.camelCase(\\`api_\\${interfaceInfo.path}\\`)\n\n                      // \u82E5\u751F\u6210\u7684\u8BF7\u6C42\u51FD\u6570\u540D\u6709\u91CD\u590D\u62A5\u9519\uFF0C\u53EF\u8003\u8651\u5C06\u63A5\u53E3\u8BF7\u6C42\u65B9\u5F0F\u7EB3\u5165\u751F\u6210\u6761\u4EF6\uFF0C\u5982:\n                      // return changeCase.camelCase(\\`\\${interfaceInfo.method}_\\${interfaceInfo.path}\\`)\n                    },\n                  },\n                ],\n              },\n            ],\n          },\n        ])\n      "])), outputConfigFileType === 'js' ? 'javascript' : 'typescript', outputConfigFileType, outputConfigFileType));
-
-          case 48:
-            consola.success('写入配置文件完毕');
-            _context.next = 87;
-            break;
-
-          case 51:
-            if (configFileExist) {
-              _context.next = 53;
-              break;
-            }
-
-            return _context.abrupt("return", consola.error("\u627E\u4E0D\u5230\u914D\u7F6E\u6587\u4EF6: " + (useCustomConfigFile ? configFile : configTSFile + " \u6216 " + configJSFile)));
-
-          case 53:
-            consola.success("\u627E\u5230\u914D\u7F6E\u6587\u4EF6: " + configFile);
-            _context.prev = 54;
-            config = require(configFile).default;
-            generator = new Generator(config, {
-              cwd: cwd
-            });
-            spinner = ora('正在获取数据并生成代码...').start();
-            delayNotice = wait(5000);
-            delayNotice.then(function () {
-              spinner.text = "\u6B63\u5728\u83B7\u53D6\u6570\u636E\u5E76\u751F\u6210\u4EE3\u7801... (\u82E5\u957F\u65F6\u95F4\u5904\u4E8E\u6B64\u72B6\u6001\uFF0C\u8BF7\u68C0\u67E5\u662F\u5426\u6709\u63A5\u53E3\u5B9A\u4E49\u7684\u6570\u636E\u8FC7\u5927\u5BFC\u81F4\u62C9\u53D6\u6216\u89E3\u6790\u7F13\u6162)";
-            });
-            _context.next = 62;
-            return generator.prepare();
-
-          case 62:
-            delayNotice.cancel();
-            _context.next = 65;
-            return generator.generate();
-
-          case 65:
-            output = _context.sent;
-            spinner.stop();
-            consola.success('获取数据并生成代码完毕');
-            _context.next = 70;
-            return generator.write(output);
-
-          case 70:
-            consola.success('写入文件完毕');
-            _context.next = 73;
-            return generator.destroy();
-
-          case 73:
-            _context.next = 75;
-            return (_hooks = config.hooks) == null ? void 0 : _hooks.success == null ? void 0 : _hooks.success();
-
-          case 75:
-            _context.next = 85;
-            break;
-
-          case 77:
-            _context.prev = 77;
-            _context.t1 = _context["catch"](54);
-            (_spinner = spinner) == null ? void 0 : _spinner.stop();
-            _context.next = 82;
-            return (_generator = generator) == null ? void 0 : _generator.destroy();
-
-          case 82:
-            _context.next = 84;
-            return (_config = config) == null ? void 0 : (_config$hooks = _config.hooks) == null ? void 0 : _config$hooks.fail == null ? void 0 : _config$hooks.fail();
-
-          case 84:
-            /* istanbul ignore next */
-            consola.error(_context.t1);
-
-          case 85:
-            _context.next = 87;
-            return (_config2 = config) == null ? void 0 : (_config2$hooks = _config2.hooks) == null ? void 0 : _config2$hooks.complete == null ? void 0 : _config2$hooks.complete();
-
-          case 87:
-          case "end":
-            return _context.stop();
-        }
-      }
-    }, _callee, null, [[54, 77]]);
-  }));
-  return _run.apply(this, arguments);
+if (__require.main === module) {
+	const argv = yargs(process.argv).help(false).version(false).alias("c", "config").parseSync();
+	run(argv._[2], { configFile: argv.config ? path.resolve(process.cwd(), argv.config) : void 0 });
 }
-
-if (require.main === module) {
-  var argv = yargs(process.argv).alias('c', 'config').argv;
-  run(argv._[2], {
-    configFile: argv.config ? path.resolve(process.cwd(), argv.config) : undefined
-  });
-}
+//#endregion
+export { run };

package/lib/esm/helpers.d.ts

@@ -0,0 +1,49 @@
+import { CliHooks, Config, ConfigWithHooks, RequestConfig, RequestFunctionParams } from './types';
+import { AppendOptions } from 'form-data';
+/**
+ * 定义配置。
+ *
+ * @param config 配置
+ */
+export declare function defineConfig(config: Config, hooks?: CliHooks): ConfigWithHooks;
+export declare class FileData<T = any> {
+    /**
+     * 原始文件数据。
+     */
+    private originalFileData;
+    /**
+     * 选项。
+     */
+    private options;
+    /**
+     * 文件数据辅助类，统一网页、小程序等平台的文件上传。
+     *
+     * @param originalFileData 原始文件数据
+     * @param options 若使用内部的 getFormData，则选项会被其使用
+     */
+    constructor(originalFileData: T, options?: AppendOptions);
+    /**
+     * 获取原始文件数据。
+     *
+     * @returns 原始文件数据
+     */
+    getOriginalFileData(): T;
+    /**
+     * 获取选项。
+     */
+    getOptions(): AppendOptions | undefined;
+}
+/**
+ * 解析请求数据，从请求数据中分离出普通数据和文件数据。
+ *
+ * @param requestData 要解析的请求数据
+ * @returns 包含普通数据(data)和文件数据(fileData)的对象，data、fileData 为空对象时，表示没有此类数据
+ */
+export declare function parseRequestData(requestData?: any): {
+    data: any;
+    fileData: any;
+};
+/**
+ * 准备要传给请求函数的参数。
+ */
+export declare function prepare(requestConfig: RequestConfig, requestData: any): RequestFunctionParams;