miqro 5.0.1 → 5.0.3

package/build/cmd-map.js

@@ -245,27 +245,29 @@ export const CMD_MAP = {
         //section: "api documentation",
         tabs: 4,
         cb: async () => {
-            if (process.argv.length < 5 || process.argv.length > 6) {
-                throw new Error(`usage: [NODE_ENV=development] npx miqro doc <api_folder> <subPath> [apiName]`);
+            if (process.argv.length < 5 || process.argv.length > 7) {
+                throw new Error(`usage: [NODE_ENV=development] npx miqro doc <api_folder> <subPath> [apiName] [ignore]`);
             }
             const dirname = process.argv[3];
             const subPath = process.argv[4];
             const apiName = process.argv[5];
+            const ignore = process.argv[6];
             loadConfig();
-            console.log(JSON.stringify(await getDOCJSON({ dirname, subPath, apiName }), undefined, 2));
+            console.log(JSON.stringify(await getDOCJSON({ dirname, subPath, apiName, ignore: ignore ? ignore.split(",") : undefined }), undefined, 2));
         },
         description: `api folder auto doc as a json.`
     },
     ["doc:md"]: {
         cb: async () => {
-            if (process.argv.length < 5 || process.argv.length > 6) {
-                throw new Error(`usage: [NODE_ENV=development] npx miqro doc <api_folder> <subPath> [apiName]`);
+            if (process.argv.length < 5 || process.argv.length > 7) {
+                throw new Error(`usage: [NODE_ENV=development] npx miqro doc <api_folder> <subPath> [apiName] [ignore]`);
             }
             const dirname = process.argv[3];
             const subPath = process.argv[4];
             const apiName = process.argv[5];
+            const ignore = process.argv[6];
             loadConfig();
-            console.log(await getMDDoc({ dirname, subPath, apiName }));
+            console.log(await getMDDoc({ dirname, subPath, apiName, ignore: ignore.split(",") }));
         },
         tabs: 4,
         description: `api folder auto doc as a markdown.`

package/build/utils/doc/json.d.ts

@@ -1,5 +1,6 @@
 import { Logger, RouterJSONDoc } from "@miqro/core";
-export declare const getDOCJSON: ({ dirname, subPath, apiName }: {
+export declare const getDOCJSON: ({ dirname, subPath, apiName, ignore }: {
+    ignore?: string[] | undefined;
     apiName?: string | undefined;
     dirname: string;
     subPath: string;

package/build/utils/doc/json.js

@@ -1,11 +1,12 @@
 import { APIRouter, ConfigPathResolver } from "@miqro/core";
 import { resolve } from "path";
-export const getDOCJSON = async ({ dirname, subPath, apiName }, logger) => {
+export const getDOCJSON = async ({ dirname, subPath, apiName, ignore }, logger) => {
     //const apiTraverse = traverseAPIRouteDir(basename(dirname).toUpperCase(), resolve(ConfigPathResolver.getBaseDirname(), dirname), subPath, undefined, logger);
     const router = await APIRouter({
         apiName,
         dirname: resolve(ConfigPathResolver.getBaseDirname(), dirname),
-        path: subPath
+        path: subPath,
+        ignore
     }, logger);
     return router.getJSONDoc();
 };

package/build/utils/doc/md.d.ts

@@ -1,11 +1,13 @@
 import { Logger, ParserMode, SchemaProperties } from "@miqro/core";
 export declare function getMDDoc(args: {
+    ignore?: string[];
     showFilePath?: boolean;
     apiName?: string;
     dirname: string;
     subPath: string;
 }, logger?: Logger): Promise<string>;
 export declare function parserToString(parser: {
+    status?: number | number[];
     headers?: string | SchemaProperties | SchemaProperties[];
     headersMode?: ParserMode;
     query?: string | SchemaProperties | boolean | SchemaProperties[];

package/build/utils/doc/md.js

@@ -12,26 +12,28 @@ export async function getMDDoc(args, logger) {
         const pathData = jsonDOC[path];
         const methods = Object.keys(pathData);
         for (const method of methods) {
-            const apiData = pathData[method];
-            outMD += `## ${apiData.identifier}${args.showFilePath ? apiData.___filePath : ""}\n\n`;
-            if (apiData.name) {
-                outMD += `${apiData.name}\n\n`;
-            }
-            if (apiData.description) {
-                outMD += `${apiData.description}\n\n`;
-            }
-            outMD += `[${method}] ${path}\n\n`;
-            if (apiData.policy) {
-                outMD += `### policy\n\n`;
-                outMD += policyToString(apiData.policy);
-            }
-            if (apiData.request) {
-                const requestOutMD = parserToString(apiData.request);
-                outMD += requestOutMD !== "" ? `### request\n\n${requestOutMD}` : "";
-            }
-            if (apiData.response && typeof apiData.response !== "boolean") {
-                const responseOutMD = parserToString(apiData.response);
-                outMD += responseOutMD !== "" ? `### response\n\n${responseOutMD}` : "";
+            const apiDataList = pathData[method];
+            for (const apiData of apiDataList) {
+                outMD += `## ${apiData.identifier}${args.showFilePath ? apiData.___filePath : ""}\n\n`;
+                if (apiData.name) {
+                    outMD += `${apiData.name}\n\n`;
+                }
+                if (apiData.description) {
+                    outMD += `${apiData.description}\n\n`;
+                }
+                outMD += `[${method}] ${path}\n\n`;
+                if (apiData.policy) {
+                    outMD += `### policy\n\n`;
+                    outMD += policyToString(apiData.policy);
+                }
+                if (apiData.request) {
+                    const requestOutMD = parserToString(apiData.request);
+                    outMD += requestOutMD !== "" ? `### request\n\n${requestOutMD}` : "";
+                }
+                if (apiData.response && typeof apiData.response !== "boolean") {
+                    const responseOutMD = parserToString(apiData.response);
+                    outMD += responseOutMD !== "" ? `### response\n\n${responseOutMD}` : "";
+                }
             }
         }
     }
@@ -45,6 +47,9 @@ function policyToString(policy) {
 }
 export function parserToString(parser) {
     let outMD = "";
+    if (parser.status) {
+        outMD += `#### status\n\n${parser.status instanceof Array ? parser.status.join(",") : parser.status}\n\n`;
+    }
     if (parser.params && typeof parser.params !== "boolean") {
         outMD += `#### path params\n\n`;
         outMD += parserPartToString(parser.params, parser.paramsMode);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "miqro",
-  "version": "5.0.1",
+  "version": "5.0.3",
   "description": "",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -9,7 +9,7 @@
     "miqro": "build/cli.js"
   },
   "scripts": {
-    "prepare": "npm run build",
+    "prepare2": "npm run build",
     "prebuild": "rm -Rf build;",
     "build": "tsc",
     "pretest": "npm run build",
@@ -19,8 +19,8 @@
   "author": "claukers",
   "license": "ISC",
   "dependencies": {
-    "@miqro/core": "^5.0.2",
-    "@miqro/parser": "^2.0.2",
+    "@miqro/core": "^5.0.10",
+    "@miqro/parser": "^2.0.3",
     "@miqro/runner": "^2.0.1"
   },
   "devDependencies": {