open-api-typescript-request-generator 0.0.1

package/es/cli.d.ts

@@ -0,0 +1,19 @@
+#!/usr/bin/env ts-node
+import yargs from 'yargs';
+export declare function getConfig(): Promise<{
+    cwd: string;
+    configFileExist: boolean;
+    configFile: string;
+    configTSFile: string;
+    configTSLocalFile: string;
+    configTSFileExist: boolean;
+}>;
+export declare function genConfig(): Promise<void>;
+export declare function start(): Promise<void>;
+export default class CLI {
+    argvs: any;
+    run(args: any, callback?: yargs.ParseCallback): {
+        [x: string]: any;
+    };
+    init(): yargs.Argv<any>;
+}

package/es/cli.js

@@ -0,0 +1,547 @@
+#!/usr/bin/env ts-node
+"use strict";
+
+var __makeTemplateObject = this && this.__makeTemplateObject || function (cooked, raw) {
+  if (Object.defineProperty) {
+    Object.defineProperty(cooked, "raw", {
+      value: raw
+    });
+  } else {
+    cooked.raw = raw;
+  }
+
+  return cooked;
+};
+
+var __createBinding = this && this.__createBinding || (Object.create ? function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  var desc = Object.getOwnPropertyDescriptor(m, k);
+
+  if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+    desc = {
+      enumerable: true,
+      get: function get() {
+        return m[k];
+      }
+    };
+  }
+
+  Object.defineProperty(o, k2, desc);
+} : function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  o[k2] = m[k];
+});
+
+var __setModuleDefault = this && this.__setModuleDefault || (Object.create ? function (o, v) {
+  Object.defineProperty(o, "default", {
+    enumerable: true,
+    value: v
+  });
+} : function (o, v) {
+  o["default"] = v;
+});
+
+var __importStar = this && this.__importStar || function (mod) {
+  if (mod && mod.__esModule) return mod;
+  var result = {};
+  if (mod != null) for (var k in mod) {
+    if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+  }
+
+  __setModuleDefault(result, mod);
+
+  return result;
+};
+
+var __awaiter = this && this.__awaiter || function (thisArg, _arguments, P, generator) {
+  function adopt(value) {
+    return value instanceof P ? value : new P(function (resolve) {
+      resolve(value);
+    });
+  }
+
+  return new (P || (P = Promise))(function (resolve, reject) {
+    function fulfilled(value) {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+
+    function rejected(value) {
+      try {
+        step(generator["throw"](value));
+      } catch (e) {
+        reject(e);
+      }
+    }
+
+    function step(result) {
+      result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
+    }
+
+    step((generator = generator.apply(thisArg, _arguments || [])).next());
+  });
+};
+
+var __generator = this && this.__generator || function (thisArg, body) {
+  var _ = {
+    label: 0,
+    sent: function sent() {
+      if (t[0] & 1) throw t[1];
+      return t[1];
+    },
+    trys: [],
+    ops: []
+  },
+      f,
+      y,
+      t,
+      g;
+  return g = {
+    next: verb(0),
+    "throw": verb(1),
+    "return": verb(2)
+  }, typeof Symbol === "function" && (g[Symbol.iterator] = function () {
+    return this;
+  }), g;
+
+  function verb(n) {
+    return function (v) {
+      return step([n, v]);
+    };
+  }
+
+  function step(op) {
+    if (f) throw new TypeError("Generator is already executing.");
+
+    while (_) {
+      try {
+        if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+        if (y = 0, t) op = [op[0] & 2, t.value];
+
+        switch (op[0]) {
+          case 0:
+          case 1:
+            t = op;
+            break;
+
+          case 4:
+            _.label++;
+            return {
+              value: op[1],
+              done: false
+            };
+
+          case 5:
+            _.label++;
+            y = op[1];
+            op = [0];
+            continue;
+
+          case 7:
+            op = _.ops.pop();
+
+            _.trys.pop();
+
+            continue;
+
+          default:
+            if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+              _ = 0;
+              continue;
+            }
+
+            if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+              _.label = op[1];
+              break;
+            }
+
+            if (op[0] === 6 && _.label < t[1]) {
+              _.label = t[1];
+              t = op;
+              break;
+            }
+
+            if (t && _.label < t[2]) {
+              _.label = t[2];
+
+              _.ops.push(op);
+
+              break;
+            }
+
+            if (t[2]) _.ops.pop();
+
+            _.trys.pop();
+
+            continue;
+        }
+
+        op = body.call(thisArg, _);
+      } catch (e) {
+        op = [6, e];
+        y = 0;
+      } finally {
+        f = t = 0;
+      }
+    }
+
+    if (op[0] & 5) throw op[1];
+    return {
+      value: op[0] ? op[1] : void 0,
+      done: true
+    };
+  }
+};
+
+var __importDefault = this && this.__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.start = exports.genConfig = exports.getConfig = void 0;
+
+var TSNode = __importStar(require("ts-node"));
+
+var fs_extra_1 = __importDefault(require("fs-extra"));
+
+var path_1 = __importDefault(require("path"));
+
+var prompts_1 = __importDefault(require("prompts"));
+
+var yargs_1 = __importDefault(require("yargs"));
+
+var vtils_1 = require("vtils");
+
+var Generator_1 = require("./Generator");
+
+var yargs_parser_1 = __importDefault(require("yargs-parser"));
+
+var chalk_1 = __importDefault(require("chalk"));
+
+var conso = __importStar(require("./console"));
+
+var utils_1 = require("./utils");
+
+var genIndex_1 = require("./genIndex");
+
+var spinner_1 = require("./spinner");
+
+var helpers_1 = require("./helpers");
+
+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，支持在 apits.config.js 里使用最新语法
+    allowJs: true,
+    lib: ['es2017']
+  }
+});
+
+function getConfig() {
+  return __awaiter(this, void 0, void 0, function () {
+    var cwd, configTSFile, configTSLocalFile, configTSLocalFileExist, configTSFileExist, configFileExist, configFile;
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          cwd = process.cwd();
+          configTSFile = path_1.default.join(cwd, 'apits.config.ts');
+          configTSLocalFile = path_1.default.join(cwd, 'apits.config.local.ts');
+          return [4
+          /*yield*/
+          , fs_extra_1.default.pathExists(configTSLocalFile)];
+
+        case 1:
+          configTSLocalFileExist = _a.sent();
+          return [4
+          /*yield*/
+          , fs_extra_1.default.pathExists(configTSFile)];
+
+        case 2:
+          configTSFileExist = _a.sent();
+          configFileExist = configTSLocalFileExist || configTSFileExist;
+          configFile = configTSLocalFileExist ? configTSLocalFile : configTSFile || '';
+          return [2
+          /*return*/
+          , {
+            cwd: cwd,
+            configFileExist: configFileExist,
+            configFile: configFile,
+            configTSFile: configTSFile,
+            configTSLocalFile: configTSLocalFile,
+            configTSFileExist: configTSFileExist
+          }];
+      }
+    });
+  });
+}
+
+exports.getConfig = getConfig;
+
+function genConfig() {
+  return __awaiter(this, void 0, void 0, function () {
+    var _a, configTSFile, configTSFileExist, answers, swaggerAnswers;
+
+    return __generator(this, function (_b) {
+      switch (_b.label) {
+        case 0:
+          return [4
+          /*yield*/
+          , getConfig()];
+
+        case 1:
+          _a = _b.sent(), configTSFile = _a.configTSFile, configTSFileExist = _a.configTSFileExist;
+          if (!configTSFileExist) return [3
+          /*break*/
+          , 3];
+          conso.tips("\u68C0\u6D4B\u5230\u914D\u7F6E\u6587\u4EF6: ".concat(configTSFile));
+          return [4
+          /*yield*/
+          , (0, prompts_1.default)({
+            message: '是否覆盖已有配置文件?',
+            name: 'override',
+            type: 'confirm'
+          })];
+
+        case 2:
+          answers = _b.sent();
+          if (!answers.override) return [2
+          /*return*/
+          ];
+          _b.label = 3;
+
+        case 3:
+          return [4
+          /*yield*/
+          , (0, prompts_1.default)([{
+            message: '接口信息服务地址',
+            name: 'url',
+            type: 'text',
+            initial: ''
+          }])];
+
+        case 4:
+          swaggerAnswers = _b.sent();
+          return [4
+          /*yield*/
+          , fs_extra_1.default.outputFile(configTSFile, (0, utils_1.formatContent)((0, vtils_1.dedent)(templateObject_1 || (templateObject_1 = __makeTemplateObject(["\n      import { defineConfig } from 'api-ts-generator'\n\n      export default defineConfig([{\n        serverUrl: '", "',\n        outputFilePath: 'src/api'\n      }])\n    "], ["\n      import { defineConfig } from 'api-ts-generator'\n\n      export default defineConfig([{\n        serverUrl: '", "',\n        outputFilePath: 'src/api'\n      }])\n    "])), (swaggerAnswers === null || swaggerAnswers === void 0 ? void 0 : swaggerAnswers.url) || '')))];
+
+        case 5:
+          _b.sent();
+
+          conso.success('写入配置文件完毕');
+          return [2
+          /*return*/
+          ];
+      }
+    });
+  });
+}
+
+exports.genConfig = genConfig;
+
+function startGenerate(config, cwd, index) {
+  if (index === void 0) {
+    index = 0;
+  }
+
+  return __awaiter(this, void 0, void 0, function () {
+    var outputFilePath, label, generator, output;
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          outputFilePath = config.outputFilePath;
+          label = chalk_1.default.green("".concat(config.serverUrl, "\u8017\u65F6"));
+          console.time(label);
+          spinner_1.spinnerInstance.start();
+          generator = new Generator_1.Generator(config, {
+            cwd: cwd
+          });
+          return [4
+          /*yield*/
+          , generator.generate()];
+
+        case 1:
+          output = _a.sent();
+          return [4
+          /*yield*/
+          , generator.write(output)];
+
+        case 2:
+          _a.sent();
+
+          spinner_1.spinnerInstance.clear();
+          conso.log(chalk_1.default.yellowBright("\n".concat(index + 1, ".-------------------------")));
+          conso.success("\u4EE3\u7801\u751F\u6210\u6210\u529F\uFF0C\u6587\u4EF6\u8DEF\u5F84\uFF1A".concat(outputFilePath));
+          console.timeEnd(label);
+          conso.log(chalk_1.default.yellowBright('---------------------------\n')); // spinnerInstance.render();
+
+          return [4
+          /*yield*/
+          , generator.destroy()];
+
+        case 3:
+          // spinnerInstance.render();
+          _a.sent();
+
+          return [2
+          /*return*/
+          , true];
+      }
+    });
+  });
+}
+
+function start() {
+  return __awaiter(this, void 0, void 0, function () {
+    var timeLabel, _a, cwd, configFileExist, configFile, configTSFile, config, err_1;
+
+    var _this = this;
+
+    return __generator(this, function (_b) {
+      switch (_b.label) {
+        case 0:
+          timeLabel = chalk_1.default.green('总耗时');
+          console.time(timeLabel);
+          return [4
+          /*yield*/
+          , getConfig()];
+
+        case 1:
+          _a = _b.sent(), cwd = _a.cwd, configFileExist = _a.configFileExist, configFile = _a.configFile, configTSFile = _a.configTSFile;
+
+          if (!configFileExist) {
+            return [2
+            /*return*/
+            , conso.error("\u672A\u53D1\u73B0\u914D\u7F6E\u6587\u4EF6: ".concat(configFile))];
+          }
+
+          conso.tips("\u53D1\u73B0\u914D\u7F6E\u6587\u4EF6: ".concat(configFile));
+          _b.label = 2;
+
+        case 2:
+          _b.trys.push([2, 4,, 5]);
+
+          config = require(configFile).default;
+          spinner_1.spinnerInstance.start('正在获取数据并生成代码... \n');
+          return [4
+          /*yield*/
+          , (0, helpers_1.asyncFnArrayOrderRun)(config.map(function (configItem, index) {
+            return function () {
+              return __awaiter(_this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                  switch (_a.label) {
+                    case 0:
+                      return [4
+                      /*yield*/
+                      , (0, genIndex_1.prepareIndexFile)(configItem)];
+
+                    case 1:
+                      _a.sent();
+
+                      configItem.configIndex = index;
+                      return [4
+                      /*yield*/
+                      , startGenerate(configItem, cwd, index)];
+
+                    case 2:
+                      _a.sent();
+
+                      return [2
+                      /*return*/
+                      ];
+                  }
+                });
+              });
+            };
+          }))];
+
+        case 3:
+          _b.sent();
+
+          spinner_1.spinnerInstance.stop();
+          return [3
+          /*break*/
+          , 5];
+
+        case 4:
+          err_1 = _b.sent();
+          spinner_1.spinnerInstance.stop();
+          console.error('\n❌ 执行过程中发生错误:');
+          console.error('错误信息:', err_1.message || err_1);
+
+          if (err_1.stack) {
+            console.error('错误堆栈:');
+            console.error(err_1.stack);
+          }
+
+          if (err_1.cause) {
+            console.error('错误原因:', err_1.cause);
+          }
+
+          return [2
+          /*return*/
+          , conso.error('代码生成失败，请查看上方错误信息')];
+
+        case 5:
+          console.timeEnd(timeLabel);
+          return [2
+          /*return*/
+          , null];
+      }
+    });
+  });
+}
+
+exports.start = start;
+
+var CLI =
+/** @class */
+function () {
+  function CLI() {}
+
+  CLI.prototype.run = function (args, callback) {
+    this.argvs = (0, yargs_parser_1.default)(args);
+    var cli = this.init();
+
+    if (args.length === 0) {
+      cli.showHelp();
+    }
+
+    return cli.parse(args);
+  };
+
+  CLI.prototype.init = function () {
+    return yargs_1.default.scriptName('apits-gener').usage('Usage: $0 <command> [options]').command('gen', '生成接口类型声明和方法', function (y) {}, function (argv) {
+      var _a = argv;
+      start();
+    }).command('init', '生成配置文件', function (y) {}, function (argv) {
+      var _a = argv;
+      genConfig();
+    }).help();
+  };
+
+  return CLI;
+}();
+
+exports.default = CLI;
+var templateObject_1;

package/es/console.d.ts

@@ -0,0 +1,48 @@
+import { ConsolaLogObject } from 'consola';
+/**
+ * 普通提示
+ * @param message
+ * @param args
+ */
+export declare function log(message: ConsolaLogObject | any, ...args: any[]): void;
+/**
+ * 错误提示
+ * @param message
+ * @param args
+ */
+export declare function error(message: ConsolaLogObject | any, ...args: any[]): void;
+/**
+ * 信息提示
+ * @param message
+ * @param args
+ */
+export declare function info(message: ConsolaLogObject | any, ...args: any[]): void;
+/**
+ * 警告信息提示
+ * @param message
+ * @param args
+ */
+export declare function warn(message: ConsolaLogObject | any, ...args: any[]): void;
+/**
+ * 弱提示
+ * @param message
+ * @param args
+ */
+export declare function tips(message: ConsolaLogObject | any, ...args: any[]): void;
+/**
+ * 成功提示
+ * @param message
+ * @param args
+ */
+export declare function success(message: ConsolaLogObject | any, ...args: any[]): void;
+/**
+ * table展示信息
+ * @param tabularData
+ * @param properties
+ */
+export declare function table(tabularData: any, properties?: ReadonlyArray<string>): void;
+/**
+ * 空行
+ * @param blank
+ */
+export declare function line(blank?: boolean): void;