@fairys/mocker-cli 0.0.1 → 0.0.2

package/README.md

@@ -31,6 +31,131 @@ Options:
 
 `FAIRYS_MOCKER_ROOT_DIR`或`root`：未设置时，取当前执行命令目录
 `FAIRYS_MOCKER_DIR`或者`dir`：未设置时，取当前执行命令目录的`mock`文件夹
-`FAIRYS_MOCKER_FILE`或者`file`：未设置时，取当前执行命令目录的`mock`文件夹下的`index.mock.ts`文件
-`FAIRYS_MOCKER_PROXY_FILE`或者`file2`：未设置时，取当前执行命令目录的`mock`文件夹下的`proxy.mock.ts`文件
+`FAIRYS_MOCKER_FILE`或者`file`：未设置时，取当前执行命令目录的`mock`文件夹下的`index.mock.cache.json`文件
+`FAIRYS_MOCKER_PROXY_FILE`或者`file2`：未设置时，取当前执行命令目录的`mock`文件夹下的`proxy.cache.json`文件
+
+在使用的过程中会生成4个文件
+
+1. `index.mock.cache.json`: 生成mock数据的原始配置(页面渲染取值)
+
+```json
+{
+  "mockList": [
+    {
+      "url": "/api/test",
+      "method": "POST",
+      "status": "200",
+      "delay": 0,
+      "body": {
+        "code": 200,
+        "data": {
+          "id": "@id",
+          "name": "@name",
+          "email": "@email"
+        },
+        "message": "success"
+      },
+      "listCount": 20
+    },
+  ],
+  "rootDir": "...",
+  "dir": "mock",
+  "fileName": "index.mock",
+  "cache": "index.mock.cache.json"
+}
+```
+
+2. `index.mock.ts`: 生成的mock数据
+
+```ts
+// Mock 配置文件
+export interface MockerItem {
+  /**该接口允许的 请求方法，默认同时支持 GET 和 POST*/
+  method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+  /**状态码*/
+  status: string;
+  //配置响应延迟时间, 如果传入的是一个数组，则代表延迟时间的范围
+  delay: number | [number, number];
+  /**响应体(可以自定义返回格式)*/
+  body: any;
+  /**接口地址*/
+  url: string;
+  /**列表数据条数（仅 list 格式有效）*/
+  listCount?: number;
+}
+/**mock配置 列表*/
+export type DefineMockList = MockerItem[];
+export const mockList: DefineMockList = [
+  {
+    "url": "/api/test",
+    "method": "POST",
+    "status": "200",
+    "delay": 0,
+    "body": {
+      "code": 200,
+      "message": "success",
+      "data": {
+        "id": "450000200805311843",
+        "name": "Sarah Lee",
+        "email": "u.azfjyqt@uscf.pe"
+      }
+    },
+    "listCount": 20
+  },
+];
+export default mockList;
+
+```
+
+3. `proxy.cache.json`: 生成代理数据原始配置(页面渲染取值)
+
+```json
+{
+  "proxyList": [
+    {
+      "path": "^/docks",
+      "target": "http://localhost:9009"
+    }
+  ],
+  "rootDir": "...",
+  "dir": "mock",
+  "fileName": "proxy",
+  "cache": "proxy.cache.json"
+}
+```
+
+4. `proxy.ts`: 生成的代理服务数据
+
+```tsx
+// 代理配置文件
+/**
+ * 代理配置参数
+ */
+export type ProxyItem = Record<string,{
+  /**转发地址*/
+  target: string,
+  /**路径重写*/
+  pathRewrite?: Record<string, string>,
+  /**是否开启ws*/
+  ws?: boolean
+}> 
+
+export const proxyConfig: ProxyItem = {
+  "^/tsx": {
+    "target": "http://localhost:9009"
+  },
+  "^/wsdse": {
+    "target": "http://localhost:8982",
+    "pathRewrite": {
+      "^/wsdse": ""
+    },
+    "ws": true
+  },
+  "^/docks": {
+    "target": "http://localhost:9009"
+  }
+};
+export default proxyConfig;
+    
+```
 

package/bin/fairys-mocker

@@ -12,9 +12,9 @@ if (enableCompileCache) {
   }
 }
 async function main() {
-  const { runExpressCli } = await import('../esm/ci.js');
+  const { runCli } = await import('../esm/ci.js');
   try {
-    runExpressCli();
+    runCli();
   } catch (err) {
     console.error(err);
   }

package/esm/base.js

@@ -23,7 +23,8 @@ class FairysMockerBase {
     staticServer = (dir, prefix = '/', isRegister = true)=>{
         if (!this.app) return;
         if (node_fs.existsSync(dir)) {
-            const _prefix = /^\/$/.test(prefix) ? prefix : `/${prefix}`;
+            let _prefix = prefix;
+            if (!/^\//.test(prefix)) _prefix = "/" + prefix;
             this.app.use(_prefix, express["static"](dir));
             if (isRegister) this.staticServerList.push(_prefix);
         } else console.log(chalk.red(`${dir} 目录不存在`));

package/esm/ci.d.ts

@@ -1,2 +1,4 @@
-export declare const runExpressCli: () => void;
-export declare const runConnectCli: () => void;
+import { FairysMockerExpress } from "./main.js";
+import { FairysMockerConnect } from "./connect.js";
+export declare const CI: (app: FairysMockerExpress | FairysMockerConnect) => void;
+export declare const runCli: () => void;

package/esm/ci.js

@@ -3,7 +3,7 @@ import { fairysMockerExpress } from "./main.js";
 import { fairysMockerConnect } from "./connect.js";
 import { utils } from "./utils/utils.js";
 function help() {
-    console.log('\n  Usage: \x1b[34;1fairys-mocker\x1b[0m [--help|h|--root|--dir|--file|--file2|--static|--static-prefix]');
+    console.log('\n  Usage: \x1b[34;1fairys-mocker\x1b[0m [--help|h|--root|--dir|--file|--file2|--static|--static-prefix|--is-mock-file|--is-proxy-file]');
     console.log('\n  Displays help information.');
     console.log('\n  Options:\n');
     console.log('   --root                   ', '设置根目录路径(默认取环境变量中的`FAIRYS_MOCKER_ROOT_DIR`).');
@@ -12,6 +12,9 @@ function help() {
     console.log('   --file2                  ', '设置文件名2(默认取环境变量中的`FAIRYS_MOCKER_PROXY_FILE`).');
     console.log('   --static                 ', '设置静态文件服务目录.');
     console.log('   --static-prefix          ', '设置静态文件服务目录访问前缀.');
+    console.log('   --is-mock-file           ', '是否生成mock数据文件,默认生成.');
+    console.log('   --is-proxy-file          ', '是否生成proxy数据文件,默认生成.');
+    console.log('   --is-connect             ', '是否是connect服务.默认express.');
     console.log('\n  Example:\n');
     console.log('   $ \x1b[35mfairys-mocker\x1b[0m --dir mock2');
     console.log('   $ \x1b[35mfairys-mocker\x1b[0m --file index.mock');
@@ -24,26 +27,27 @@ const argv = yargs_parser(process.argv.slice(2), {
         'file2',
         'static',
         'static-prefix'
+    ],
+    boolean: [
+        'is-mock-file',
+        "is-proxy-file",
+        'is-connect'
     ]
 });
-const runExpressCli = ()=>{
+const CI = (app)=>{
     if (argv.help | argv.h) return void help();
     utils.setRootDir(argv.root);
     utils.setDir(argv.dir);
     utils.setFile(argv.file);
     utils.setProxyFile(argv.file2);
-    fairysMockerExpress.start(()=>{
-        if (argv.static) fairysMockerExpress.staticServer(argv.static, argv['static-prefix']);
+    utils.setIsCreateMockDataFile(argv['is-mock-file']);
+    utils.setIsCreateProxyDataFile(argv['is-proxy-file']);
+    app.start(()=>{
+        if (!argv.static) return;
+        app.staticServer(argv.static, argv['static-prefix']);
     });
 };
-const runConnectCli = ()=>{
-    if (argv.help) return void help();
-    utils.setRootDir(argv.root);
-    utils.setDir(argv.dir);
-    utils.setFile(argv.file);
-    utils.setProxyFile(argv.file2);
-    fairysMockerConnect.start(()=>{
-        if (argv.static) fairysMockerConnect.staticServer(argv.static, argv['static-prefix']);
-    });
+const runCli = ()=>{
+    argv['is-connect'] ? CI(fairysMockerConnect) : CI(fairysMockerExpress);
 };
-export { runConnectCli, runExpressCli };
+export { CI, runCli };

package/esm/utils/mcok.proxy.js

@@ -30,8 +30,9 @@ const createProxyFile = (proxyList, rootDir, dir, fileName)=>{
         recursive: true
     });
     const proxyConfig = createProxyData(proxyList);
-    const proxyFilePath = node_path.join(proxyDir, `${_fileName}.ts`);
-    const proxyFileContent = `// 代理配置文件
+    if (utils.isCreateProxyDataFile) {
+        const proxyFilePath = node_path.join(proxyDir, `${_fileName}.ts`);
+        const proxyFileContent = `// 代理配置文件
 // 自动生成于 ${new Date().toISOString()}
 
 /**
@@ -49,7 +50,8 @@ export type ProxyItem = Record<string,{
 export const proxyConfig: ProxyItem = ${JSON.stringify(proxyConfig, null, 2)};
 export default proxyConfig;
     `;
-    node_fs.writeFileSync(proxyFilePath, proxyFileContent);
+        node_fs.writeFileSync(proxyFilePath, proxyFileContent);
+    }
     const cacheFilePath = node_path.join(proxyDir, _fileName + '.cache.json');
     const cacheFileContent = JSON.stringify({
         proxyList,
@@ -95,8 +97,9 @@ const createMockFile = (mockList, rootDir, dir, fileName)=>{
         recursive: true
     });
     const mockConfig = createMockData(mockList);
-    const mockFilePath = node_path.join(mockDir, `${_fileName}.ts`);
-    const mockFileContent = `// Mock 配置文件
+    if (utils.isCreateMockDataFile) {
+        const mockFilePath = node_path.join(mockDir, `${_fileName}.ts`);
+        const mockFileContent = `// Mock 配置文件
 // 自动生成于 ${new Date().toISOString()}
     
 export interface MockerItem {
@@ -120,7 +123,8 @@ export type DefineMockList = MockerItem[];
 export const mockList: DefineMockList = ${JSON.stringify(mockConfig, null, 2)};
 export default mockList;
     `;
-    node_fs.writeFileSync(mockFilePath, mockFileContent);
+        node_fs.writeFileSync(mockFilePath, mockFileContent);
+    }
     const cacheFilePath = node_path.join(mockDir, _fileName + '.cache.json');
     const cacheFileContent = JSON.stringify({
         mockList,

package/esm/utils/utils.d.ts

@@ -7,6 +7,10 @@ declare class Utils {
     file: string;
     /**代理文件名*/
     proxyFile: string;
+    /**是否生成mock数据文件*/
+    isCreateMockDataFile: boolean;
+    /**是否生成proxy数据文件*/
+    isCreateProxyDataFile: boolean;
     /**设置根目录*/
     setRootDir: (value?: string) => void;
     /**设置目录名*/
@@ -15,6 +19,10 @@ declare class Utils {
     setFile: (value?: string) => void;
     /**设置代理文件名*/
     setProxyFile: (value?: string) => void;
+    /**设置 是否生成mock数据文件*/
+    setIsCreateMockDataFile: (fig?: boolean) => void;
+    /**设置 是否生成proxy数据文件*/
+    setIsCreateProxyDataFile: (fig?: boolean) => void;
 }
 export declare const utils: Utils;
 export {};

package/esm/utils/utils.js

@@ -6,6 +6,8 @@ class Utils {
     dir = 'mock';
     file = 'index.mock';
     proxyFile = 'proxy';
+    isCreateMockDataFile = true;
+    isCreateProxyDataFile = true;
     setRootDir = (value)=>{
         if (value && node_fs.existsSync(value)) this.rootDir = value;
         else {
@@ -26,6 +28,12 @@ class Utils {
     setProxyFile = (value)=>{
         this.proxyFile = value || process.env.FAIRYS_MOCKER_PROXY_FILE || 'proxy';
     };
+    setIsCreateMockDataFile = (fig)=>{
+        if ("boolean" == typeof fig) this.isCreateMockDataFile = fig;
+    };
+    setIsCreateProxyDataFile = (fig)=>{
+        if ("boolean" == typeof fig) this.isCreateProxyDataFile = fig;
+    };
 }
 const utils = new Utils();
 export { utils };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fairys/mocker-cli",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Fairys Mocker CLI for mock data generation",
   "author": "SunLxy <1011771396@qq.com>",
   "homepage": "https://github.com/autumn-fairy-tales/fairys-mocker",
@@ -26,7 +26,7 @@
     "fairys-mocker": "bin/fairys-mocker"
   },
   "dependencies": {
-    "@fairys/create-mock-data": "^0.0.1",
+    "@fairys/create-mock-data": "^0.0.2",
     "body-parser": "2.2.2",
     "chalk": "^5.6.2",
     "connect": "^3.7.0",

package/src/base.ts

@@ -38,9 +38,12 @@ export class FairysMockerBase {
       return;
     }
     if (fs.existsSync(dir)) {
-      const _prefix = /^\/$/.test(prefix) ? prefix : `/${prefix}`;
+      let _prefix = prefix;
+      if (!/^\//.test(prefix)) {
+        _prefix = "/" + prefix
+      }
       this.app.use(_prefix, express.static(dir));
-      // console.log(chalk.green(`静态文件服务：${dir}`))
+      // console.log(chalk.green(`静态文件服务：${_prefix}\t${dir}`))
       if (isRegister) {
         this.staticServerList.push(_prefix)
       }

package/src/ci.ts

@@ -1,10 +1,10 @@
 import parser, { Arguments } from 'yargs-parser'
-import { fairysMockerExpress } from "./main.js"
-import { fairysMockerConnect } from "./connect.js"
+import { fairysMockerExpress, FairysMockerExpress } from "./main.js"
+import { fairysMockerConnect, FairysMockerConnect } from "./connect.js"
 import { utils } from "./utils/utils.js"
 
 function help() {
-  console.log('\n  Usage: \x1b[34;1fairys-mocker\x1b[0m [--help|h|--root|--dir|--file|--file2|--static|--static-prefix]');
+  console.log('\n  Usage: \x1b[34;1fairys-mocker\x1b[0m [--help|h|--root|--dir|--file|--file2|--static|--static-prefix|--is-mock-file|--is-proxy-file]');
   console.log('\n  Displays help information.');
   console.log('\n  Options:\n');
   console.log('   --root                   ', '设置根目录路径(默认取环境变量中的`FAIRYS_MOCKER_ROOT_DIR`).');
@@ -13,6 +13,9 @@ function help() {
   console.log('   --file2                  ', '设置文件名2(默认取环境变量中的`FAIRYS_MOCKER_PROXY_FILE`).');
   console.log('   --static                 ', '设置静态文件服务目录.');
   console.log('   --static-prefix          ', '设置静态文件服务目录访问前缀.');
+  console.log('   --is-mock-file           ', '是否生成mock数据文件,默认生成.');
+  console.log('   --is-proxy-file          ', '是否生成proxy数据文件,默认生成.');
+  console.log('   --is-connect             ', '是否是connect服务.默认express.');
 
   console.log('\n  Example:\n');
   console.log('   $ \x1b[35mfairys-mocker\x1b[0m --dir mock2');
@@ -21,9 +24,10 @@ function help() {
 
 const argv: Partial<Arguments> = parser(process.argv.slice(2), {
   string: ["root", 'dir', 'file', 'file2', 'static', 'static-prefix'],
+  boolean: ['is-mock-file', "is-proxy-file", 'is-connect']
 })
 
-export const runExpressCli = () => {
+export const CI = (app: FairysMockerExpress | FairysMockerConnect) => {
   if (argv.help | argv.h) {
     help();
     return;
@@ -32,30 +36,24 @@ export const runExpressCli = () => {
     utils.setDir(argv.dir);
     utils.setFile(argv.file);
     utils.setProxyFile(argv.file2);
+    utils.setIsCreateMockDataFile(argv['is-mock-file'])
+    utils.setIsCreateProxyDataFile(argv['is-proxy-file'])
     // 1. 直接当 mock 服务，
     // 2. 生成 mock 数据
     // 3. mock 服务 + 数据
-    fairysMockerExpress.start(() => {
-      if (argv.static) {
-        fairysMockerExpress.staticServer(argv.static, argv['static-prefix']);
+    app.start(() => {
+      if (!argv.static) {
+        return;
       }
+      app.staticServer(argv.static, argv['static-prefix']);
     });
   }
 }
 
-export const runConnectCli = () => {
-  if (argv.help) {
-    help();
-    return;
+export const runCli = () => {
+  if (argv['is-connect']) {
+    CI(fairysMockerConnect)
   } else {
-    utils.setRootDir(argv.root);
-    utils.setDir(argv.dir);
-    utils.setFile(argv.file);
-    utils.setProxyFile(argv.file2);
-    fairysMockerConnect.start(() => {
-      if (argv.static) {
-        fairysMockerConnect.staticServer(argv.static, argv['static-prefix']);
-      }
-    });
+    CI(fairysMockerExpress)
   }
-};
+}

package/src/utils/mcok.proxy.ts

@@ -38,9 +38,9 @@ export const createProxyFile = (proxyList: ProxyList, rootDir?: string, dir?: st
     fs.mkdirSync(proxyDir, { recursive: true });
   }
   const proxyConfig = createProxyData(proxyList)
-
-  const proxyFilePath = nodePath.join(proxyDir, `${_fileName}.ts`);
-  const proxyFileContent = `// 代理配置文件
+  if (utils.isCreateProxyDataFile) {
+    const proxyFilePath = nodePath.join(proxyDir, `${_fileName}.ts`);
+    const proxyFileContent = `// 代理配置文件
 // 自动生成于 ${new Date().toISOString()}
 
 /**
@@ -58,10 +58,11 @@ export type ProxyItem = Record<string,{
 export const proxyConfig: ProxyItem = ${JSON.stringify(proxyConfig, null, 2)};
 export default proxyConfig;
     `;
-  fs.writeFileSync(proxyFilePath, proxyFileContent);
+    fs.writeFileSync(proxyFilePath, proxyFileContent);
+  }
+
   // 存储原始的 proxyConfig 到 .cache.json 文件
   const cacheFilePath = nodePath.join(proxyDir, _fileName + '.cache.json');
-
   const cacheFileContent = JSON.stringify({
     proxyList,
     rootDir: _rootDir,
@@ -113,9 +114,9 @@ export const createMockFile = (mockList: DefineMockList, rootDir?: string, dir?:
     fs.mkdirSync(mockDir, { recursive: true });
   }
   const mockConfig = createMockData(mockList)
-
-  const mockFilePath = nodePath.join(mockDir, `${_fileName}.ts`);
-  const mockFileContent = `// Mock 配置文件
+  if (utils.isCreateMockDataFile) {
+    const mockFilePath = nodePath.join(mockDir, `${_fileName}.ts`);
+    const mockFileContent = `// Mock 配置文件
 // 自动生成于 ${new Date().toISOString()}
     
 export interface MockerItem {
@@ -139,7 +140,9 @@ export type DefineMockList = MockerItem[];
 export const mockList: DefineMockList = ${JSON.stringify(mockConfig, null, 2)};
 export default mockList;
     `;
-  fs.writeFileSync(mockFilePath, mockFileContent);
+    fs.writeFileSync(mockFilePath, mockFileContent);
+  }
+
   // 存储原始的 mockConfig 到 .cache.json 文件
   const cacheFilePath = nodePath.join(mockDir, _fileName + '.cache.json');
 

package/src/utils/utils.ts

@@ -12,6 +12,10 @@ class Utils {
   public file = 'index.mock';
   /**代理文件名*/
   public proxyFile = 'proxy';
+  /**是否生成mock数据文件*/
+  public isCreateMockDataFile = true;
+  /**是否生成proxy数据文件*/
+  public isCreateProxyDataFile = true;
 
   /**设置根目录*/
   setRootDir = (value?: string) => {
@@ -41,6 +45,21 @@ class Utils {
   setProxyFile = (value?: string) => {
     this.proxyFile = value || process.env.FAIRYS_MOCKER_PROXY_FILE || 'proxy';
   }
+
+  /**设置 是否生成mock数据文件*/
+  setIsCreateMockDataFile = (fig?: boolean) => {
+    if (typeof fig === "boolean") {
+      this.isCreateMockDataFile = fig
+    }
+  }
+
+  /**设置 是否生成proxy数据文件*/
+  setIsCreateProxyDataFile = (fig?: boolean) => {
+    if (typeof fig === "boolean") {
+      this.isCreateProxyDataFile = fig
+    }
+  }
+
 }
 
 export const utils = new Utils()