mock-service-cli 3.6.5 → 4.0.0

package/README.md

@@ -52,27 +52,28 @@ npx mock-service-cli [options] [path]
 
 ## 🛠️ 命令行选项
 
-| 选项                       | 描述                                                        | 默认值 |
-| -------------------------- | ----------------------------------------------------------- | ------ |
-| `-h` 或 `--help`           | 显示帮助信息                                                | -      |
-| `-p` 或 `--port`           | Mock 服务器端口                                             | 8090   |
-| `-d`                       | 指定 mock 目录                                              | ./mock |
-| `-f`                       | 指定单个 mock 文件                                          | -      |
-| `-s` 或 `--silent`         | 抑制日志输出                                                | -      |
-| `-v` 或 `--version`        | 显示版本信息                                                | -      |
-| `-S` 或 `--socket-server`  | 启动 socket 服务器，用于保存 API 响应数据                   | false  |
-| `-a` 或 `--api-stat`       | 打印 API URL 和文件路径信息                                 | false  |
-| `-t` 或 `--track`          | 记录操作信息到文件                                          | false  |
-| `-o` 或 `--cors-origin`    | 配置 CORS 允许的源，多个源用逗号分隔                        | \*     |
-| `-O` 或 `--proxy-options`  | 配置 HTTP 请求代理选项，支持 js 文件、json 文件或命令行参数 | -      |
-| `-H` 或 `--cors-headers`   | 配置 CORS 头信息                                            | \*     |
-| `-A` 或 `--append-headers` | 添加响应头信息，多个头用逗号分隔                            | -      |
-| `-D` 或 `--web-dir`        | 启用 Web 服务器，指定 web 目录（SPA 应用）                  | -      |
-| `-P` 或 `--web-port`       | Web 服务器端口                                              | 9090   |
-| `-b` 或 `--web-baseurl`    | 指定 SPA Web 服务器的公共路径                               | -      |
-| `-R` 或 `--static-server`  | 启用静态服务器，指定静态资源目录                            | -      |
-| `-w` 或 `--open`           | 自动打开 API 概览页、文件浏览器页                           | false  |
-| `-e` 或 `--explorer`       | 启用文件浏览器服务器，指定要浏览的目录                      | ./     |
+| 选项                       | 描述                                                              | 默认值 |
+| -------------------------- | ----------------------------------------------------------------- | ------ |
+| `-h` 或 `--help`           | 显示帮助信息                                                      | -      |
+| `-p` 或 `--port`           | Mock 服务器端口                                                   | 8090   |
+| `-d`                       | 指定 mock 目录                                                    | ./mock |
+| `-f`                       | 指定单个 mock 文件                                                | -      |
+| `-s` 或 `--silent`         | 抑制日志输出                                                      | -      |
+| `-v` 或 `--version`        | 显示版本信息                                                      | -      |
+| `-S` 或 `--socket-server`  | 启动 socket 服务器，用于保存 API 响应数据                         | false  |
+| `-a` 或 `--api-stat`       | 打印 API URL 和文件路径信息                                       | false  |
+| `-t` 或 `--track`          | 记录操作信息到文件                                                | false  |
+| `-o` 或 `--cors-origin`    | 配置 CORS 允许的源，多个源用逗号分隔                              | \*     |
+| `-O` 或 `--proxy-options`  | 配置 HTTP 请求代理选项，支持 js 文件、json 文件或命令行参数       | -      |
+| `-r` 或 `--rewrite`        | rewrite http or https request url prefix of proxy, default false. | false  |
+| `-H` 或 `--cors-headers`   | 配置 CORS 头信息                                                  | \*     |
+| `-A` 或 `--append-headers` | 添加响应头信息，多个头用逗号分隔                                  | -      |
+| `-D` 或 `--web-dir`        | 启用 Web 服务器，指定 web 目录（SPA 应用）                        | -      |
+| `-P` 或 `--web-port`       | Web 服务器端口                                                    | 9090   |
+| `-b` 或 `--web-baseurl`    | 指定 SPA Web 服务器的公共路径                                     | -      |
+| `-R` 或 `--static-server`  | 启用静态服务器，指定静态资源目录                                  | -      |
+| `-w` 或 `--open`           | 自动打开 API 概览页、文件浏览器页                                 | false  |
+| `-e` 或 `--explorer`       | 启用文件浏览器服务器，指定要浏览的目录                            | ./     |
 
 ## 📖 使用示例
 

package/bin/mock-service-cli

@@ -1,268 +1,3 @@
 #!/usr/bin/env node
 
-const colors = require('colors/safe'),
-  portfinder = require('portfinder'),
-  { resolve } = require('path'),
-  nodemon = require('nodemon');
-const { existsSync } = require('fs-extra');
-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) {
-  console.log(
-    [
-      'usage: mock-service-cli [options]',
-      '',
-      'PS: Mock File仅支持commonjs规范的js、cjs文件，不支持ES Module',
-      'options:',
-      '  -p --port            Mock server port to use. If 0, look for open port. [8090]',
-      '  -d                   Specify mock directory, default [./mock] directory,',
-      '                       Also watch js files changes and support hot reload',
-      '  -f --file            Specify the input data source, support javascript ',
-      '                       The priority is over the directory watches',
-      '  -s --silent          Suppress log messages from output',
-      '  -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.',
-      '  -t --track           Whether record operation info by write file, default false.',
-      '  -o --cors-origin     Allow origin by cors, list separated by commas, must not be * when withCredential is true',
-      '                       .If specified, cors-headers will be "Authorization,Content-Type,Accept,Origin,User-Agent,DNT',
-      '                       ,Cache-Control,X-Mx-ReqToken,X-Data-Type,X-Requested-With,X-Data-Type,X-Auth-Token,Token", default *.',
-      '  -H --cors-headers    When start Mock Server, optionally provide CORS headers list separated by commas. default *',
-      '  -A --append-headers  When start Mock/Web/Static Server, optionally add response headers list separated by commas.',
-      '                       For example: X-Frame-options=DENY,content-security-policy=frame-ancestors',
-      '',
-      '  -O --proxy-options   Optionally provide proxy options list separated by commas.',
-      '  -r --rewrite         rewrite http or https request url prefix of proxy, default false.',
-      '',
-      '  -D --web-dir         Enable web server, specify web directory, default [./dist] directory',
-      '  -P --web-port        Web server port to use. If 0, look for open port. [9090]',
-      '  -b --web-baseurl     Specify website public path when enabled web server.',
-      '',
-      '  -R --static-server   Specify static resource file directory when enabled static server.',
-      '',
-      '  -h --help            Print this list and exit.',
-      '  -v --version         Print the version and exit.',
-      '  -w --open            Open API overview page automatically, default false.',
-      '  -e --explorer        Enable file explorer server, specify directory to browse, default [./].'
-    ].join('\n')
-  );
-  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.S || false,
-  rewrite = argv.r || argv.rewrite || false,
-  isOpenApiOverview = argv.w || argv.open || false,
-  explorerDir = argv.e || argv.explorer,
-  log = null;
-
-if (!argv.s && !argv.silent) {
-  log = logger(false);
-} else if (colors) {
-  process.env.SILENT = true;
-  log = logger(true);
-}
-// 注入环境变量
-const injectEnvVariable = (envName, envArgs) => {
-  if (envArgs) {
-    process.env[envName] = envArgs;
-  }
-};
-
-if (isStartSocketServer) {
-  process.env.SOCKET_SERVER = true;
-}
-
-if (isOpenApiOverview) {
-  process.env.OPEN_API_OVERVIEW = true;
-}
-
-if (version) {
-  log.info('v' + require('../package.json').version);
-  process.exit();
-}
-injectEnvVariable('PREFIX_REWRITE', rewrite);
-injectEnvVariable('CORS_ORIGIN', argv.o || argv['cors-origin']);
-injectEnvVariable('CORS_HEADERS', argv.H || argv['cors-headers']);
-
-injectEnvVariable('WEB_PUBLIC_PATH', argv.b || argv['web-baseurl']);
-injectEnvVariable('STATIC_DIRECTORY', argv.R || argv['static-server']);
-injectEnvVariable('EXPLORER_DIRECTORY', explorerDir);
-// injectEnvVariable('PROXY_OPTIONS', argv.O || argv['proxy-options']);
-// 解析Web代理配置项（来源js|config文件或命令行参数字符串）
-const proxyArg = argv.O || argv['proxy-options'];
-if (proxyArg) {
-  const proxyTable = {};
-  if (proxyArg.endsWith('.js') || proxyArg.endsWith('.json')) {
-    const proxyOptFile = resolve(process.cwd(), proxyArg);
-    if (!existsSync(proxyOptFile)) {
-      console.error(`proxy-options: 文件 ${proxyOptFile} 不存在`);
-      process.exit();
-    }
-    const proxyObj = require(proxyOptFile);
-    Object.keys(proxyObj).forEach(function (h) {
-      proxyTable[h] = proxyObj[h];
-    }, this);
-  } else {
-    try {
-      proxyArg.split(/\s*,\s*/).forEach(function (h) {
-        const [origin, target] = h.split('|');
-        proxyTable[origin] = target;
-      }, this);
-    } catch (error) {
-      console.warn(colors.yellow('\nParse web proxy options Failed:', error));
-      throw error;
-    }
-  }
-  process.env.PROXY_OPTIONS = JSON.stringify(proxyTable);
-}
-// whether to start Web server or not
-if (argv.D || argv['web-dir']) {
-  // 解析SPA应用参数：SPA Web目录
-  process.env.WEB_ROOT = resolve(process.cwd(), argv.D || argv['web-dir']);
-  if (!existsSync(process.env.WEB_ROOT)) {
-    console.error(`web-dir: 目录 ${process.env.WEB_ROOT} 不存在`);
-    process.exit();
-  }
-  // Web Server port
-  portfinder.basePort = argv.P || argv['web-port'] || 9090;
-  portfinder.getPort(function (err, webPort) {
-    if (err) {
-      throw err;
-    }
-    process.env.WEB_PORT = webPort;
-    // Mock Server port
-    portfinder.basePort = port || 8090;
-    portfinder.getPort(function (err, port) {
-      if (err) {
-        throw err;
-      }
-      process.env.PORT = port;
-      initServe();
-    });
-  });
-} else {
-  // Mock Server port
-  portfinder.basePort = port || 8090;
-  portfinder.getPort(function (err, port) {
-    if (err) {
-      throw err;
-    }
-    process.env.PORT = port;
-    initServe();
-  });
-}
-
-/**
- * Watch change of mock files, restart serve
- * @param watchDir
- */
-function watchMockFiles(watchDir) {
-  /**
-   * script 重启的脚本
-   * ext 检测的文件
-   */
-  nodemon({
-    script: resolve(__dirname, '../lib/mockServer.js'),
-    watch: [watchDir],
-    ext: 'cjs,js,json'
-  });
-
-  nodemon
-    .on('start', function () {
-      // log.info('nodemon: mockServer has started');
-    })
-    .on('quit', function () {
-      // log.info('nodemon: mockServer has quit');
-      process.exit();
-    })
-    .on('restart', function (files) {
-      process.env.RESTARTED = true;
-      log.info(
-        [colors.green('\nnodemon: mockServer restarted due to: '), files, colors.green(' have changed'), '\n'].join('')
-      );
-    });
-}
-
-// Node子进程启动MockServer
-function startMockServer() {
-  spawn(node, [resolve(__dirname, '../lib/mockServer.js')], {
-    stdio: 'inherit'
-  });
-}
-
-// Node子进程启动StaticServer
-function startStaticServer() {
-  spawn(node, [resolve(__dirname, '../lib/staticServer.js')], {
-    stdio: 'inherit'
-  });
-}
-
-// Node子进程启动FileExplorerServer
-function startFileExplorerServer() {
-  spawn(node, [resolve(__dirname, '../lib/fileExplorerServer.js')], {
-    stdio: 'inherit'
-  });
-}
-/**
- * 初始化服务
- */
-function initServe() {
-  if (explorerDir) {
-    // 文件浏览器：指定目录
-    process.env.EXPLORER_DIRECTORY = resolve(process.cwd(), explorerDir);
-    if (!existsSync(process.env.EXPLORER_DIRECTORY)) {
-      console.error(`explorer: 目录 ${process.env.EXPLORER_DIRECTORY} 不存在`);
-      process.exit();
-    }
-    startFileExplorerServer();
-  } else if (specifiedFile) {
-    // Mock服务器：指定文件
-    process.env.SPECIFIED_FILE = resolve(process.cwd(), specifiedFile);
-    if (isStartSocketServer) {
-      startMockServer();
-    } else {
-      watchMockFiles(process.env.SPECIFIED_FILE);
-    }
-  } else if (watchDir) {
-    // Mock服务器：指定目录
-    process.env.SPECIFIED_DIR = resolve(process.cwd(), watchDir);
-    // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
-    if (isStartSocketServer) {
-      startMockServer();
-    } else {
-      watchMockFiles(process.env.SPECIFIED_DIR);
-    }
-  } else if (process.env.STATIC_DIRECTORY) {
-    // 静态服务器
-    process.env.STATIC_DIRECTORY = resolve(process.cwd(), process.env.STATIC_DIRECTORY);
-    startStaticServer();
-  } else {
-    // Mock服务：使用默认目录
-    watchDir = process.env.SPECIFIED_DIR = resolve(process.cwd(), './mock');
-    // log.info('SPECIFIED_DIR::', process.env.SPECIFIED_DIR);
-    if (isStartSocketServer) {
-      startMockServer();
-    } else {
-      // whether include web serve or not
-      const includesWebServe = process.env.STATIC_DIRECTORY || process.env.WEB_ROOT;
-
-      if (includesWebServe && !existsSync(resolve(process.cwd(), watchDir))) {
-        // 若包含web服务，则允许不启动mock服务
-        startMockServer();
-      } else {
-        watchMockFiles(watchDir);
-      }
-    }
-  }
-}
+require('../dist/cli');

package/{lib → dist}/asyncTaskQueue.js

@@ -1,25 +1,16 @@
-/*
- * @description: 异步任务队列
- * @Date: 2022-01-04 10:46:20
- * @LastEditors: chendq
- * @LastEditTime: 2026-03-15 17:23:52
- * @Author: chendq
- */
-// const { getDataType } = require('./utils');
-class AsyncTaskQueue {
+// src/lib/asyncTaskQueue.js
+var AsyncTaskQueue = class {
   constructor(isSaveItem = false) {
     this.list = [];
     this.index = 0;
     this.isStop = false;
     this.isParallel = false;
-    this.isSaveItem = isSaveItem; // 执行完成后的数据是否保留
+    this.isSaveItem = isSaveItem;
   }
-
   next() {
-    // 加限制
     if (this.index >= this.list.length - 1 || this.isStop) return;
     if (!this.isSaveItem) {
-      this.list.splice(this.index, 1, '');
+      this.list.splice(this.index, 1, "");
     }
     const cur = this.list[++this.index];
     cur(this.next.bind(this));
@@ -36,9 +27,8 @@ class AsyncTaskQueue {
    */
   run() {
     const cur = this.list[this.index];
-    typeof cur === 'function' && cur(this.next.bind(this));
+    typeof cur === "function" && cur(this.next.bind(this));
   }
-
   /**
    * @description: 并发执行异步任务
    */
@@ -48,14 +38,12 @@ class AsyncTaskQueue {
       fn(this.next.bind(this));
     }
   }
-
   /**
    * @description: 暂停执行异步任务
    */
   stop() {
     this.isStop = true;
   }
-
   /**
    * @description: 重试执行异步任务
    */
@@ -70,5 +58,5 @@ class AsyncTaskQueue {
     this.isStop = false;
     this.next();
   }
-}
+};
 module.exports = AsyncTaskQueue;