@wx-sab/renkei 0.2.9 → 1.0.0

package/README.md

@@ -13,7 +13,7 @@
 - [x] 多服务的 apifox 项目解析
 - [x] 支持 swagger 3.0 解析
 - [x] 支持自定义生成接口名
-- [ ] 支持过滤部分接口
+- [x] 支持只生成部分服务接口
 
 ## Introduce
 

package/lib/commands/api.js

@@ -23,12 +23,15 @@ const readProjectConfigFile = () => {
     }
     return null;
 };
-const parse = new commander_1.default.Command('api').action(() => {
+const parse = new commander_1.default.Command('api').option('-s, --service <service>', '只获取指定的服务，多个服务用","分隔', ',').action((param, options) => {
+    var _a;
+    // 只生成指定服务
+    const services = ((_a = param.service) === null || _a === void 0 ? void 0 : _a.split(',')) || [];
     const config = readProjectConfigFile();
     if (!config) {
         console.warn('未找到配置文件');
         return;
     }
-    (0, generate_1.generateApis)(config);
+    (0, generate_1.generateApis)(config, services);
 });
 exports.default = parse;

package/lib/core/generate.d.ts

@@ -6,4 +6,4 @@ import { GenerateConfig } from "./interface";
  * 单个配置生成
  */
 export declare const generate: (conf: GenerateConfig) => Promise<import("swagger-typescript-api").GenerateApiOutput>;
-export declare const generateApis: (config: GenerateConfig | GenerateConfig[]) => Promise<void>;
+export declare const generateApis: (config: GenerateConfig | GenerateConfig[], services: string[]) => Promise<void>;

package/lib/core/generate.js

@@ -26,6 +26,7 @@ exports.generateApis = exports.generate = void 0;
 const path_1 = __importDefault(require("path"));
 const lodash_1 = __importDefault(require("lodash"));
 const swagger_typescript_api_1 = require("swagger-typescript-api");
+const cli_progress_1 = __importDefault(require("cli-progress"));
 const utils_1 = require("./utils");
 /**
  * 单个配置生成
@@ -47,6 +48,8 @@ const generate = (conf) => {
         output: path_1.default.resolve(config.output, config.serviceName),
         // 模块化？
         modular: false,
+        // 静默
+        silent: true,
         extractRequestParams: true,
         // 清空输出目录？
         cleanOutput: false,
@@ -58,8 +61,8 @@ const generate = (conf) => {
         extraTemplates: [
             {
                 name: "index.ts",
-                path: path_1.default.resolve(__dirname, "../../templates/service.ejs"),
-            },
+                path: path_1.default.resolve(__dirname, "../../templates/service.ejs")
+            }
         ],
         hooks: {
             onCreateRouteName(routeNameInfo, rawRouteInfo) {
@@ -80,7 +83,7 @@ const generate = (conf) => {
                 return {
                     duplicate: duplicate,
                     original: methodName,
-                    usage: methodName,
+                    usage: methodName
                 };
             },
             onPrepareConfig(currentConfiguration) {
@@ -101,18 +104,19 @@ const generate = (conf) => {
                 // 将 /api/v1/order-mains/{orderId} 转成 /api/v1/order-mains/${orderId}
                 // routeData.raw.route 是进过 customRequestUrl 转换过的
                 // @ts-ignore
-                routeData.request.path = (_a = routeData.raw.route) === null || _a === void 0 ? void 0 : _a.replace(/\{([^}]+)\}/g, '${$1}');
+                routeData.request.path = (_a = routeData.raw.route) === null || _a === void 0 ? void 0 : _a.replace(/\{([^}]+)\}/g, "${$1}");
                 return routeData;
             },
             onInit(configuration) {
                 return Object.assign(Object.assign({}, configuration), { serviceName: config.serviceName, apifoxProjectId: config.apifoxProjectId, customResponseType: config.customResponseType, customMockService: config.customMockService });
-            },
-        },
+            }
+        }
     });
 };
 exports.generate = generate;
 // 批量生成接口
-const generateApis = (config) => __awaiter(void 0, void 0, void 0, function* () {
+const generateApis = (config, services // 指定服务
+) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, e_1, _b, _c;
     // 递归收集config下可能有的 projects ，也当做新的config
     const collectConfig = (conf, collects = []) => {
@@ -122,20 +126,30 @@ const generateApis = (config) => __awaiter(void 0, void 0, void 0, function* ()
             conf.forEach((con) => collectConfig(con, collects));
         }
         else {
-            collects.push(lodash_1.default.omit(conf, 'projects'));
+            collects.push(lodash_1.default.omit(conf, "projects"));
             if (Array.isArray(conf.projects)) {
-                conf.projects.forEach((project) => collectConfig(Object.assign(Object.assign({}, lodash_1.default.omit(conf, 'projects')), project), collects));
+                conf.projects.forEach((project) => collectConfig(Object.assign(Object.assign({}, lodash_1.default.omit(conf, "projects")), project), collects));
             }
         }
         return collects;
     };
-    const _configs = collectConfig(config);
+    const _configs = collectConfig(config).filter((conf) => {
+        // 只筛选指定的服务
+        if (services.length > 0) {
+            return services.includes(conf.serviceName);
+        }
+        return true;
+    });
+    // 进度条控制
+    const progress = new cli_progress_1.default.SingleBar({});
+    progress.start(_configs.length, 0);
     try {
         for (var _d = true, _configs_1 = __asyncValues(_configs), _configs_1_1; _configs_1_1 = yield _configs_1.next(), _a = _configs_1_1.done, !_a; _d = true) {
             _c = _configs_1_1.value;
             _d = false;
             const conf = _c;
             yield (0, exports.generate)(conf);
+            progress.increment(1);
         }
     }
     catch (e_1_1) { e_1 = { error: e_1_1 }; }
@@ -145,5 +159,7 @@ const generateApis = (config) => __awaiter(void 0, void 0, void 0, function* ()
         }
         finally { if (e_1) throw e_1.error; }
     }
+    progress.stop();
+    console.info("✅ 执行完毕");
 });
 exports.generateApis = generateApis;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wx-sab/renkei",
-  "version": "0.2.9",
+  "version": "1.0.0",
   "description": "解析swagger转为ts代码，日本动漫《游戏王》中的‘Renkei’，意为连携或协作。",
   "main": "./lib/index.js",
   "bin": {
@@ -8,9 +8,10 @@
   },
   "scripts": {
     "dev": "ts-node ./src/index.ts",
-    "demo": "ts-node ./demo.ts",
     "clean": "rm -rf lib",
-    "build": "npm run clean & tsc --outDir lib"
+    "build": "npm run clean & tsc --outDir lib",
+    "version:alpha": "npm version premajor --preid alpha",
+    "api": "ts-node --transpile-only ./src/cli.ts api"
   },
   "repository": {
     "type": "git",
@@ -19,6 +20,7 @@
   "author": "sab-fe",
   "license": "ISC",
   "devDependencies": {
+    "@types/cli-progress": "^3.11.5",
     "@types/lodash": "^4.14.196",
     "@types/node": "^20.4.7",
     "typescript": "^5.1.6"
@@ -29,9 +31,10 @@
   ],
   "dependencies": {
     "axios": "^1.4.0",
+    "cli-progress": "^3.12.0",
     "commander": "^11.0.0",
     "lodash": "^4.17.21",
-    "swagger-typescript-api": "^12.0.4",
+    "swagger-typescript-api": "^13.0.3",
     "ts-node": "^10.9.1"
   }
 }

package/templates/procedure-call.ejs

@@ -1,7 +1,7 @@
 <%
-const { utils, route, config, modelTypes, namespace, modelNamespace, serviceName, requestTempalte, rawModelTypes, strict, } = it;
-const { requestBodyInfo, responseBodyInfo, specificArgNameResolver, routeParams, conflict, merged } = route;
-const { _, getInlineParseContent, getParseContent, parseSchema, getComponentByRef, require, pick } = utils;
+const { utils, route, config, modelTypes, modelNamespace, serviceName, requestTempalte } = it;
+const { requestBodyInfo, responseBodyInfo, specificArgNameResolver } = route;
+const { _, getInlineParseContent, getParseContent, parseSchema, getComponentByRef, require } = utils;
 const { parameters, path, method, payload, query, formData, security, requestParams } = route.request;
 const { type, errorType, contentTypes } = route.response;
 const { HTTP_CLIENT, RESERVED_REQ_PARAMS_ARG_NAMES } = config.constants;
@@ -44,9 +44,9 @@ const argToTmpl = ({ name, optional, type, defaultValue }) => `${name}${!default
 const rawWrapperArgs = config.extractRequestParams ?
     _.compact([
         requestParams && {
-            name: pathParams.length ? `{ ${_.join(pathParamsNames, ", ")}, ...${queryName} }` : queryName,
-            optional: false,
-            type: getInlineParseContent(requestParams),
+          name: pathParams.length ? `{ ${_.join(pathParamsNames, ", ")}, ...${queryName} }` : queryName,
+          optional: false,
+          type: getInlineParseContent(requestParams),
         },
         ...(!requestParams ? pathParams : []),
         payload,
@@ -70,8 +70,8 @@ const requestContentKind = {
     "JSON": "ContentType.Json",
     "URL_ENCODED": "ContentType.UrlEncoded",
     "FORM_DATA": "ContentType.FormData",
+    "TEXT": "ContentType.Text",
 }
-
 // RequestParams["format"]
 const responseContentKind = {
     "JSON": '"json"',
@@ -90,10 +90,10 @@ const describeReturnType = () => {
 
     switch(config.httpClientType) {
         case HTTP_CLIENT.AXIOS: {
-            return `Promise<AxiosResponse<${type}>>`
+          return `Promise<AxiosResponse<${type}>>`
         }
         default: {
-            return `Promise<HttpResponse<${type}, ${errorType}>`
+          return `Promise<HttpResponse<${type}, ${errorType}>`
         }
     }
 }
@@ -129,29 +129,14 @@ const wrappedDataArgs = _
     .map(argToTmpl)
     .join(', ')
 
-const getTypeSchema = (type) => {
-    // Model.SalesService.IdParam => IdParam
-    const realType = (type || '').split('.').pop()
-    return rawModelTypes.find((item) => item.typeName === realType)?.rawTypeData?.properties
-}
-
-const requestBodySchemaNames = Object.keys(getTypeSchema(requestBodyInfo?.type) || {}).map((name) => ({ name }))
-
 %>
-
 /**
 <%~ routeDocs.description %>
 
- * <% /* Here you can add some other JSDoc tags */ %>
+ *<% /* Here you can add some other JSDoc tags */ %>
 
 <%~ routeDocs.lines %>
 
-<% if(merged) { %>
- * @merged
-<% } %>
-<% if(conflict) { %>
- * @conflict
-<% } %>
  */
 static public <%~ route.routeName.usage %> = async (<%~ wrappedDataArgs %>): Promise<<%~ getWrapperFullType(type) %>> => {
     const url = <%~ serviceName %>.generateUrl({

package/templates/route-docs.ejs

@@ -1,6 +1,6 @@
 <%
 const { config, route, utils } = it;
-const { _, formatDescription, fmtToJSDocLine, classNameCase, require } = utils;
+const { _, formatDescription, fmtToJSDocLine, pascalCase, require } = utils;
 const { raw, request, routeName } = route;
 
 const jsDocDescription = raw.description ?
@@ -8,7 +8,7 @@ const jsDocDescription = raw.description ?
     fmtToJSDocLine('No description', { eol: false });
 const jsDocLines = _.compact([
     _.size(raw.tags) && ` * @tags ${raw.tags.join(", ")}`,
-    ` * @name ${classNameCase(routeName.usage)}`,
+    ` * @name ${pascalCase(routeName.usage)}`,
     raw.summary && ` * @summary ${raw.summary}`,
     ` * @request ${_.upperCase(request.method)}:${raw.route}`,
     raw.deprecated && ` * @deprecated`,
@@ -18,10 +18,10 @@ const jsDocLines = _.compact([
     ...(config.generateResponses && raw.responsesTypes.length
     ? raw.responsesTypes.map(
         ({ type, status, description, isSuccess }) =>
-            ` * @response \`${status}\` \`${type}\` ${description}`,
+            ` * @response \`${status}\` \`${_.replace(_.replace(type, /\/\*/g, "\\*"), /\*\//g, "*\\")}\` ${description}`,
         )
     : []),
-]).join("\n");
+]).map(str => str.trimEnd()).join("\n");
 
 
 return {

package/templates/route-types.ejs

@@ -0,0 +1,32 @@
+<%
+const { utils, config, routes, modelTypes } = it;
+const { _, pascalCase } = utils;
+const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
+%>
+
+<% if (dataContracts.length) { %>
+import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
+<% } %>
+
+<%
+/* TODO: outOfModule, combined should be attributes of route, which will allow to avoid duplication of code */
+%>
+
+<% if (routes.outOfModule) { %>
+ <% for (const { routes: outOfModuleRoutes = [] } of routes.outOfModule) { %>
+   <% for (const route of outOfModuleRoutes) { %>
+     <%~ includeFile('@base/route-type.ejs', { ...it, route }) %>
+   <% } %>
+ <% } %>
+<% } %>
+
+<% if (routes.combined) { %>
+ <% for (const { routes: combinedRoutes = [], moduleName } of routes.combined) { %>
+   export namespace <%~ pascalCase(moduleName) %> {
+   <% for (const route of combinedRoutes) { %>
+     <%~ includeFile('@base/route-type.ejs', { ...it, route }) %>
+   <% } %>
+   }
+
+ <% } %>
+<% } %>