yapi-to-typescript2 1.0.0

package/lib/esm/SwaggerToYApiServer.js

@@ -0,0 +1,317 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import getAvailablePort from 'get-port';
+import http from 'http';
+import onExit from 'signal-exit';
+import url from 'url';
+import { httpGet } from './utils';
+import { isEmpty } from 'vtils';
+import { swaggerJsonToYApiData } from './swaggerJsonToYApiData';
+export var SwaggerToYApiServer = /*#__PURE__*/function () {
+  function SwaggerToYApiServer(options) {
+    this.options = options;
+    this.port = 0;
+    this.swaggerJson = {};
+    this.httpServer = null;
+    this.yapiData = {};
+  }
+
+  var _proto = SwaggerToYApiServer.prototype;
+
+  _proto.getPort = /*#__PURE__*/function () {
+    var _getPort = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+      return _regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              if (!(this.port === 0)) {
+                _context.next = 4;
+                break;
+              }
+
+              _context.next = 3;
+              return getAvailablePort({
+                port: 50505
+              });
+
+            case 3:
+              this.port = _context.sent;
+
+            case 4:
+              return _context.abrupt("return", this.port);
+
+            case 5:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee, this);
+    }));
+
+    function getPort() {
+      return _getPort.apply(this, arguments);
+    }
+
+    return getPort;
+  }();
+
+  _proto.getUrl = /*#__PURE__*/function () {
+    var _getUrl = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
+      return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+        while (1) {
+          switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.next = 2;
+              return this.getPort();
+
+            case 2:
+              _context2.t0 = _context2.sent;
+              return _context2.abrupt("return", "http://127.0.0.1:" + _context2.t0);
+
+            case 4:
+            case "end":
+              return _context2.stop();
+          }
+        }
+      }, _callee2, this);
+    }));
+
+    function getUrl() {
+      return _getUrl.apply(this, arguments);
+    }
+
+    return getUrl;
+  }();
+
+  _proto.getSwaggerJson = /*#__PURE__*/function () {
+    var _getSwaggerJson = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
+      var res;
+      return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              if (!isEmpty(this.swaggerJson)) {
+                _context3.next = 5;
+                break;
+              }
+
+              _context3.next = 3;
+              return httpGet(this.options.swaggerJsonUrl);
+
+            case 3:
+              res = _context3.sent;
+              this.swaggerJson = res;
+
+            case 5:
+              return _context3.abrupt("return", this.swaggerJson);
+
+            case 6:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3, this);
+    }));
+
+    function getSwaggerJson() {
+      return _getSwaggerJson.apply(this, arguments);
+    }
+
+    return getSwaggerJson;
+  }();
+
+  _proto.getYApiData = /*#__PURE__*/function () {
+    var _getYApiData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4() {
+      return _regeneratorRuntime.wrap(function _callee4$(_context4) {
+        while (1) {
+          switch (_context4.prev = _context4.next) {
+            case 0:
+              if (!isEmpty(this.yapiData)) {
+                _context4.next = 8;
+                break;
+              }
+
+              _context4.t0 = swaggerJsonToYApiData;
+              _context4.next = 4;
+              return this.getSwaggerJson();
+
+            case 4:
+              _context4.t1 = _context4.sent;
+              _context4.next = 7;
+              return (0, _context4.t0)(_context4.t1);
+
+            case 7:
+              this.yapiData = _context4.sent;
+
+            case 8:
+              return _context4.abrupt("return", this.yapiData);
+
+            case 9:
+            case "end":
+              return _context4.stop();
+          }
+        }
+      }, _callee4, this);
+    }));
+
+    function getYApiData() {
+      return _getYApiData.apply(this, arguments);
+    }
+
+    return getYApiData;
+  }();
+
+  _proto.start = /*#__PURE__*/function () {
+    var _start = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee7() {
+      var _this = this;
+
+      var yapiData;
+      return _regeneratorRuntime.wrap(function _callee7$(_context7) {
+        while (1) {
+          switch (_context7.prev = _context7.next) {
+            case 0:
+              _context7.next = 2;
+              return this.getYApiData();
+
+            case 2:
+              yapiData = _context7.sent;
+              _context7.next = 5;
+              return new Promise( /*#__PURE__*/function () {
+                var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee6(resolve) {
+                  return _regeneratorRuntime.wrap(function _callee6$(_context6) {
+                    while (1) {
+                      switch (_context6.prev = _context6.next) {
+                        case 0:
+                          _context6.t0 = http.createServer( /*#__PURE__*/function () {
+                            var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(req, res) {
+                              var _url$parse, pathname;
+
+                              return _regeneratorRuntime.wrap(function _callee5$(_context5) {
+                                while (1) {
+                                  switch (_context5.prev = _context5.next) {
+                                    case 0:
+                                      _url$parse = url.parse(req.url || ''), pathname = _url$parse.pathname;
+                                      res.setHeader('Content-Type', 'application/json');
+
+                                      if (pathname.includes('/api/plugin/export')) {
+                                        res.end(JSON.stringify(yapiData.cats.map(function (cat) {
+                                          return _extends({}, cat, {
+                                            list: yapiData.interfaces.filter(function (item) {
+                                              return item.catid === cat._id;
+                                            })
+                                          });
+                                        })));
+                                      } else if (pathname.includes('/api/interface/getCatMenu')) {
+                                        res.end(JSON.stringify({
+                                          errcode: 0,
+                                          errmsg: '成功！',
+                                          data: yapiData.cats
+                                        }));
+                                      } else if (pathname.includes('/api/project/get')) {
+                                        res.end(JSON.stringify({
+                                          errcode: 0,
+                                          errmsg: '成功！',
+                                          data: yapiData.project
+                                        }));
+                                      } else {
+                                        res.end('404');
+                                      }
+
+                                    case 3:
+                                    case "end":
+                                      return _context5.stop();
+                                  }
+                                }
+                              }, _callee5);
+                            }));
+
+                            return function (_x2, _x3) {
+                              return _ref2.apply(this, arguments);
+                            };
+                          }());
+                          _context6.next = 3;
+                          return _this.getPort();
+
+                        case 3:
+                          _context6.t1 = _context6.sent;
+
+                          _context6.t2 = function () {
+                            onExit(function () {
+                              return _this.stop();
+                            });
+                            resolve();
+                          };
+
+                          _this.httpServer = _context6.t0.listen.call(_context6.t0, _context6.t1, '127.0.0.1', _context6.t2);
+
+                        case 6:
+                        case "end":
+                          return _context6.stop();
+                      }
+                    }
+                  }, _callee6);
+                }));
+
+                return function (_x) {
+                  return _ref.apply(this, arguments);
+                };
+              }());
+
+            case 5:
+              return _context7.abrupt("return", this.getUrl());
+
+            case 6:
+            case "end":
+              return _context7.stop();
+          }
+        }
+      }, _callee7, this);
+    }));
+
+    function start() {
+      return _start.apply(this, arguments);
+    }
+
+    return start;
+  }();
+
+  _proto.stop = /*#__PURE__*/function () {
+    var _stop = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee8() {
+      var _this2 = this;
+
+      return _regeneratorRuntime.wrap(function _callee8$(_context8) {
+        while (1) {
+          switch (_context8.prev = _context8.next) {
+            case 0:
+              return _context8.abrupt("return", new Promise(function (resolve, reject) {
+                if (!_this2.httpServer) {
+                  resolve();
+                } else {
+                  _this2.httpServer.close(function (err) {
+                    if (err) {
+                      reject(err);
+                    } else {
+                      resolve();
+                    }
+                  });
+                }
+              }));
+
+            case 1:
+            case "end":
+              return _context8.stop();
+          }
+        }
+      }, _callee8);
+    }));
+
+    function stop() {
+      return _stop.apply(this, arguments);
+    }
+
+    return stop;
+  }();
+
+  return SwaggerToYApiServer;
+}();

package/lib/esm/cli.js

@@ -0,0 +1,257 @@
+#!/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';
+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']
+  }
+});
+export function run(_x, _x2) {
+  return _run.apply(this, arguments);
+}
+/* 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/fjc0k/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-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-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) {
+  var argv = yargs(process.argv).alias('c', 'config').argv;
+  run(argv._[2], {
+    configFile: argv.config ? path.resolve(process.cwd(), argv.config) : undefined
+  });
+}