mock-service-cli 1.1.1 → 1.2.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 [chendq](https://github.com/chandq)
+Copyright (c) 2021-present, [chendq](https://github.com/chandq)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -10,7 +10,7 @@
 
 ### 简介
 
-简单、零配置的命令行 Mock 服务器， 支持热更新，对于前端开发调试很实用，能提高前端开发者的开发效率。
+**使用简单**、**零配置**、**0 秒启动**的本地命令行 Mock 服务器， 支持热更新，对于开发调试 mock 数据很实用，能提高前端开发者的开发效率。支持 `GET`,`POST`,`PUT`,`DELETE`,`PATCH`,`OPTIONS`,`COPY`,`LINK`,`UNLINK`,`PURGE` 等常用请求类型，对工程代码无任何侵入性，可能是本地最好用的 Mock 工具。
 
 ## Installation:
 
@@ -69,7 +69,17 @@ This will install `mock-service-cli` globally so that it may be run from the com
 
 ```javascript
 module.exports = {
-  '/mock/:id/test': { aa: 1, bb: '西西小飞龙' },
+  '/mock/:id/test': { aa: 1, bb: '默认GET请求' },
+  'GET /mock/:id/test': { aa: 1, bb: '指定GET 方法' },
+  'POST /mock/:id/test': { aa: 1, bb: 'POST 方法' },
+  'DELETE /mock/:id/test': { aa: 1, bb: 'DELETE 方法' },
+  'PUT /mock/:id/test': { aa: 1, bb: 'PUT 方法' },
+  'PATCH /mock/:id/test': { aa: 1, bb: 'PATCH 方法' },
+  'OPTIONS /mock/:id/test': { aa: 1, bb: 'OPTIONS 方法' },
+  'COPY /mock/:id/test': { aa: 1, bb: 'COPY 方法' },
+  'LINK /mock/:id/test': { aa: 1, bb: 'LINK 方法' },
+  'UNLINK /mock/:id/test': { aa: 1, bb: 'UNLINK 方法' },
+  'PURGE /mock/:id/test': { aa: 1, bb: 'PURGE 方法' },
   '/mock/video/test': (req, res) => {
     res.json({ aa: 1, bb: 'asdf' });
   },

package/bin/mock-service-cli

@@ -79,7 +79,9 @@ const watchMockFiles = function (watchDir) {
     })
     .on('restart', function (files) {
       process.env.RESTARTED = true;
-      log.info([colors.green('\nnodemon: mockServer restarted due to: '), files, '\n'].join(''));
+      log.info(
+        [colors.green('\nnodemon: mockServer restarted due to: '), files, colors.green(' have changed'), '\n'].join('')
+      );
     });
 };
 

package/lib/mockServer.js

@@ -8,8 +8,13 @@ const express = require('express'), // 引入express
 const ifaces = os.networkInterfaces();
 const { dateFormat, logger } = require('./utils');
 
+const methodRegExp = new RegExp('(GET|POST|PUT|DELETE|HEAD|PATCH|OPTIONS|COPY|LINK|UNLINK|PURGE) (.*)', 'i');
+
 const app = express();
 const log = logger(process.env.SILENT);
+
+let count = 0,
+  fileCount = 0; // 记录mock api个数,mock file个数
 let done = false;
 if (!process.env.PORT) {
   portfinder.basePort = 8090;
@@ -37,7 +42,7 @@ const crossDomain = () => (req, res, next) => {
   res.header('Access-Control-Allow-Credentials', true);
   // res.header('Access-Control-Allow-Origin', 'http://localhost:8081');
   res.header('Access-Control-Allow-Origin', '*');
-  res.header('Access-Control-Allow-Methods', 'GET,HEAD,OPTIONS,POST,PUT');
+  res.header('Access-Control-Allow-Methods', 'GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONS,COPY,LINK,UNLINK,PURGE');
   // res.header(
   //     'Access-Control-Allow-Headers',
   //     'Origin, X-Requested-With, Content-Type, Accept, Authorization'
@@ -57,13 +62,21 @@ const composeRoute = function (file) {
   delete require.cache[require.resolve(file)];
   const fileObject = require(path.resolve(__dirname, file));
 
-  log.info(colors.green('Mockfile: '), file);
+  log.info(colors.green(`Mockfile ${++fileCount}: `), file, colors.yellow('all API URL is follows: '));
   Object.keys(fileObject).forEach(item => {
-    log.info(colors.yellow('Traversal url: '), item, colors.blue(typeof fileObject[item]));
+    let reqMethod = 'get',
+      reqUrl = item;
+    // 支持(GET|POST|PUT|DELETE|HEAD|PATCH|OPTIONS|COPY|LINK|UNLINK|PURGE)常用方法, 默认GET请求
+    if (methodRegExp.exec(item)) {
+      const [, method, url] = methodRegExp.exec(item);
+      reqMethod = method.toLowerCase();
+      reqUrl = url;
+    }
+    log.info(colors.yellow(`path ${++count}: `), item, colors.blue(typeof fileObject[item]));
     if (typeof fileObject[item] === 'function') {
-      app.use(item, fileObject[item]);
+      app[reqMethod](reqUrl, fileObject[item]);
     } else if (typeof fileObject[item] === 'object') {
-      app.use(item, function (req, res) {
+      app[reqMethod](reqUrl, function (req, res) {
         res.json(fileObject[item]);
       });
     }
@@ -94,7 +107,6 @@ const parseMockFiles = function (specialDir = '../mock', isRootDir = true) {
   }
 };
 app.use(crossDomain());
-
 if (process.env.SPECIFIED_FILE) {
   composeRoute(process.env.SPECIFIED_FILE);
 } else {

package/package.json

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