feat: 支持scan方法

Author: ShanaMaid

README.md

@@ -84,6 +84,36 @@ astraea.json(
   }
 )
 ```
+
+
+### scan
+
+`astraea.scan` based on `astraea.json`, it will scan all `.js` files of `inputDir`.
+
+[Demo](./example/scan)
+
+[Test](./test/scan.js)
+#### options
+  - `inputDir`, .js dir
+  - `outputDir`, output directory
+  - `opt`, 
+    - `blackList`, filter `path`
+    - `optional`,  boolean, all params are optinaol
+    - `suffix`, file format, eg: `ts` or `d.ts`
+```js
+const astraea = require('../index.js');
+const path = require('path');
+
+astraea.scan({
+  inputDir: path.resolve(__dirname, './scanData'),
+  outputDir: path.resolve(__dirname, '../example/scan'),
+  request: {
+    optional: true,
+  },
+  response: {},
+});
+```
+
 ## How to use?
 this is a simple example, you need to rework if use in prod!
 ```js
@@ -177,4 +207,5 @@ export interface IDeleteRoutes {
   '/store/order/:orderId': DeleteStoreOrderOrderId;
   '/user/:username': DeleteUserUsername;
 } 
-```
+```
+

example/scan/requests/GET/api/v1/accounts/:id.ts

@@ -0,0 +1,3 @@
+export interface RootObject {
+	groupId?: number;
+}

example/scan/requests/GET/api/v1/accounts/token.ts

@@ -0,0 +1 @@
+export interface RootObject {}

example/scan/requests/routes.ts

@@ -0,0 +1,20 @@
+import { RootObject as GetApiV1AccountsToken } from './GET/api/v1/accounts/token';
+import { RootObject as GetApiV1AccountsId } from './GET/api/v1/accounts/:id';
+
+export interface IGetRoutes {
+  '/api/v1/accounts/token': GetApiV1AccountsToken;
+  '/api/v1/accounts/:id': GetApiV1AccountsId;
+}
+
+export interface IPostRoutes {
+
+}
+
+export interface IPutRoutes {
+
+}
+
+export interface IDeleteRoutes {
+
+}
+

example/scan/responses/GET/api/v1/accounts/:id.ts

@@ -0,0 +1,4 @@
+export interface RootObject {
+	name: string;
+	id: number;
+}

example/scan/responses/GET/api/v1/accounts/token.ts

@@ -0,0 +1,3 @@
+export interface RootObject {
+	token: string;
+}

example/scan/responses/routes.ts

@@ -0,0 +1,20 @@
+import { RootObject as GetApiV1AccountsToken } from './GET/api/v1/accounts/token';
+import { RootObject as GetApiV1AccountsId } from './GET/api/v1/accounts/:id';
+
+export interface IGetRoutes {
+  '/api/v1/accounts/token': GetApiV1AccountsToken;
+  '/api/v1/accounts/:id': GetApiV1AccountsId;
+}
+
+export interface IPostRoutes {
+
+}
+
+export interface IPutRoutes {
+
+}
+
+export interface IDeleteRoutes {
+
+}
+

lib/src/adapters/scan.d.ts

@@ -0,0 +1,9 @@
+import { IOpt } from './json';
+export interface IOptions {
+    inputDir: string;
+    outputDir: string;
+    request?: IOpt;
+    response?: IOpt;
+}
+declare const scan: (options: IOptions) => void;
+export default scan;

lib/src/adapters/scan.js

@@ -1,5 +1,6 @@
 declare const _default: {
     json: (json: import("./adapters/json").IJson, dir: string, opt?: import("./adapters/json").IOpt | undefined) => void;
     swagger: (swagger: any, dir: string, opt?: import("./adapters/swagger").IOpt | undefined) => Promise<void>;
+    scan: (options: import("./adapters/scan").IOptions) => void;
 };
 export default _default;

lib/src/adapters/scan.js.map

@@ -0,0 +1 @@
+export declare const getAllFiles: (dir: string, suffix: string) => string[];

lib/src/index.d.ts

@@ -36,11 +36,11 @@
   "homepage": "https://github.com/ShanaMaid/Astraea#readme",
   "dependencies": {
     "@types/fs-extra": "^5.0.5",
-    "@types/node": "^11.9.5",
+    "@types/node": "^11.15.14",
     "@types/underscore": "^1.8.9",
     "fs-extra": "^7.0.1",
     "swagmock": "^1.0.0",
-    "tslib": "^1.9.3",
+    "tslib": "2.0.0",
     "typescript": "^3.3.3333",
     "underscore": "^1.9.1"
   },

lib/src/index.js

@@ -0,0 +1,64 @@
+import * as path from 'path';
+import {
+  IOpt,
+  IApi,
+} from './json';
+import parseJSON from './json';
+import { getAllFiles } from '../utils/getAllFiles';
+
+export interface IOptions {
+  inputDir: string;
+  outputDir: string;
+  request?: IOpt;
+  response?: IOpt;
+}
+
+type Method = 'request' | 'response';
+
+const transform = (method: Method, data: IApi) => {
+  const json: {[i: string]: any} = {
+    get: {},
+    post: {},
+    put: {},
+    delete: {},
+  };
+  // eslint-disable-next-line no-restricted-syntax
+  const paths = Object.keys(data);
+  // eslint-disable-next-line
+  for (const api of paths) {
+    console.log(`scan api - ${method} ->  ${api}`);
+    const result = api.split(' ');
+    const target = data[api][method];
+    json[result[0].toLowerCase()][result[1]] = target;
+  }
+  return json;
+};
+
+const scan = (options: IOptions) => {
+  const {
+    inputDir,
+    outputDir,
+    request: requestOpt,
+    response: responseOpt,
+  } = options;
+  const jsFiles = getAllFiles(inputDir, 'js');
+  const files: IApi = jsFiles.reduce((pre, cur) => {
+    return { ...pre, ...require(cur) };
+  }, jsFiles[0] ? require(jsFiles[0]) : {});
+  const requestJSON = transform('request', files);
+  const responseJSON = transform('response', files);
+  /**
+   * 生成请求参数
+   */
+  parseJSON(requestJSON, path.resolve(outputDir, './requests'), requestOpt);
+
+  /**
+   * 生成响应参数
+   */
+  parseJSON(responseJSON, path.resolve(outputDir, './responses'), responseOpt);
+
+  console.log(`scan success! total: ${Object.keys(files).length} API`);
+
+};
+
+export default scan;

lib/src/index.js.map

@@ -1,7 +1,10 @@
 import json from './adapters/json';
 import swagger from './adapters/swagger';
+import scan from './adapters/scan';
+
 
 export default {
   json,
-  swagger
+  swagger,
+  scan,
 };

lib/src/utils/getAllFiles.d.ts

@@ -0,0 +1,18 @@
+import * as fs from 'fs';
+import * as path from 'path';
+
+export const getAllFiles = (dir: string, suffix: string) => {
+  const paths: string[] = [];
+  const files = fs.readdirSync(dir);
+  // eslint-disable-next-line no-restricted-syntax
+  for (const file of files) {
+    const filePath = path.resolve(dir, file);
+    const stat = fs.lstatSync(filePath);
+    if (stat.isDirectory()) {
+      paths.push(...getAllFiles(filePath, suffix));
+    } else if (file.match(new RegExp(`.${suffix}$`))) {
+      paths.push(filePath);
+    }
+  }
+  return paths;
+};

lib/src/utils/getAllFiles.js

@@ -0,0 +1,11 @@
+const astraea = require('../index.js');
+const path = require('path');
+
+astraea.scan({
+  inputDir: path.resolve(__dirname, './scanData'),
+  outputDir: path.resolve(__dirname, '../example/scan'),
+  request: {
+    optional: true,
+  },
+  response: {},
+});