mock-service-cli 2.0.5 → 2.3.1

package/CHANGELOG.md

@@ -2,6 +2,50 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.3.1](https://github.com/chandq/mock-service-cli/compare/v2.2.0...v2.3.1) (2022-01-01)
+
+
+### Bug Fixes
+
+* issue of execute unit test case failed ([69f4609](https://github.com/chandq/mock-service-cli/commit/69f46099ed5b26de5d4cca523c56afcbf4db5f2c))
+
+## [2.2.0](https://github.com/chandq/mock-service-cli/compare/v2.1.1...v2.2.0) (2021-12-31)
+
+
+### Features
+
+* 丰富日志工具函数 ([4dcd69c](https://github.com/chandq/mock-service-cli/commit/4dcd69c6400f65aaf77ea4a2923c9900d5954d09))
+* 监听文件变化和写文件互斥执行 ([cfeab8e](https://github.com/chandq/mock-service-cli/commit/cfeab8ede05573974125a9fa91f1db6afa8a898d))
+* record operation log ([42b74d8](https://github.com/chandq/mock-service-cli/commit/42b74d8be0e694600c999490d3fe93bfb3620051))
+
+
+### Bug Fixes
+
+* issue of write large file failed ([d1c470d](https://github.com/chandq/mock-service-cli/commit/d1c470daf9829916016b73993b114fc5ffe3c985))
+
+### [2.1.1](https://github.com/chandq/mock-service-cli/compare/v2.1.0...v2.1.1) (2021-12-30)
+
+
+### Bug Fixes
+
+* issue of  friendly show error tip ([e9822c2](https://github.com/chandq/mock-service-cli/commit/e9822c2038ad411d91a170af33e7541e266ca8e6))
+* issue of empty file content ([3949e00](https://github.com/chandq/mock-service-cli/commit/3949e00a46b4555bc08ec8564221cc230c780dcb))
+
+## [2.1.0](https://github.com/chandq/mock-service-cli/compare/v2.0.5...v2.1.0) (2021-12-30)
+
+
+### Features
+
+* 根据命令行参数决定是否 打印api统计信息 ([0e838db](https://github.com/chandq/mock-service-cli/commit/0e838db7820fd096163d14eb87abbd9b852b6a0e))
+* add arguments description ([097b373](https://github.com/chandq/mock-service-cli/commit/097b3733a1da0b43dae6b50080d270323b92f0d2))
+
+
+### Bug Fixes
+
+* issue of comment typo ([85297a5](https://github.com/chandq/mock-service-cli/commit/85297a5895fd7c0446ee8b90a58ebed90a02e9e7))
+* issue of maybe write content to file failed ([8ed910b](https://github.com/chandq/mock-service-cli/commit/8ed910b1e9687cae46ad6bdab641db0c305c83fb))
+* socket connection show datetime ([c6db3b4](https://github.com/chandq/mock-service-cli/commit/c6db3b47a2370dc1c9aba5495dbb6606c20eb0c9))
+
 ### [2.0.5](https://github.com/chandq/mock-service-cli/compare/v2.0.4...v2.0.5) (2021-12-28)
 
 

package/README.md

@@ -45,15 +45,17 @@ This will install `mock-service-cli` globally so that it may be run from the com
 
 `[path]` defaults to `./mock` .
 
-| Command             | Description                                                                                                    | Defaults |
-| ------------------- | -------------------------------------------------------------------------------------------------------------- | -------- |
-| `-p` or `--port`    | Port to use. Use `-p 0` to look for an open port, starting at 8090. It will also read from `process.env.PORT`. | 8090     |
-| `-d`                | Specify mock directory                                                                                         | ./mock   |
-| `-f`                | Specify mock file                                                                                              |          |
-| `-s` or `--silent`  | Suppress log messages from output                                                                              |          |
-| `-h` or `--help`    | Print this list and exit.                                                                                      |          |
-| `-v` or `--version` | Print the version and exit.                                                                                    |          |
-| `--ss`              | Start socket server which used to save api response data for future mock.                                      | false    |
+| Command                   | Description                                                                                                    | Defaults |
+| ------------------------- | -------------------------------------------------------------------------------------------------------------- | -------- |
+| `-p` or `--port`          | Port to use. Use `-p 0` to look for an open port, starting at 8090. It will also read from `process.env.PORT`. | 8090     |
+| `-d`                      | Specify mock directory                                                                                         | ./mock   |
+| `-f`                      | Specify mock file                                                                                              |          |
+| `-s` or `--silent`        | Suppress log messages from output                                                                              |          |
+| `-h` or `--help`          | Print this list and exit.                                                                                      |          |
+| `-v` or `--version`       | Print the version and exit.                                                                                    |          |
+| `-S` or `--socket-server` | Start socket server which used to save api response data for future mock.                                      | false    |
+| `-a` or `--api-stat`      | Whether print api url and file path info or not, default false.                                                | false    |
+| `-l` or `--log`           | Whether record operation info by write file, default false.                                                    | false    |
 
 ## Example
 
@@ -71,7 +73,7 @@ This will install `mock-service-cli` globally so that it may be run from the com
 
 4. Start socket server for used to save api response data.
 
-`mock-service-cli --ss`
+`mock-service-cli -S`
 
 ### 编写 Mock 文件
 
@@ -124,6 +126,8 @@ module.exports = {
 
 ### 借助 socket.io 保留接口数据
 
+> `save-data` 和 `mock-dir-stat` 事件会自动生成 `mock-list.json` 文件（维护接口`<url, [method]>`的关系映射），方便查阅接口统计信息
+
 ```js
 // 连接SocketServer
 import { io } from 'socket.io-client';

package/bin/mock-service-cli

@@ -6,6 +6,8 @@ const colors = require('colors/safe'),
   nodemon = require('nodemon');
 const argv = require('minimist')(process.argv.slice(2));
 const { logger } = require('../lib/utils');
+const spawn = require('child_process').spawn;
+const node = process.execPath;
 process.title = 'mock-service-cli';
 
 if (argv.h || argv.help) {
@@ -20,7 +22,9 @@ if (argv.h || argv.help) {
       '  -f --file     Specify the input data source, support javascript ',
       '                     The priority is over the directory watches',
       '  -s --silent  Suppress log messages from output',
-      '  --ss  Whether start socket server or not, default false.',
+      '  -S --socket-server  Whether start socket server or not, default false.',
+      '  -a --api-stat  Whether print api url and file path or not, default false.',
+      '  -l --log  Whether record operation info by write file, default false.',
       '',
       '  -h --help          Print this list and exit.',
       '  -v --version       Print the version and exit.'
@@ -29,11 +33,14 @@ if (argv.h || argv.help) {
   process.exit();
 }
 
+// 保留命令行参数
+process.env.ARGV = JSON.stringify(argv);
+
 var port = argv.p || argv.port,
   watchDir = argv.d,
   specifiedFile = argv.f || argv.file,
   version = argv.v || argv.version,
-  isStartSocketServer = argv.ss || false,
+  isStartSocketServer = argv.S || false,
   log = null;
 
 if (!argv.s && !argv.silent) {
@@ -44,7 +51,7 @@ if (!argv.s && !argv.silent) {
 }
 
 if (isStartSocketServer) {
-  process.env.SOCKETSERVER = true;
+  process.env.SOCKET_SERVER = true;
 }
 
 if (version) {
@@ -90,16 +97,34 @@ const watchMockFiles = function (watchDir) {
       );
     });
 };
+// Node子进程启动MockServer
+const startMockServer = function () {
+  spawn(node, [path.resolve(__dirname, '../lib/mockServer.js')], {
+    stdio: 'inherit'
+  });
+};
 
 if (specifiedFile) {
   process.env.SPECIFIED_FILE = path.resolve(process.cwd(), specifiedFile);
-  watchMockFiles(process.env.SPECIFIED_FILE);
+  if (isStartSocketServer) {
+    startMockServer();
+  } else {
+    watchMockFiles(process.env.SPECIFIED_FILE);
+  }
 } else if (watchDir) {
   process.env.SPECIFIED_DIR = path.resolve(process.cwd(), watchDir);
   // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
-  watchMockFiles(process.env.SPECIFIED_DIR);
+  if (isStartSocketServer) {
+    startMockServer();
+  } else {
+    watchMockFiles(process.env.SPECIFIED_DIR);
+  }
 } else {
   watchDir = process.env.SPECIFIED_DIR = path.resolve(process.cwd(), './mock');
   // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
-  watchMockFiles(watchDir);
+  if (isStartSocketServer) {
+    startMockServer();
+  } else {
+    watchMockFiles(watchDir);
+  }
 }

package/lib/manageMockFiles.js

@@ -2,7 +2,7 @@
  * @description: 生成Mock文件、获取mock数据统计
  * @Date: 2021-12-22 16:57:08
  * @LastEditors: chendq
- * @LastEditTime: 2021-12-28 16:23:43
+ * @LastEditTime: 2022-01-01 10:51:12
  * @Author: chendq
  */
 const fsa = require('fs-extra'),
@@ -10,12 +10,22 @@ const fsa = require('fs-extra'),
   path = require('path'),
   _ = require('lodash'),
   colors = require('colors/safe');
-const { getFileLatestContent, SupportMethods, filePath2ApiUrl, logger } = require('./utils');
+const {
+  getFileLatestContent,
+  SupportMethods,
+  filePath2ApiUrl,
+  logger,
+  getDataType,
+  getLogger,
+  writeStream
+} = require('./utils');
 const log = logger(process.env.SILENT);
+const processArgv = process.env.ARGV ? JSON.parse(process.env.ARGV) : {};
+let LOGGER = getLogger();
 
 const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
 /**
- * @description: 生成mock文件
+ * @description: 生成mock文件（自动生成mock-list.json文件，并维护<url, [method]>的关系映射）
  * @param {string} apiUrl 请求url
  * @param {string} method 请求方法
  * @param {object} resJsonData 响应数据
@@ -24,13 +34,26 @@ const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
  *
  */
 const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mockDir }) {
+  const type = getDataType(resJsonData);
   if (!apiUrl || !method || !resJsonData || !mockDir) {
     log.info(
-      colors.red(`参数: apiUrl: ${apiUrl}, method: ${method}, resJsonData: ${resJsonData}, mockDir: ${mockDir}无效`)
+      colors.red([`参数: apiUrl: ${apiUrl}, method: ${method}, mockDir: ${mockDir} `, `必须是有效值`].join(','))
+    );
+    return;
+  } else if (
+    !['object', 'array'].includes(type) ||
+    (type === 'object' && Object.keys(resJsonData).length === 0) ||
+    (type === 'array' && resJsonData.length === 0)
+  ) {
+    log.info(
+      `参数: apiUrl: ${apiUrl}, method: ${method}, resJsonData:`,
+      resJsonData,
+      colors.red('， 参数字段resJsonData必须是非空的数组或对象！')
     );
     return;
   }
   apiUrl = apiUrl.trim().split('?')[0];
+  LOGGER = getLogger(mockDir);
   const normalizeApiUrl = filePath2ApiUrl(path.normalize(apiUrl));
   const mockListFilePath = path.resolve(process.cwd(), `${mockDir}/mock-list.json`);
   const mockFilePath = path.resolve(process.cwd(), `${mockDir}/${encodeURIComponent(path.normalize(apiUrl))}.json`);
@@ -51,7 +74,7 @@ const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mo
   }
   if (!oldMockListContent || !_.isEqual(oldMockListContent, newMockListContent)) {
     Object.keys(newMockListContent).length > 0 &&
-      fsa.writeFileSync(mockListFilePath, JSON.stringify(newMockListContent, null, 2));
+      writeStream(mockListFilePath, JSON.stringify(newMockListContent, null, 2));
   }
 
   // mock文件存在
@@ -65,19 +88,24 @@ const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mo
       // );
       return;
     }
-    mockFileContent[method] = resJsonData ? resJsonData : {};
-    Object.keys(mockFileContent).length > 0 &&
-      fsa.writeFileSync(mockFilePath, JSON.stringify(mockFileContent, null, 2));
+    mockFileContent[method] = resJsonData;
+    writeStream(mockFilePath, JSON.stringify(mockFileContent, null, 2));
+    if (processArgv.l || processArgv.log) {
+      LOGGER.log(`Update file:  ${method} ${apiUrl}  ${mockFilePath}`);
+    }
   } else {
     // fsa.ensureFileSync(mockFilePath);
-    Object.keys(mockFilePath).length > 0 &&
-      fsa.writeFileSync(mockFilePath, JSON.stringify({ [method]: resJsonData ? resJsonData : {} }, null, 2));
+
+    writeStream(mockFilePath, JSON.stringify({ [method]: resJsonData }, null, 2));
+    if (processArgv.l || processArgv.log) {
+      LOGGER.log(`Write new file:  ${method} ${apiUrl}  ${mockFilePath}`);
+    }
   }
   // console.debug('file::', `${mockDir}/${apiUrl}`, newMockListContent);
 };
 /**
  * @description: 从js文件中收集mock数据
- * @param {map} mockDataMap
+ * @param {object} mockDataMap
  * @param {string} filePath
  * @return {*} void
  */
@@ -103,7 +131,7 @@ const collectMockDataFromJsFile = function (mockDataMap, filePath) {
 
 /**
  * @description: 递归收集mock数据
- * @param {map} mockDataMap mock数据集
+ * @param {object} mockDataMap mock数据集
  * @param {string} specialDir 目录
  * @return {*} void
  */
@@ -136,27 +164,47 @@ const deepCollectMockData = function (mockDataMap, specialDir = '../mock') {
   }
 };
 /**
- * @description: 从文件目录中获取mock数据统计
+ * @description: 从文件目录中获取mock数据统计（若mock-list.json文件不存在则自动生成）
  * @param {string} dirPath
- * @return {map} mock数据统计
+ * @return {object} mock数据统计
  */
 const getMockStatFromDir = dirPath => {
   if (!fsa.pathExistsSync(dirPath)) {
-    throw new Error(`如参无效，${dirPath} 目录不存在`);
+    throw new Error(`入参无效，${dirPath} 目录不存在`);
   }
   const mockDataMap = {};
   deepCollectMockData(mockDataMap, dirPath);
+
+  const mockListFilePath = path.resolve(process.cwd(), `${dirPath}/mock-list.json`);
+  // 若不存在mock-list.json文件，则根据现有mock文件重新生成<api, [method]>映射关系
+  if (Object.keys(mockDataMap).length > 0 && !fsa.pathExistsSync(mockListFilePath)) {
+    fsa.ensureFileSync(mockListFilePath);
+    const reverseMockList = {};
+    Object.keys(mockDataMap).forEach(it => {
+      if (methodRegExp.exec(it)) {
+        const [, method, url] = methodRegExp.exec(it);
+        if (url.trim() && method.trim()) {
+          if (reverseMockList.hasOwnProperty(url)) {
+            reverseMockList[url].push(method);
+          } else {
+            reverseMockList[url] = [method];
+          }
+        }
+      }
+    });
+    writeStream(mockListFilePath, JSON.stringify(reverseMockList, null, 2));
+  }
   return mockDataMap;
 };
 
 /**
  * @description: 从js文件中获取mock数据统计
  * @param {string} filePath
- * @return {map}  mock数据统计
+ * @return {object}  mock数据统计
  */
 const getMockStatFromFile = filePath => {
   if (!fsa.pathExistsSync(filePath)) {
-    throw new Error(`如参无效，${filePath} 文件不存在`);
+    throw new Error(`入参无效，${filePath} 文件不存在`);
   }
   const mockDataMap = {};
   collectMockDataFromJsFile(mockDataMap, filePath);
@@ -171,7 +219,7 @@ const getMockStatFromFile = filePath => {
  */
 const hasMockApi = function (mockDataMap, apiUrl, method) {
   if (!apiUrl || !method || !mockDataMap || !(mockDataMap instanceof Object)) {
-    throw new Error(`如参无效，${mockDataMap} 必须是 mock数据的Object对象`);
+    throw new Error(`入参无效，${mockDataMap} 必须是 mock数据的Object对象`);
   }
   return mockDataMap.hasOwnProperty(`${method.toLocaleLowerCase()} ${path.normalize(apiUrl)}`);
 };

package/lib/mockServer.js

@@ -14,6 +14,7 @@ const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
 
 const app = express();
 const log = logger(process.env.SILENT);
+const argv = JSON.parse(process.env.ARGV);
 let socketServer = null; // Socket server instance
 
 let count = 0,
@@ -64,7 +65,7 @@ const composeRouteFromJsFile = function (file) {
   // 先删除require之前导入的缓存文件,否则获取到的文件内容还是旧内容
   const fileObject = getFileLatestContent(file);
 
-  log.info(colors.green(`Mockfile ${++fileCount}: `), file, colors.yellow('all API URL is follows: '));
+  argv.a && log.info(colors.green(`Mockfile ${++fileCount}: `), file, colors.yellow('all API URL is follows: '));
   Object.keys(fileObject).forEach(item => {
     let reqMethod = 'get',
       reqUrl = item;
@@ -74,7 +75,7 @@ const composeRouteFromJsFile = function (file) {
       reqMethod = method.toLowerCase();
       reqUrl = url;
     }
-    log.info(colors.yellow(`path ${++count}: `), item, colors.blue(typeof fileObject[item]));
+    argv.a && log.info(colors.yellow(`path ${++count}: `), item, colors.blue(typeof fileObject[item]));
     log.assert(typeof app[reqMethod] === 'function', colors.red(`${file}, ${reqMethod}`));
     if (typeof fileObject[item] === 'function') {
       app[reqMethod](reqUrl, fileObject[item]);
@@ -103,12 +104,14 @@ const parseMockFiles = function (specialDir = '../mock') {
 
     // 处理存放mock数据的json文件
     if (el.name.endsWith('.json') && el.name !== 'mock-list.json') {
-      log.info(colors.green(`Mockfile ${++fileCount}: `), filePath, colors.yellow('all API URL is follows: '));
+      argv.a &&
+        log.info(colors.green(`Mockfile ${++fileCount}: `), filePath, colors.yellow('all API URL is follows: '));
       const fileObject = getFileLatestContent(filePath);
       // eslint-disable-next-line no-loop-func
       Object.keys(fileObject).forEach(method => {
         const apiUrl = filePath2ApiUrl(decodeURIComponent(el.name.split('.')[0]));
-        log.info(colors.yellow(`path ${++count}: `), `${method} ${apiUrl}`, colors.blue(typeof fileObject[method]));
+        argv.a &&
+          log.info(colors.yellow(`path ${++count}: `), `${method} ${apiUrl}`, colors.blue(typeof fileObject[method]));
         log.assert(typeof app[method] === 'function', colors.red(`${filePath}, ${method}`));
         app[method](apiUrl, function (req, res) {
           res.json(fileObject[method]);
@@ -130,15 +133,17 @@ if (process.env.SPECIFIED_FILE) {
 } else {
   parseMockFiles(process.env.SPECIFIED_DIR);
 }
-log.info(chalk.hex('#ce5b34bd')(`${fileCount} mock file are parsed in total.`));
+argv.a && log.info(chalk.hex('#ce5b34bd')(`${fileCount} mock file are parsed in total.`));
 const http = require('http').createServer(app);
-if (process.env.SOCKETSERVER) {
+if (process.env.SOCKET_SERVER) {
   socketServer = new Server(http, { path: '/ws/mock-service' });
   log.info(colors.bgBlue(`Socket server has started. path: /ws/mock-service, `));
   socketServer.of('/mock-data').on('connection', function (socket) {
     const { headers, address } = socket.handshake;
     const clientIp = headers.hasOwnProperty('x-forwarded-for') ? headers['x-forwarded-for'] : address;
-    log.info(colors.green(`Socket client ${clientIp} has connected.`));
+    log.info(
+      colors.green(`Socket client ${clientIp} has connected.     --- ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`)
+    );
     socket.on('mock-dir-stat', function (dir) {
       socket.emit('mock-dir-stat', getMockStatFromDir(dir));
     });
@@ -151,7 +156,11 @@ if (process.env.SOCKETSERVER) {
     });
 
     socket.on('disconnect', function () {
-      log.info(colors.gray(`Socket client ${clientIp} has disconnected.`));
+      log.info(
+        colors.gray(
+          `Socket client ${clientIp} has disconnected.     --- ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`
+        )
+      );
     });
   });
 }

package/lib/utils.js

@@ -1,27 +1,40 @@
 /*
- * @description:
+ * @description: 工具函数库
  * @Date: 2021-12-25 17:52:48
  * @LastEditors: chendq
- * @LastEditTime: 2021-12-27 13:12:16
+ * @LastEditTime: 2021-12-31 23:10:02
  * @Author: chendq
  */
+const fs = require('fs');
+const path = require('path');
 /**
  * @description: 输出和错误输出写入不同文件
- * @param {*}
- * @return {*}
+ * @param {string} logFileDirPath
+ * @return {object}
  */
-const path = require('path');
-const getLogger = function () {
-  const fs = require('fs');
-  const output = fs.createWriteStream('./stdout.log');
-  const errorOutput = fs.createWriteStream('./stderr.log');
+const getLogger = function (logFileDirPath) {
+  const options = {
+    flags: 'a', // append模式
+    encoding: 'utf8' // utf8编码
+  };
+  const output = fs.createWriteStream(
+    path.resolve(logFileDirPath ? logFileDirPath : process.cwd(), './stdout.log'),
+    options
+  );
+  const errorOutput = fs.createWriteStream(
+    path.resolve(logFileDirPath ? logFileDirPath : process.cwd(), './stderr.log'),
+    options
+  );
   // 自定义日志打印
   const logger = new console.Console(output, errorOutput);
 
-  logger.log('向 stdout 中写入数据');
-  logger.error('向 stderr 中写入数据');
+  // logger.log('向 stdout 中写入数据');
+  // logger.error('向 stderr 中写入数据');
 
-  return logger;
+  return {
+    log: (...args) => logger.log.call(null, `[${dateFormat('YYYY-mm-dd HH:MM:SS:fff')}]  - `, ...args),
+    error: (...args) => logger.error.call(null, `[${dateFormat('YYYY-mm-dd HH:MM:SS:fff')}]  - `, ...args)
+  };
 };
 /**
  * @description: 格式化时间日期
@@ -29,7 +42,7 @@ const getLogger = function () {
  * @param {*} date
  * @returns {*}
  */
-function dateFormat(fmt, date) {
+function dateFormat(fmt, date = new Date()) {
   let ret;
   const opt = {
     'Y+': date.getFullYear().toString(), // 年
@@ -37,7 +50,8 @@ function dateFormat(fmt, date) {
     'd+': date.getDate().toString(), // 日
     'H+': date.getHours().toString(), // 时
     'M+': date.getMinutes().toString(), // 分
-    'S+': date.getSeconds().toString() // 秒
+    'S+': date.getSeconds().toString(), // 秒
+    'f+': date.getMilliseconds().toString() // 毫秒
     // 有其他格式化字符需求可以继续添加，必须转化成字符串
   };
   // eslint-disable-next-line guard-for-in
@@ -93,6 +107,59 @@ const getFileLatestContent = function (filePath) {
 const filePath2ApiUrl = function (filePath) {
   return filePath.split(path.sep).join('/');
 };
+/**
+ * @description: 获取数据类型
+ * @param {any} data 数据值
+ * @return {string} 数据类型
+ */
+const getDataType = function (data) {
+  return Object.prototype.toString.call(data).slice(8, -1).toLowerCase();
+};
+/**
+ * @description: 流方式写文件（适合写超大文件）
+ * @param {string} filePath
+ * @param {object} data
+ * @return {*}
+ */
+const writeStream = function (filePath, data) {
+  // 创建一个可写流   也会创建一个test1.txt文件
+  const writerStream = fs.createWriteStream(filePath);
+  // 将数据写入流
+  writerStream.write(data, 'utf-8');
+  // 标记文件的结束
+  writerStream.end();
+  writerStream.on('finish', () => {
+    // console.log('写入完成');
+  });
+  writerStream.on('error', () => {
+    console.error(`${filePath} 写入失败`);
+  });
+};
+/**
+ * @description: 流方式读文件（适合写超大文件）
+ * @param {string} filePath
+ * @return {*}
+ */
+const readeStream = function (filePath) {
+  let data = '';
+  // 创建可读流
+  return new Promise((resovle, reject) => {
+    const readerStream = fs.createReadStream(filePath);
+    // 设置编码为 utf8。
+    readerStream.setEncoding('UTF8');
+    // 处理流事件 --> data, end, and error
+    readerStream.on('data', function (chunk) {
+      data += chunk;
+    });
+    readerStream.on('end', function () {
+      resovle(data);
+    });
+    readerStream.on('error', function (err) {
+      reject(err);
+      console.log(err.stack);
+    });
+  });
+};
 
 module.exports = {
   getLogger,
@@ -101,5 +168,8 @@ module.exports = {
   SupportMethods,
   isValidMethod,
   getFileLatestContent,
-  filePath2ApiUrl
+  filePath2ApiUrl,
+  getDataType,
+  writeStream,
+  readeStream
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mock-service-cli",
-  "version": "2.0.5",
+  "version": "2.3.1",
   "description": "🦅 Local mock server",
   "main": "./lib/mockServer.js",
   "bin": {