mock-service-cli 3.2.2 → 3.3.1

package/README.md

@@ -1,7 +1,6 @@
 [![Node.js CI](https://github.com/chandq/mock-service-cli/actions/workflows/node.js.yml/badge.svg)](https://github.com/chandq/mock-service-cli/actions/workflows/node.js.yml)
 [![Coverage Status](https://coveralls.io/repos/github/chandq/mock-service-cli/badge.svg?branch=master)](https://coveralls.io/github/chandq/mock-service-cli?branch=master)
 [![mock-service-cli](https://img.shields.io/github/package-json/v/chandq/mock-service-cli?style=flat-square)](https://github.com/chandq/mock-service-cli)
-[![node](https://img.shields.io/badge/node-v14.0.0-blue)](https://nodejs.org/download/release/v14.0.0/)
 [![node](https://img.shields.io/badge/language-node-orange.svg)](https://nodejs.org/download/release/v12.0.0/)
 [![license:MIT](https://img.shields.io/npm/l/vue.svg?sanitize=true)](https://github.com/chandq/mock-service-cli/blob/master/LICENSE.md)
 [![Downloads:?](https://img.shields.io/npm/dm/mock-service-cli.svg?sanitize=true)](https://npmcharts.com/compare/mock-service-cli?minimal=true)
@@ -10,7 +9,7 @@
 
 ### 简介
 
-内置 Mock Server、Web Server、Http?s request proxy 等功能集。
+内置 **Static Server**、**Mock Server**、**SPA Web Server**、Http?s request proxy 等功能集。
 
 **简易轻量**、**B/S 架构**、**0 秒启动**的本地命令行 Mock 服务套件， 支持热更新，对于开发调试 mock 数据很实用，能提高前端开发者的开发效率。支持 `GET`,`POST`,`PUT`,`DELETE`,`PATCH`,`OPTIONS`,`COPY`,`LINK`,`UNLINK`,`PURGE` 等常用请求类型，无需布署后端，可能是本地最好用的 Mock 工具之一。
 
@@ -19,8 +18,14 @@
 - 支持统计 mock 的文件数量和 mock 请求数量
 - 支持终端打开 mock 文件的所在位置
 
+#### Static Server (和 Mock Server 互斥使用)
+
+简易的静态资源服务器，可用于开发调试，如需更多使用场景，请选择 [http-server](https://www.npmjs.com/package/http-server)
+
 #### Mock Server - 本地 Mock 服务器
 
+> Mock File 仅支持 commonjs 规范的 js、cjs 文件，不支持 ES Module
+
 支持以下常见业务场景：
 
 - [x] 无服务端演示项目的数据 Mock
@@ -83,40 +88,45 @@ This will install `mock-service-cli` globally so that it may be run from the com
 | `-o` or `--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`                                     | \*       |
 | `-O` or `--proxy-options` | Optionally provide http request proxy options list, support accept js file、json file、cli arguments string. Examples: `-O '/api/apaas\|http://192.168.0.105:60700,/api/permission\| http://192.168.0.105:60700'`. Must start web server to use proxy for http request test under browser console or api test tools. | -        |
 | `-P` or `--web-port`      | Web server port to use. Use `-P 9090` to look for an open port, starting at 9090                                                                                                                                                                                                                                     | 9090     |
-| `-b` or `--web-baseurl`   | Specify public path of the static web server, can be base address of SPA route.                                                                                                                                                                                                                                      | -        |
+| `-b` or `--web-baseurl`   | Specify public path of the SPA web server, can be base address of SPA route.                                                                                                                                                                                                                                         | -        |
+| `-R` or `--static-server` | Specify directory of the Static Web Server.                                                                                                                                                                                                                                                                          | -        |
 
 ## Example
 
-1. Specify mock server port.
+1. Specify static resource file directory to startup Static Server.
+
+`mock-service-cli -R ./test`
+
+2. Specify mock server port.
 
 `mock-service-cli -p 8085`
 
-2. Enable cors of mock server, specify the origin and headers of http request.
+3. Enable cors of mock server, specify the origin and headers of http request.
 
 `mock-service-cli -o "http://192.168.0.8:38200,http://10.30.30.3" -H "custom-header"`
 
-3. Specify mock directory.
+4. Specify mock directory to startup Mock Server.
 
 `mock-service-cli -d ./mock`
 
-4. Specify mock file.
+5. Specify mock file to startup Mock Server.
 
 `mock-service-cli -f ./mock/test.js`
 
-5. Start socket server for used to save api response data.
+6. Start socket server for used to save api response data.
 
 `mock-service-cli -S`
 
-6. Only Used as api server for test on browser console or api request tools.
+7. Only Used as api server for test on browser console or api request tools.
    > must specified server directory which can be empty but not includes index.html file, and also need config API proxy.
 
 `mock-service-cli -D server -O '/api/apaas|http://192.168.0.105:60700'`
 
-7. Start static web server for SPA, and optionally specify public path and port.
+8. Start static web server for SPA, and optionally specify public path and port.
 
 `mock-service-cli -D ../react-best-practice/dist [-b '/redbridge/'] [-P 9090]`
 
-8. Enable Proxy base on above item 7. support accept js file、json file、cli arguments string
+9. Enable Proxy base on above item 7. support accept js file、json file、cli arguments string
 
    - cli arguments string
 

package/bin/mock-service-cli

@@ -16,6 +16,7 @@ if (argv.h || argv.help) {
     [
       '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,',
@@ -37,6 +38,8 @@ if (argv.h || argv.help) {
       '  -D --web-dir        Enable web server, specify web directory, default [./dist] directory',
       '  -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.'
     ].join('\n')
@@ -81,6 +84,7 @@ 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('PROXY_OPTIONS', argv.O || argv['proxy-options']);
 // 解析Web代理配置项（来源js|config文件或命令行参数字符串）
 const proxyArg = argv.O || argv['proxy-options'];
@@ -110,6 +114,7 @@ if (proxyArg) {
   process.env.PROXY_OPTIONS = JSON.stringify(proxyTable);
 }
 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} 不存在`);
@@ -142,7 +147,7 @@ const watchMockFiles = function (watchDir) {
   nodemon({
     script: resolve(__dirname, '../lib/mockServer.js'),
     watch: [watchDir],
-    ext: 'js,json'
+    ext: 'cjs,js,json'
   });
 
   nodemon
@@ -160,6 +165,7 @@ const watchMockFiles = function (watchDir) {
       );
     });
 };
+
 // Node子进程启动MockServer
 const startMockServer = function () {
   spawn(node, [resolve(__dirname, '../lib/mockServer.js')], {
@@ -167,7 +173,15 @@ const startMockServer = function () {
   });
 };
 
+// Node子进程启动StaticServer
+const startStaticServer = function () {
+  spawn(node, [resolve(__dirname, '../lib/staticServer.js')], {
+    stdio: 'inherit'
+  });
+};
+
 if (specifiedFile) {
+  // Mock服务器：指定文件
   process.env.SPECIFIED_FILE = resolve(process.cwd(), specifiedFile);
   if (isStartSocketServer) {
     startMockServer();
@@ -175,6 +189,7 @@ if (specifiedFile) {
     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) {
@@ -182,7 +197,12 @@ if (specifiedFile) {
   } 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) {

package/lib/mockServer.js

@@ -92,8 +92,8 @@ const composeRouteFromJsFile = function (file) {
   const fileObject = getFileLatestContent(file);
 
   argv.a && log.info(colors.green(`Mockfile ${++fileCount}: `), file, colors.yellow('all API URL is follows: '));
-  if (!fileObject) {
-    console.error(colors.red(`[warning] "${file}" 文件解析失败，请检查并确保文件中的js语法正确`));
+  if (fileObject === 'getFileLatestContent_ERROR') {
+    // console.error(colors.red(`[warning] "${file}" 文件解析失败，请检查并确保文件中的js语法正确`));
     return;
   }
   Object.keys(fileObject).forEach(item => {
@@ -143,8 +143,8 @@ const parseMockFiles = function (specialDir = '../mock') {
       argv.a &&
         log.info(colors.green(`Mockfile ${++fileCount}: `), filePath, colors.yellow('all API URL is follows: '));
       const fileObject = getFileLatestContent(filePath);
-      if (!fileObject) {
-        console.error(colors.red(`[warning] "${filePath}" 文件解析失败，请检查并确保文件中的js语法正确`));
+      if (fileObject === 'getFileLatestContent_ERROR') {
+        // console.error(colors.red(`[warning] "${filePath}" 文件解析失败，请检查并确保文件中的js语法正确`));
         continue;
       }
       // eslint-disable-next-line no-loop-func
@@ -166,7 +166,7 @@ const parseMockFiles = function (specialDir = '../mock') {
     }
 
     // 非js文件跳过
-    if (!el.name.endsWith('.js')) {
+    if (!el.name.endsWith('.js') && !el.name.endsWith('.cjs')) {
       continue;
     }
     composeRouteFromJsFile(filePath);
@@ -291,6 +291,8 @@ if (process.env.SOCKET_SERVER) {
 }
 
 http.listen(Number.parseInt(process.env.PORT, 10), () => {
+  console.info(colors.red('\n Mock File仅支持commonjs规范的js、cjs文件，不支持ES Module'));
+
   console.info(
     [
       colors.yellow(`\n${process.env.RESTARTED ? 'Restarting' : 'Starting'} up mock-server, serving `),
@@ -315,6 +317,7 @@ http.listen(Number.parseInt(process.env.PORT, 10), () => {
 });
 
 if (webApp && !process.env.RESTARTED) {
+  console.info(colors.red('\n Mock File仅支持commonjs规范的js、cjs文件，不支持ES Module'));
   webApp.listen(Number.parseInt(process.env.WEB_PORT, 10), () => {
     console.info(colors.yellow(`\n Web server available on:\n`));
     console.info('    http://localhost:' + colors.green(process.env.WEB_PORT) + webPublicPath);

package/lib/staticServer.js

@@ -0,0 +1,76 @@
+/*
+ * Static Server
+ * @Date: 2023-12-03 18:02:24
+ * @LastEditors: chendq
+ * @LastEditTime: 2023-12-03 18:44:33
+ * @Author      : chendq
+ */
+const express = require('express'), // 引入express
+  os = require('os'),
+  colors = require('colors/safe'),
+  portfinder = require('portfinder');
+const { dateFormat, logger } = require('./utils');
+const ifaces = os.networkInterfaces();
+const log = logger(process.env.SILENT);
+
+let done = false;
+if (!process.env.PORT) {
+  portfinder.basePort = 8090;
+  portfinder.getPort(function (err, port) {
+    if (err) {
+      throw err;
+    }
+    process.env.PORT = port;
+    done = true;
+  });
+} else {
+  done = true;
+}
+// 将异步函数转换为同步代码代码执行
+require('deasync').loopWhile(function () {
+  return !done;
+});
+const app = express();
+
+app.use(express.static(process.env.STATIC_DIRECTORY)); // 将dist目录下所有文件作为静态文件来管理
+
+app.listen(Number.parseInt(process.env.PORT, 10), () => {
+  console.info(
+    [
+      colors.yellow(`\nStarting up Static Server, serving `),
+      colors.cyan(process.env.STATIC_DIRECTORY),
+      colors.yellow(`  ${dateFormat('YYYY-mm-dd HH:MM:SS', new Date())}`)
+    ].join('')
+  );
+
+  console.info(colors.yellow(`\n Static 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.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('mock-server process stopped.'));
+  process.exit();
+});
+
+process.on('SIGTERM', function () {
+  log.info(colors.red('mock-server process stopped.'));
+  process.exit();
+});

package/lib/utils.js

@@ -2,10 +2,11 @@
  * @description: 工具函数库
  * @Date: 2021-12-25 17:52:48
  * @LastEditors: chendq
- * @LastEditTime: 2022-01-05 20:21:07
+ * @LastEditTime: 2024-01-16 22:28:37
  * @Author: chendq
  */
 const fs = require('fs');
+const colors = require('colors/safe');
 const path = require('path');
 // const JSONStream = require('JSONStream');
 /**
@@ -102,9 +103,12 @@ const getFileLatestContent = function (filePath) {
     delete require.cache[require.resolve(filePath)];
     return require(path.resolve(process.cwd(), filePath));
   } catch (error) {
-    getLogger(path.resolve(process.cwd())).error(filePath, require.cache[require.resolve(filePath)], error);
+    // getLogger(path.resolve(process.cwd())).error(filePath, require.cache[require.resolve(filePath)], error);
+    console.error(colors.red('[error]:'), error);
+    return 'getFileLatestContent_ERROR';
   }
 };
+
 /**
  * @description: 文件路径转成API的url
  * @param {string} filePath

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mock-service-cli",
-  "version": "3.2.2",
+  "version": "3.3.1",
   "description": "🦅 Local mock server",
   "main": "./lib/mockServer.js",
   "bin": {
@@ -16,7 +16,7 @@
     "prettier": "prettier -c --write \"**/*.{ts,js,jsx,css,less,scss,json}\"",
     "release:prerelease": "standard-version --prerelease",
     "release:prefix": "standard-version --prerelease alpha",
-    "release:patch": "standard-version --release-as patch && git push origin master && npm publish",
+    "release:patch": "standard-version --release-as patch && git push --follow-tags origin master",
     "release:minor": "standard-version --release-as minor && git push --follow-tags origin master",
     "release:major": "standard-version --release-as major && git push --follow-tags origin master"
   },
@@ -32,6 +32,7 @@
   "packageManager": "yarn@1.22.19",
   "keywords": [
     "MIT-licensed",
+    "Static Server",
     "Mock",
     "MockServer",
     "mock-service-cli",
@@ -67,7 +68,7 @@
     "eslint-plugin-mocha": "^9.0.0",
     "husky": "^4.3.8",
     "lint-staged": "^10.2.2",
-    "mockjs": "^1.1.0",
+    "mockjs": "^0.1.10",
     "standard-version": "^8.0.0",
     "tap": "^15.0.10"
   },