mock-service-cli 3.7.0 → 4.0.0

package/package.json

@@ -1,15 +1,19 @@
 {
   "name": "mock-service-cli",
-  "version": "3.7.0",
+  "version": "4.0.0",
   "description": "🦅 Local Mock/Static/SPA server, Http?s request proxy, API overview page, File explorer",
-  "main": "./lib/mockServer.js",
+  "main": "./dist/mockServer.js",
   "bin": {
     "mock-service-cli": "bin/mock-service-cli"
   },
   "scripts": {
+    "build": "node ./scripts/build.js",
+    "prepack": "npm run build",
+    "prestart": "npm run build",
     "start": "node ./bin/mock-service-cli",
+    "pretest": "npm run build",
     "test:unit": "tap --reporter=spec test/*.test.js",
-    "test": "tap --cov --coverage-report=lcov --reporter=spec test/*.test.js ",
+    "test": "tap --cov --coverage-report=lcov --reporter=spec test/*.test.js",
     "test-watch": "tap --reporter=spec --watch test/*.test.js",
     "fix": "eslint --ext .js,.vue,.css --fix",
     "prettier": "prettier -c --write \"**/*.{ts,js,jsx,css,less,scss,json}\"",
@@ -21,12 +25,11 @@
     "release:major": "standard-version --release-as major && git push --follow-tags origin master"
   },
   "files": [
-    "lib",
     "bin",
-    "doc"
+    "dist"
   ],
   "engines": {
-    "node": ">=12"
+    "node": ">=16"
   },
   "author": "chendq <deqiaochen@gmail.com>",
   "keywords": [
@@ -50,27 +53,28 @@
   "license": "MIT",
   "homepage": "https://github.com/chandq/mock-service-cli#readme",
   "dependencies": {
-    "body-parser": "^1.20.2",
-    "colors": "^1.4.0",
-    "express": "^4.17.1",
-    "fs-extra": "^10.0.0",
-    "http-proxy-middleware": "^2.0.6",
-    "lodash": "^4.17.21",
-    "minimist": "^1.2.6",
-    "nodemon": "^2.0.19",
-    "portfinder": "^1.0.28",
-    "socket.io": "^4.4.0"
+    "nodemon": "^2.0.19"
   },
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^8.3.4",
     "babel-eslint": "^10.1.0",
+    "body-parser": "^1.20.2",
+    "colors": "^1.4.0",
+    "esbuild": "^0.21.5",
     "eslint": "^7.0.0",
     "eslint-config-populist": "^4.2.0",
     "eslint-plugin-mocha": "^9.0.0",
+    "express": "^4.17.1",
+    "fs-extra": "^10.0.0",
     "husky": "^4.3.8",
+    "http-proxy-middleware": "^2.0.6",
     "lint-staged": "^10.2.2",
+    "lodash": "^4.17.21",
+    "minimist": "^1.2.6",
     "mockjs": "^0.1.10",
+    "portfinder": "^1.0.28",
+    "socket.io": "^4.4.0",
     "standard-version": "^8.0.0",
     "tap": "^15.0.10"
   },
@@ -98,7 +102,7 @@
   },
   "directories": {
     "doc": "docs",
-    "lib": "lib",
+    "lib": "src/lib",
     "test": "test"
   }
 }

package/lib/fileExplorerServer.js

@@ -1,330 +0,0 @@
-const express = require('express'),
-  bodyParser = require('body-parser'),
-  { readdirSync, existsSync, readFileSync, statSync, createReadStream } = require('fs'),
-  os = require('os'),
-  path = require('path'),
-  colors = require('colors/safe'),
-  portfinder = require('portfinder'),
-  { exec } = require('child_process');
-const ifaces = os.networkInterfaces();
-const { dateFormat, logger } = require('./utils');
-
-const app = express();
-const log = logger(process.env.SILENT);
-const argv = JSON.parse(process.env.ARGV);
-
-const explorerRoot = process.env.EXPLORER_DIRECTORY || process.cwd();
-const port = argv.p || argv.port;
-
-if (!process.env.PORT) {
-  portfinder.basePort = port || 8090;
-  portfinder.getPort(function (err, foundPort) {
-    if (err) {
-      throw err;
-    }
-    process.env.PORT = foundPort;
-    init();
-  });
-} else {
-  init();
-}
-
-function init() {
-  app.use(crossDomain());
-  app.use(bodyParser.json());
-
-  // 文件浏览页面
-  app.get('/', (req, res) => {
-    const htmlPath = path.resolve(__dirname, './file-explorer.html');
-    if (existsSync(htmlPath)) {
-      res.sendFile(htmlPath);
-    } else {
-      res.status(404).send('File explorer page not found');
-    }
-  });
-
-  // 获取目录内容 API
-  app.get('/__api/list', (req, res) => {
-    let dirPath = req.query.path || '/';
-    dirPath = decodeURIComponent(dirPath);
-
-    let fullPath;
-    const resolvedRoot = path.resolve(explorerRoot);
-
-    if (explorerRoot === '/') {
-      // 根目录，可以直接使用绝对路径
-      fullPath = dirPath;
-    } else {
-      // 非根目录，应该将 dirPath 视为相对于 explorerRoot 的路径
-      // 如果 dirPath 以 / 开头，去掉前面的 /
-      const relativePath = dirPath.startsWith('/') ? dirPath.substring(1) : dirPath;
-      fullPath = path.resolve(explorerRoot, relativePath);
-    }
-
-    // 防止路径遍历攻击 - 确保路径不会越界
-    if (explorerRoot !== '/') {
-      if (!fullPath.startsWith(resolvedRoot)) {
-        return res.status(403).json({ error: 'Access denied' });
-      }
-    }
-
-    if (!existsSync(fullPath)) {
-      return res.status(404).json({ error: 'Path not found' });
-    }
-
-    const stats = statSync(fullPath);
-    if (!stats.isDirectory()) {
-      return res.status(400).json({ error: 'Not a directory' });
-    }
-
-    try {
-      const files = readdirSync(fullPath, { withFileTypes: true });
-      const result = [];
-
-      files.forEach(file => {
-        const filePath = path.join(fullPath, file.name);
-        let fileStats;
-        let hasError = false;
-
-        try {
-          fileStats = statSync(filePath);
-        } catch (statError) {
-          hasError = true;
-        }
-
-        const relativePath = path.join(dirPath, file.name);
-
-        // 使用 statSync 的结果，因为 readdirSync 在根目录对某些特殊目录识别不准确
-        const isDirectory = hasError ? file.isDirectory() : fileStats.isDirectory();
-
-        result.push({
-          name: file.name,
-          path: relativePath.replace(/\\/g, '/'),
-          isDirectory: isDirectory,
-          size: hasError ? 0 : fileStats.size,
-          mtime: hasError ? new Date() : fileStats.mtime,
-          birthtime: hasError ? new Date() : fileStats.birthtime,
-          isHidden: file.name.startsWith('.'),
-          error: hasError ? 'Cannot access file' : null
-        });
-      });
-
-      // 排序：目录在前，文件在后，然后按名称排序
-      result.sort((a, b) => {
-        if (a.isDirectory !== b.isDirectory) {
-          return a.isDirectory ? -1 : 1;
-        }
-        return a.name.localeCompare(b.name);
-      });
-
-      res.json({
-        currentPath: dirPath,
-        parentPath: dirPath === '/' ? null : path.dirname(dirPath).replace(/\\/g, '/'),
-        files: result
-      });
-    } catch (error) {
-      res.status(500).json({ error: error.message });
-    }
-  });
-
-  // 文件预览 API
-  app.get('/__api/file', (req, res) => {
-    let filePath = req.query.path || '/';
-    filePath = decodeURIComponent(filePath);
-
-    let fullPath;
-    const resolvedRoot = path.resolve(explorerRoot);
-
-    if (explorerRoot === '/') {
-      // 根目录，可以直接使用绝对路径
-      fullPath = filePath;
-    } else {
-      // 非根目录，应该将 filePath 视为相对于 explorerRoot 的路径
-      // 如果 filePath 以 / 开头，去掉前面的 /
-      const relativePath = filePath.startsWith('/') ? filePath.substring(1) : filePath;
-      fullPath = path.resolve(explorerRoot, relativePath);
-    }
-
-    // 防止路径遍历攻击 - 确保路径不会越界
-    if (explorerRoot !== '/') {
-      if (!fullPath.startsWith(resolvedRoot)) {
-        return res.status(403).json({ error: 'Access denied' });
-      }
-    }
-
-    if (!existsSync(fullPath)) {
-      return res.status(404).json({ error: 'File not found' });
-    }
-
-    const stats = statSync(fullPath);
-    if (stats.isDirectory()) {
-      return res.status(400).json({ error: 'Is a directory' });
-    }
-
-    const ext = path.extname(filePath).toLowerCase();
-    const imageExts = ['.jpg', '.jpeg', '.png', '.gif', '.bmp', '.webp', '.svg', '.ico'];
-    const textExts = ['.txt', '.json', '.js', '.css', '.html', '.xml', '.md', '.csv', '.yaml', '.yml', '.log'];
-
-    if (imageExts.includes(ext)) {
-      res.sendFile(fullPath);
-    } else if (textExts.includes(ext) || stats.size < 1024 * 1024) {
-      // 小于1MB的文件尝试作为文本读取
-      try {
-        const content = readFileSync(fullPath, 'utf-8');
-        res.json({
-          name: path.basename(filePath),
-          type: 'text',
-          content: content,
-          size: stats.size
-        });
-      } catch (error) {
-        // 如果不能作为文本读取，直接提供下载
-        res.download(fullPath);
-      }
-    } else {
-      res.download(fullPath);
-    }
-  });
-
-  // 在系统文件管理器中打开目录/文件 API
-  app.post('/__api/open-in-explorer', (req, res) => {
-    let filePath = req.body.path || '/';
-    filePath = decodeURIComponent(filePath);
-
-    let fullPath;
-    const resolvedRoot = path.resolve(explorerRoot);
-
-    if (explorerRoot === '/') {
-      // 根目录，可以直接使用绝对路径
-      fullPath = filePath;
-    } else {
-      // 非根目录，应该将 filePath 视为相对于 explorerRoot 的路径
-      // 如果 filePath 以 / 开头，去掉前面的 /
-      const relativePath = filePath.startsWith('/') ? filePath.substring(1) : filePath;
-      fullPath = path.resolve(explorerRoot, relativePath);
-    }
-
-    // 防止路径遍历攻击 - 确保路径不会越界
-    if (explorerRoot !== '/') {
-      if (!fullPath.startsWith(resolvedRoot)) {
-        return res.status(403).json({ error: 'Access denied' });
-      }
-    }
-
-    if (!existsSync(fullPath)) {
-      return res.status(404).json({ error: 'Path not found' });
-    }
-
-    let openCommand;
-    switch (process.platform) {
-      case 'darwin':
-        openCommand = `open "${fullPath}"`;
-        break;
-      case 'win32':
-        openCommand = `explorer "${fullPath}"`;
-        break;
-      case 'linux':
-        openCommand = `xdg-open "${fullPath}"`;
-        break;
-      default:
-        return res.status(400).json({ error: 'Unsupported platform' });
-    }
-
-    exec(openCommand, error => {
-      if (error) {
-        console.error(colors.red(`Failed to open in explorer: ${error.message}`));
-        return res.status(500).json({ error: 'Failed to open in explorer' });
-      }
-      res.json({ success: true, path: fullPath });
-    });
-  });
-
-  startServer();
-}
-
-function crossDomain() {
-  return (req, res, next) => {
-    res.header('Access-Control-Allow-Origin', '*');
-    res.header('Access-Control-Allow-Methods', 'GET,POST,PUT,DELETE,OPTIONS');
-    res.header('Access-Control-Allow-Headers', '*');
-    if (req.method === 'OPTIONS') res.status(200);
-    next();
-  };
-}
-
-function startServer() {
-  const http = require('http').createServer(app);
-
-  http.listen(Number.parseInt(process.env.PORT, 10), () => {
-    console.info(
-      [
-        colors.yellow(`\nStarting up file-explorer-server, serving `),
-        colors.cyan(explorerRoot),
-        colors.yellow(`  ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`)
-      ].join('')
-    );
-    console.info(
-      [
-        colors.yellow('\n🌍  file-explorer-server version: '),
-        colors.cyan(require('../package.json').version),
-        '\n'
-      ].join('')
-    );
-    console.info(colors.yellow(`\n File explorer server available on:\n`));
-    console.info('    http://localhost:' + colors.green(process.env.PORT));
-    Object.keys(ifaces).forEach(function (dev) {
-      ifaces[dev].forEach(function (details) {
-        if (details.family === 'IPv4') {
-          console.info('    http://' + details.address + ':' + colors.green(process.env.PORT));
-        }
-      });
-    });
-
-    // 自动打开浏览器
-    if (process.env.OPEN_API_OVERVIEW && !process.env.RESTARTED) {
-      const url = `http://localhost:${process.env.PORT}`;
-      console.info(colors.yellow(`\nOpening file explorer...`));
-      let openCommand;
-      switch (process.platform) {
-        case 'darwin':
-          openCommand = `open ${url}`;
-          break;
-        case 'win32':
-          openCommand = `start ${url}`;
-          break;
-        case 'linux':
-          openCommand = `xdg-open ${url}`;
-          break;
-        default:
-          console.warn(colors.yellow(`Could not automatically open browser. Please visit: ${url}`));
-          return;
-      }
-      exec(openCommand, error => {
-        if (error) {
-          console.warn(colors.yellow(`Could not automatically open browser. Please visit: ${url}`));
-        }
-      });
-    }
-  });
-}
-
-if (process.platform === 'win32') {
-  require('readline')
-    .createInterface({
-      input: process.stdin,
-      output: process.stdout
-    })
-    .on('SIGINT', function () {
-      process.emit('SIGINT');
-    });
-}
-
-process.on('SIGINT', function () {
-  log.info(colors.red('file-explorer-server process stopped.'));
-  process.exit();
-});
-
-process.on('SIGTERM', function () {
-  log.info(colors.red('file-explorer-server process stopped.'));
-  process.exit();
-});

package/lib/manageMockFiles.js

@@ -1,252 +0,0 @@
-/*
- * @description: 生成Mock文件、获取mock数据统计
- * @Date: 2021-12-22 16:57:08
- * @LastEditors: chendq
- * @LastEditTime: 2025-06-15 22:25:45
- * @Author: chendq
- */
-const fsa = require('fs-extra'),
-  fs = require('fs'),
-  path = require('path'),
-  isEqual = require('lodash/isEqual'),
-  colors = require('colors/safe');
-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) : {};
-
-const methodRegExp = new RegExp(`(${SupportMethods.join('|')}) +(.*)`, 'i');
-/**
- * @description: 记录日志文件函数
- * @param {boolean} isWriteLogFile 是否写入日志文件
- * @param {string} mockDir 存放日志文件的目录
- * @return {object}
- */
-const logFile = (isWriteLogFile = false, mockDir) => {
-  if (isWriteLogFile) {
-    return getLogger(mockDir);
-  }
-  return {
-    log: function () {},
-    error: function () {}
-  };
-};
-/**
- * @description: 生成mock文件（自动生成mock-list.json文件，并维护<url, [method]>的关系映射）
- * @param {string} apiUrl 请求url
- * @param {string} method 请求方法
- * @param {object} resJsonData 响应数据
- * @param {string} mockDir mock目录
- * @return {*} void
- *
- */
-const genMockFiles = async 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}, 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];
-  const LOGGER = logFile(processArgv.t || processArgv.track, 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`);
-  let newMockListContent = {};
-  if (fsa.pathExistsSync(mockListFilePath)) {
-    newMockListContent = getFileLatestContent(mockListFilePath);
-  } else {
-    fsa.ensureFileSync(mockListFilePath);
-  }
-
-  let isChange = false;
-  // update mock-list.json file
-  if (!newMockListContent.hasOwnProperty(normalizeApiUrl)) {
-    newMockListContent[normalizeApiUrl] = [method];
-    isChange = true;
-  } else if (!newMockListContent[normalizeApiUrl].includes(method)) {
-    newMockListContent[normalizeApiUrl].push(method);
-    isChange = true;
-  }
-  if (isChange) {
-    Object.keys(newMockListContent).length > 0 &&
-      fs.writeFileSync(mockListFilePath, JSON.stringify(newMockListContent, null, 2));
-  }
-
-  // mock文件存在
-  if (fsa.pathExistsSync(mockFilePath)) {
-    const mockFileContent = getFileLatestContent(mockFilePath);
-    // 内容一样不作修改
-    if (mockFileContent.hasOwnProperty(method) && isEqual(mockFileContent[method], resJsonData)) {
-      // log.assert(
-      //   !_.isEqual(mockFileContent[method], resJsonData),
-      //   colors.bgYellow(`${method} ${apiUrl}, Mock data is same`)
-      // );
-      return;
-    }
-    mockFileContent[method] = resJsonData;
-    try {
-      await writeStream(mockFilePath, JSON.stringify(mockFileContent, null, 2));
-    } catch (error) {
-      LOGGER.error(`Update file:  ${method} ${apiUrl}  ${mockFilePath}`);
-    }
-    LOGGER.log(`Update file:  ${method} ${apiUrl}  ${mockFilePath}`);
-  } else {
-    try {
-      await writeStream(mockFilePath, JSON.stringify({ [method]: resJsonData }, null, 2));
-    } catch (error) {
-      LOGGER.error(`New    file:  ${method} ${apiUrl}  ${mockFilePath}`);
-    }
-    LOGGER.log(`New    file:  ${method} ${apiUrl}  ${mockFilePath}`);
-  }
-  // console.debug('file::', `${mockDir}/${apiUrl}`, newMockListContent);
-};
-/**
- * @description: 从js文件中收集mock数据
- * @param {object} mockDataMap
- * @param {string} filePath
- * @return {*} void
- */
-const collectMockDataFromJsFile = function (mockDataMap, filePath) {
-  // 先删除require之前导入的缓存文件,否则获取到的文件内容还是旧内容
-  const fileObject = getFileLatestContent(filePath);
-
-  Object.keys(fileObject).forEach(item => {
-    let reqMethod = 'get',
-      reqUrl = item;
-    if (methodRegExp.exec(item)) {
-      const [, method, url] = methodRegExp.exec(item);
-      reqMethod = method.toLowerCase();
-      reqUrl = path.normalize(url);
-    }
-    if (typeof fileObject[item] === 'function') {
-      mockDataMap[`${reqMethod} ${reqUrl}`] = String(fileObject[item]);
-    } else if (typeof fileObject[item] === 'object') {
-      mockDataMap[`${reqMethod} ${reqUrl}`] = fileObject[item];
-    }
-  });
-};
-
-/**
- * @description: 递归收集mock数据
- * @param {object} mockDataMap mock数据集
- * @param {string} specialDir 目录
- * @return {*} void
- */
-const deepCollectMockData = function (mockDataMap, specialDir = '../mock') {
-  const files = fs.readdirSync(path.resolve(process.cwd(), specialDir), { withFileTypes: true });
-  const curFilesSize = files.length;
-  for (let index = 0; index < curFilesSize; index++) {
-    const el = files[index];
-    const filePath = path.normalize(`${specialDir}/${el.name}`);
-    // 递归目录
-    if (!el.isFile()) {
-      deepCollectMockData(mockDataMap, filePath);
-    }
-
-    // 处理存放mock数据的json文件
-    if (el.name.endsWith('.json') && el.name !== 'mock-list.json') {
-      const fileObject = getFileLatestContent(filePath);
-      Object.keys(fileObject).forEach(method => {
-        mockDataMap[`${method.toLocaleLowerCase()} ${decodeURIComponent(el.name).split('.json')[0]}`] =
-          fileObject[method];
-      });
-      continue;
-    }
-
-    // 非js文件跳过
-    if (!el.name.endsWith('.js')) {
-      continue;
-    }
-    collectMockDataFromJsFile(mockDataMap, filePath);
-  }
-};
-/**
- * @description: 从文件目录中获取mock数据统计（若mock-list.json文件不存在则自动生成）
- * @param {string} dirPath
- * @return {object} mock数据统计
- */
-const getMockStatFromDir = dirPath => {
-  if (!fsa.pathExistsSync(dirPath)) {
-    getLogger(path.resolve(process.cwd())).error(`入参无效，${dirPath} 目录不存在`);
-    return;
-  }
-  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 {object}  mock数据统计
- */
-const getMockStatFromFile = filePath => {
-  if (!fsa.pathExistsSync(filePath)) {
-    getLogger(path.resolve(process.cwd())).error(`入参无效，${filePath} 文件不存在`);
-    return;
-  }
-  const mockDataMap = {};
-  collectMockDataFromJsFile(mockDataMap, filePath);
-  return mockDataMap;
-};
-/**
- * @description: 判断Mock服务中是否存在某个API
- * @param {object} mockDataMap
- * @param {string} apiUrl
- * @param {string} method
- * @return {boolean}
- */
-const hasMockApi = function (mockDataMap, apiUrl, method) {
-  if (!apiUrl || !method || !mockDataMap || !(mockDataMap instanceof Object)) {
-    getLogger(path.resolve(process.cwd())).error(`入参无效，${mockDataMap} 必须是 mock数据的Object对象`);
-    return;
-  }
-  return mockDataMap.hasOwnProperty(`${method.toLocaleLowerCase()} ${path.normalize(apiUrl)}`);
-};
-
-module.exports = {
-  genMockFiles,
-  getMockStatFromDir,
-  getMockStatFromFile,
-  hasMockApi
-};