mock-service-cli 2.0.1 → 2.0.5

package/CHANGELOG.md

@@ -2,6 +2,34 @@
 
 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.0.5](https://github.com/chandq/mock-service-cli/compare/v2.0.4...v2.0.5) (2021-12-28)
+
+
+### Bug Fixes
+
+* validate func parameter to avoid exception ([32e4d28](https://github.com/chandq/mock-service-cli/commit/32e4d28114a4907352491e16829d37345fbab9d9))
+
+### [2.0.4](https://github.com/chandq/mock-service-cli/compare/v2.0.3...v2.0.4) (2021-12-27)
+
+
+### Bug Fixes
+
+* get valid api url for route ([8770751](https://github.com/chandq/mock-service-cli/commit/877075107ea60244a52e345f37b7df855752d5f6))
+
+### [2.0.3](https://github.com/chandq/mock-service-cli/compare/v2.0.2...v2.0.3) (2021-12-27)
+
+
+### Bug Fixes
+
+* convert windows file path to api url ([1f15b33](https://github.com/chandq/mock-service-cli/commit/1f15b334ab5374bc102e5e11fbfaae994569bca5))
+
+### [2.0.2](https://github.com/chandq/mock-service-cli/compare/v2.0.1...v2.0.2) (2021-12-27)
+
+
+### Bug Fixes
+
+* issue of convert path ([5276488](https://github.com/chandq/mock-service-cli/commit/527648866f20fd25b5df0dc55b3898d7e7a1ad2c))
+
 ### [2.0.1](https://github.com/chandq/mock-service-cli/compare/v2.0.0...v2.0.1) (2021-12-27)
 
 

package/bin/mock-service-cli

@@ -70,7 +70,7 @@ const watchMockFiles = function (watchDir) {
    * ext 检测的文件
    */
   nodemon({
-    script: path.join(__dirname, '../lib/mockServer.js'),
+    script: path.resolve(__dirname, '../lib/mockServer.js'),
     watch: [watchDir],
     ext: 'js,json'
   });
@@ -92,14 +92,14 @@ const watchMockFiles = function (watchDir) {
 };
 
 if (specifiedFile) {
-  process.env.SPECIFIED_FILE = path.join(process.cwd(), specifiedFile);
+  process.env.SPECIFIED_FILE = path.resolve(process.cwd(), specifiedFile);
   watchMockFiles(process.env.SPECIFIED_FILE);
 } else if (watchDir) {
-  process.env.SPECIFIED_DIR = path.join(process.cwd(), watchDir);
+  process.env.SPECIFIED_DIR = path.resolve(process.cwd(), watchDir);
   // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
   watchMockFiles(process.env.SPECIFIED_DIR);
 } else {
-  watchDir = process.env.SPECIFIED_DIR = path.join(process.cwd(), './mock');
+  watchDir = process.env.SPECIFIED_DIR = path.resolve(process.cwd(), './mock');
   // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
   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-27 10:15:01
+ * @LastEditTime: 2021-12-28 16:23:43
  * @Author: chendq
  */
 const fsa = require('fs-extra'),
@@ -10,7 +10,7 @@ const fsa = require('fs-extra'),
   path = require('path'),
   _ = require('lodash'),
   colors = require('colors/safe');
-const { getFileLatestContent, SupportMethods, logger } = require('./utils');
+const { getFileLatestContent, SupportMethods, filePath2ApiUrl, logger } = require('./utils');
 const log = logger(process.env.SILENT);
 
 const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
@@ -24,9 +24,16 @@ const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
  *
  */
 const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mockDir }) {
-  const normalizeUrl = path.normalize(apiUrl);
+  if (!apiUrl || !method || !resJsonData || !mockDir) {
+    log.info(
+      colors.red(`参数: apiUrl: ${apiUrl}, method: ${method}, resJsonData: ${resJsonData}, mockDir: ${mockDir}无效`)
+    );
+    return;
+  }
+  apiUrl = apiUrl.trim().split('?')[0];
+  const normalizeApiUrl = filePath2ApiUrl(path.normalize(apiUrl));
   const mockListFilePath = path.resolve(process.cwd(), `${mockDir}/mock-list.json`);
-  const mockFilePath = path.resolve(process.cwd(), `${mockDir}/${encodeURIComponent(normalizeUrl)}.json`);
+  const mockFilePath = path.resolve(process.cwd(), `${mockDir}/${encodeURIComponent(path.normalize(apiUrl))}.json`);
   let newMockListContent = {},
     oldMockListContent = null;
   if (fsa.pathExistsSync(mockListFilePath)) {
@@ -37,13 +44,14 @@ const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mo
   }
 
   // update mock-list.json file
-  if (!newMockListContent.hasOwnProperty(normalizeUrl)) {
-    newMockListContent[normalizeUrl] = [method];
-  } else if (!newMockListContent[normalizeUrl].includes(method)) {
-    newMockListContent[normalizeUrl].push(method);
+  if (!newMockListContent.hasOwnProperty(normalizeApiUrl)) {
+    newMockListContent[normalizeApiUrl] = [method];
+  } else if (!newMockListContent[normalizeApiUrl].includes(method)) {
+    newMockListContent[normalizeApiUrl].push(method);
   }
   if (!oldMockListContent || !_.isEqual(oldMockListContent, newMockListContent)) {
-    fsa.writeFileSync(mockListFilePath, JSON.stringify(newMockListContent, null, 2));
+    Object.keys(newMockListContent).length > 0 &&
+      fsa.writeFileSync(mockListFilePath, JSON.stringify(newMockListContent, null, 2));
   }
 
   // mock文件存在
@@ -58,12 +66,14 @@ const genMockFiles = function ({ url: apiUrl, method, data: resJsonData, dir: mo
       return;
     }
     mockFileContent[method] = resJsonData ? resJsonData : {};
-    fsa.writeFileSync(mockFilePath, JSON.stringify(mockFileContent, null, 2));
+    Object.keys(mockFileContent).length > 0 &&
+      fsa.writeFileSync(mockFilePath, JSON.stringify(mockFileContent, null, 2));
   } else {
     // fsa.ensureFileSync(mockFilePath);
-    fsa.writeFileSync(mockFilePath, JSON.stringify({ [method]: resJsonData ? resJsonData : {} }, null, 2));
+    Object.keys(mockFilePath).length > 0 &&
+      fsa.writeFileSync(mockFilePath, JSON.stringify({ [method]: resJsonData ? resJsonData : {} }, null, 2));
   }
-  // console.debug('file::', `${mockDir}/${normalizeUrl}`, newMockListContent);
+  // console.debug('file::', `${mockDir}/${apiUrl}`, newMockListContent);
 };
 /**
  * @description: 从js文件中收集mock数据
@@ -131,6 +141,9 @@ const deepCollectMockData = function (mockDataMap, specialDir = '../mock') {
  * @return {map} mock数据统计
  */
 const getMockStatFromDir = dirPath => {
+  if (!fsa.pathExistsSync(dirPath)) {
+    throw new Error(`如参无效，${dirPath} 目录不存在`);
+  }
   const mockDataMap = {};
   deepCollectMockData(mockDataMap, dirPath);
   return mockDataMap;
@@ -142,6 +155,9 @@ const getMockStatFromDir = dirPath => {
  * @return {map}  mock数据统计
  */
 const getMockStatFromFile = filePath => {
+  if (!fsa.pathExistsSync(filePath)) {
+    throw new Error(`如参无效，${filePath} 文件不存在`);
+  }
   const mockDataMap = {};
   collectMockDataFromJsFile(mockDataMap, filePath);
   return mockDataMap;
@@ -154,7 +170,7 @@ const getMockStatFromFile = filePath => {
  * @return {boolean}
  */
 const hasMockApi = function (mockDataMap, apiUrl, method) {
-  if (!mockDataMap || !(mockDataMap instanceof Object)) {
+  if (!apiUrl || !method || !mockDataMap || !(mockDataMap instanceof Object)) {
     throw new Error(`如参无效，${mockDataMap} 必须是 mock数据的Object对象`);
   }
   return mockDataMap.hasOwnProperty(`${method.toLocaleLowerCase()} ${path.normalize(apiUrl)}`);

package/lib/mockServer.js

@@ -7,7 +7,7 @@ const express = require('express'), // 引入express
   chalk = require('chalk');
 const ifaces = os.networkInterfaces();
 const { Server } = require('socket.io');
-const { dateFormat, logger, SupportMethods, getFileLatestContent } = require('./utils');
+const { dateFormat, logger, SupportMethods, getFileLatestContent, filePath2ApiUrl } = require('./utils');
 const { genMockFiles, getMockStatFromDir, getMockStatFromFile } = require('./manageMockFiles');
 
 const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
@@ -60,7 +60,7 @@ const crossDomain = () => (req, res, next) => {
  * @param {*} file
  * @returns {*}
  */
-const composeRoute = function (file) {
+const composeRouteFromJsFile = function (file) {
   // 先删除require之前导入的缓存文件,否则获取到的文件内容还是旧内容
   const fileObject = getFileLatestContent(file);
 
@@ -107,7 +107,7 @@ const parseMockFiles = function (specialDir = '../mock') {
       const fileObject = getFileLatestContent(filePath);
       // eslint-disable-next-line no-loop-func
       Object.keys(fileObject).forEach(method => {
-        const apiUrl = decodeURIComponent(el.name.split('.')[0]);
+        const apiUrl = filePath2ApiUrl(decodeURIComponent(el.name.split('.')[0]));
         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) {
@@ -121,12 +121,12 @@ const parseMockFiles = function (specialDir = '../mock') {
     if (!el.name.endsWith('.js')) {
       continue;
     }
-    composeRoute(filePath);
+    composeRouteFromJsFile(filePath);
   }
 };
 app.use(crossDomain());
 if (process.env.SPECIFIED_FILE) {
-  composeRoute(process.env.SPECIFIED_FILE);
+  composeRouteFromJsFile(process.env.SPECIFIED_FILE);
 } else {
   parseMockFiles(process.env.SPECIFIED_DIR);
 }
@@ -201,6 +201,6 @@ process.on('SIGTERM', function () {
 });
 
 module.exports = {
-  composeRoute,
+  composeRouteFromJsFile,
   parseMockFiles
 };

package/lib/utils.js

@@ -1,3 +1,10 @@
+/*
+ * @description:
+ * @Date: 2021-12-25 17:52:48
+ * @LastEditors: chendq
+ * @LastEditTime: 2021-12-27 13:12:16
+ * @Author: chendq
+ */
 /**
  * @description: 输出和错误输出写入不同文件
  * @param {*}
@@ -78,5 +85,21 @@ const getFileLatestContent = function (filePath) {
   delete require.cache[require.resolve(filePath)];
   return require(path.resolve(process.cwd(), filePath));
 };
+/**
+ * @description: 文件路径转成API的url
+ * @param {string} filePath
+ * @return {string} apiUrl
+ */
+const filePath2ApiUrl = function (filePath) {
+  return filePath.split(path.sep).join('/');
+};
 
-module.exports = { getLogger, dateFormat, logger, SupportMethods, isValidMethod, getFileLatestContent };
+module.exports = {
+  getLogger,
+  dateFormat,
+  logger,
+  SupportMethods,
+  isValidMethod,
+  getFileLatestContent,
+  filePath2ApiUrl
+};

package/package.json

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