@fairys/mocker-cli 0.0.1

package/src/base.ts

@@ -0,0 +1,125 @@
+
+import express from 'express';
+import connect from 'connect';
+import fs from 'node:fs';
+import cors from "cors"
+import nodePath from "node:path";
+import { fileURLToPath } from "node:url";
+import { MockRouterController } from "./controller/mock.router.js"
+import { ClassStruct, registerRoutes } from "./utils/decorator.js"
+import { ProxyRouterController } from "./controller/proxy.router.js"
+import chalk from "chalk"
+import http from "node:http";
+
+// 转换成 __filename 和 __dirname
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = nodePath.dirname(__filename);
+
+export class FairysMockerBase {
+  /**服务*/
+  server: http.Server | undefined = undefined
+  /**主路由*/
+  router: express.Router | undefined = undefined;
+  /**内置路由*/
+  fairysMockerRouter: express.Router | undefined = undefined;
+  /**子应用*/
+  app: express.Express | undefined = undefined;
+  /**主应用*/
+  mainApp: express.Express | connect.Server | undefined = undefined;
+  /**类*/
+  controller: ClassStruct[] = [MockRouterController, ProxyRouterController];
+
+  /**静态文件服务列表*/
+  staticServerList: string[] = [];
+
+  /**静态文件服务*/
+  staticServer = (dir: string, prefix: string = '/', isRegister: boolean = true) => {
+    if (!this.app) {
+      return;
+    }
+    if (fs.existsSync(dir)) {
+      const _prefix = /^\/$/.test(prefix) ? prefix : `/${prefix}`;
+      this.app.use(_prefix, express.static(dir));
+      // console.log(chalk.green(`静态文件服务：${dir}`))
+      if (isRegister) {
+        this.staticServerList.push(_prefix)
+      }
+    } else {
+      console.log(chalk.red(`${dir} 目录不存在`))
+    }
+  }
+
+  /**初始化 app 服务*/
+  initApp = (app: express.Express | connect.Server, cb?: () => void): express.Express | connect.Server => {
+    if (!this.app) {
+      console.log('')
+      console.log(chalk.hex('#54FF9F')('===fairys-mocker================='))
+      console.log('')
+
+      this.mainApp = app
+      this.app = express();
+      // 挂子应用
+      this.mainApp.use(this.app)
+
+      this.app.use(express.json());
+      this.app.use(cors());
+      /**注册主路由*/
+      this.router = express.Router();
+      /**注册内置路由*/
+      this.fairysMockerRouter = express.Router();
+      this.router.use(this.fairysMockerRouter);
+
+      // 静态文件服务
+      const staticDir = nodePath.join(__dirname, '../public/_fairys_mocker');
+      this.staticServer(staticDir, '/_fairys_mocker', false);
+
+      for (let index = 0; index < this.controller.length; index++) {
+        const Controller = this.controller[index];
+        const newController = new Controller();
+        registerRoutes(newController)
+        // @ts-ignore
+        const start = newController?.start;
+        if (typeof start === 'function') {
+          start()
+        }
+      }
+      this.app.use('/', this.router);
+
+      cb?.()
+
+      console.log('')
+
+    } else {
+      console.log('挂载 主应用 服务')
+      this.mainApp = app
+      this.mainApp.use(this.app)
+    }
+    return app;
+  }
+
+  /**启动日志打印服务器地址*/
+  logServer = async (port: number) => {
+    if (!this.app) {
+      console.log(chalk.red('请先初始化 app'));
+      return;
+    }
+    console.log("")
+    console.log(chalk.green(`\tfairys-mocker API地址:    http://localhost:${port}`));
+    console.log(chalk.green(`\tfairys-mocker UI地址:     http://localhost:${port}/_fairys_mocker`));
+    console.log("")
+    for (let index = 0; index < this.staticServerList.length; index++) {
+      const element = this.staticServerList[index];
+      console.log(chalk.green(`\tfairys-mocker 静态服务 ${chalk.yellow(element)} 地址:     http://localhost:${port}${element}`));
+    }
+    console.log("")
+  }
+
+  close = () => {
+    if (this.server) {
+      this.server.close();
+    }
+  }
+}
+
+export const fairysMockerBase = new FairysMockerBase();
+

package/src/ci.ts

@@ -0,0 +1,61 @@
+import parser, { Arguments } from 'yargs-parser'
+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  Displays help information.');
+  console.log('\n  Options:\n');
+  console.log('   --root                   ', '设置根目录路径(默认取环境变量中的`FAIRYS_MOCKER_ROOT_DIR`).');
+  console.log('   --dir                    ', '设置目录名(默认取环境变量中的`FAIRYS_MOCKER_DIR`).');
+  console.log('   --file                   ', '设置文件名(默认取环境变量中的`FAIRYS_MOCKER_FILE`).');
+  console.log('   --file2                  ', '设置文件名2(默认取环境变量中的`FAIRYS_MOCKER_PROXY_FILE`).');
+  console.log('   --static                 ', '设置静态文件服务目录.');
+  console.log('   --static-prefix          ', '设置静态文件服务目录访问前缀.');
+
+  console.log('\n  Example:\n');
+  console.log('   $ \x1b[35mfairys-mocker\x1b[0m --dir mock2');
+  console.log('   $ \x1b[35mfairys-mocker\x1b[0m --file index.mock');
+}
+
+const argv: Partial<Arguments> = parser(process.argv.slice(2), {
+  string: ["root", 'dir', 'file', 'file2', 'static', 'static-prefix'],
+})
+
+export const runExpressCli = () => {
+  if (argv.help | argv.h) {
+    help();
+    return;
+  } else {
+    utils.setRootDir(argv.root);
+    utils.setDir(argv.dir);
+    utils.setFile(argv.file);
+    utils.setProxyFile(argv.file2);
+    // 1. 直接当 mock 服务，
+    // 2. 生成 mock 数据
+    // 3. mock 服务 + 数据
+    fairysMockerExpress.start(() => {
+      if (argv.static) {
+        fairysMockerExpress.staticServer(argv.static, argv['static-prefix']);
+      }
+    });
+  }
+}
+
+export const runConnectCli = () => {
+  if (argv.help) {
+    help();
+    return;
+  } 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']);
+      }
+    });
+  }
+};

package/src/connect.ts

@@ -0,0 +1,62 @@
+
+import connect from 'connect';
+import chalk from 'chalk';
+import { fairysMockerBase } from './base.js';
+import { detect } from 'detect-port';
+
+export class FairysMockerConnect {
+  base = fairysMockerBase;
+  /**创建 app*/
+  createApp = (cb?: () => void) => {
+    return fairysMockerBase.initApp(connect(), cb)
+  }
+
+  // 使用 connect
+  /**检测端口，返回实际端口*/
+  detectPort = (port?: number) => {
+    /**启动服务器*/
+    const PORT = port || process.env.PORT || 6901;
+    return new Promise((resolve, reject) => {
+      detect(PORT)
+        .then(realPort => {
+          resolve(realPort);
+        })
+        .catch(err => {
+          reject(err);
+        });
+    })
+  }
+
+  /**启动服务器*/
+  listen = async (port?: number, callback?: (error?: Error) => void) => {
+    if (!fairysMockerBase.mainApp) {
+      console.log(chalk.red('请先初始化 app'));
+      return;
+    }
+    const app = fairysMockerBase.mainApp
+    const realPort = await this.detectPort(port);
+    // @ts-ignore
+    fairysMockerBase.server = app.listen(realPort, (...rest: any) => {
+      fairysMockerBase.logServer(realPort as number);
+      callback?.(...rest);
+    });
+    return fairysMockerBase.server
+  }
+
+  staticServer = fairysMockerBase.staticServer;
+
+  /**启动 app*/
+  start = (cb?: () => void) => {
+    this.createApp(cb);
+    this.listen();
+  }
+
+  close = () => {
+    if (fairysMockerBase.server) {
+      fairysMockerBase.server.close();
+    }
+  }
+}
+
+export const fairysMockerConnect = new FairysMockerConnect();
+

package/src/controller/base.ts

@@ -0,0 +1,4 @@
+
+
+export class BaseController {
+}

package/src/controller/index.ts

@@ -0,0 +1,3 @@
+export * from "./base.js"
+export * from "./mock.router.js"
+export * from "./proxy.router.js"

package/src/controller/mock.router.ts

@@ -0,0 +1,175 @@
+import express from 'express';
+import fs from 'node:fs';
+import { Get, Post, Controller } from "../utils/decorator.js"
+import { utils } from "../utils/index.js"
+import { MockRouter } from "../router/mock.js"
+import { BaseController } from "./base.js"
+import { getMcokFile, createMockFile } from '../utils/mcok.proxy.js';
+import chalk from 'chalk';
+
+/**路由*/
+@Controller('/_fairys')
+export class MockRouterController extends BaseController {
+  /**mock 路由器实例*/
+  router: MockRouter | null = null;
+  constructor() {
+    super();
+    this.router = new MockRouter();
+  }
+
+  /**保存 Mock 配置*/
+  @Post('/_mock')
+  post_mock(req: express.Request, res: express.Response) {
+    // 定义接口
+    try {
+      const { mockList, dir, fileName = 'index.mock', rootDir } = req.body;
+      let _rootDir = rootDir || utils.rootDir;
+      if (rootDir && !fs.existsSync(rootDir)) {
+        _rootDir = utils.rootDir;
+      }
+      const mockData = createMockFile(mockList, _rootDir, dir, fileName)
+      if (mockData?.mockConfig) {
+        if (this.router?.isEnabled) {
+          this.router?.load(mockData.mockConfig);
+        }
+        res.json({
+          code: 200,
+          message: 'Mock 配置保存成功',
+          data: mockData.mockConfig,
+          mockList: mockList,
+          rootDir: mockData.rootDir,
+          dir: mockData.dir,
+          cache: mockData.cache,
+          fileName: mockData.fileName,
+        });
+      }
+
+    } catch (error: any) {
+      res.status(500).json({
+        code: 500,
+        message: '保存 Mock 配置失败',
+        error: error.message
+      });
+    }
+  }
+
+  /**读取 Mock 配置*/
+  @Get('/_mock')
+  get_mock(req: express.Request, res: express.Response) {
+    try {
+      const savePath = (req.query?.dir as string)?.trim()
+      const saveFileName = (req.query?.fileName as string)?.trim()
+      const rootDir = (req.query?.rootDir as string)?.trim()
+      const mockData = getMcokFile(rootDir, savePath, saveFileName);
+      if (mockData?.mockList) {
+        res.json({
+          code: 200,
+          message: '读取 Mock 配置成功',
+          data: mockData.mockList,
+          rootDir: mockData.rootDir,
+          dir: mockData.dir,
+          cache: mockData.cache,
+          fileName: mockData.fileName,
+        });
+      } else {
+        res.json({
+          code: 404,
+          message: 'Mock 配置文件不存在',
+        });
+      }
+    } catch (error: any) {
+      res.status(500).json({
+        code: 500,
+        message: '读取 Mock 配置失败',
+        error: error.message
+      });
+    }
+  }
+
+  /**检查 Mock 配置服务是否启用*/
+  @Get('/_mock/_is_enabled')
+  get_mock_enabled(req: express.Request, res: express.Response) {
+    res.json({
+      code: 200,
+      message: 'Mock 配置服务是否启用',
+      data: this.router?.isEnabled,
+    });
+  }
+
+  /**启动 Mock 配置服务*/
+  @Get('/_mock/_start')
+  get_mock_start(req: express.Request, res: express.Response) {
+    try {
+      const mockData = getMcokFile(req.query.rootDir as string, req.query.dir as string, req.query.fileName as string);
+      if (mockData?.mockList) {
+        this.router?.load(mockData.mockList);
+        res.json({
+          code: 200,
+          message: '启动 Mock 配置服务成功',
+          data: mockData.mockList,
+          rootDir: mockData.rootDir,
+          dir: mockData.dir,
+          cache: mockData.cache,
+          fileName: mockData.fileName,
+          isEnabled: true,
+        });
+      } else {
+        res.json({
+          code: 404,
+          message: 'Mock 配置文件不存在',
+        });
+      }
+    } catch (error: any) {
+      res.status(500).json({
+        code: 500,
+        message: '启动 Mock 配置失败',
+        error: error.message
+      });
+    }
+  }
+
+  /**销毁 Mock 配置服务*/
+  @Get('/_mock/_destroy')
+  get_mock_destroy(req: express.Request, res: express.Response) {
+    try {
+      if (this.router?.router) {
+        this.router?.destroy("销毁mock路由器实例");
+      } else {
+        res.json({
+          code: 404,
+          message: 'Mock 配置服务不存在',
+        });
+      }
+      res.json({
+        code: 200,
+        message: '销毁 Mock 配置服务成功',
+      });
+    } catch (error: any) {
+      res.status(500).json({
+        code: 500,
+        message: '销毁 Mock 配置服务',
+        error: error.message
+      });
+    }
+  }
+
+  /**启动 Mock 配置服务*/
+  start = (rootDir?: string, dir?: string, fileName?: string) => {
+    try {
+      const mockData = getMcokFile(rootDir, dir, fileName);
+      if (mockData?.mockList) {
+        try {
+          this.router?.load(mockData.mockList);
+          console.log(chalk.green(`  启动 Mock 配置服务成功，配置文件：${mockData.rootDir}/${mockData.dir}/${mockData.fileName}.ts`))
+          console.log('')
+        } catch (error) {
+          console.log(chalk.red(`  启动 Mock 配置服务失败，配置文件：${mockData.rootDir}/${mockData.dir}/${mockData.fileName}.ts`))
+          console.log('')
+        }
+      }
+    } catch (error) {
+      console.log(chalk.red(`  启动 Mock 配置服务失败`))
+      console.log('')
+    }
+  }
+}

package/src/controller/proxy.router.ts

@@ -0,0 +1,182 @@
+import express from 'express';
+import fs from 'node:fs';
+import nodePath from "node:path"
+import { createProxyData } from '@fairys/create-mock-data';
+import { Get, Post, Controller } from "../utils/decorator.js"
+import { utils } from "../utils/index.js"
+import { ProxyRouter } from '../router/proxy.js';
+import { BaseController } from './base.js';
+import { getProxyFile, createProxyFile } from '../utils/mcok.proxy.js';
+import chalk from 'chalk';
+
+/**路由*/
+@Controller('/_fairys')
+export class ProxyRouterController extends BaseController {
+  /**代理 路由器实例*/
+  router: ProxyRouter | null = null;
+
+  constructor() {
+    super();
+    this.router = new ProxyRouter();
+  }
+
+  @Post('/_proxy')
+  post_proxy(req: express.Request, res: express.Response) {
+    try {
+      const { proxyList, dir, fileName = 'proxy', rootDir } = req.body;
+      let _rootDir = rootDir || utils.rootDir;
+      if (rootDir && !fs.existsSync(rootDir)) {
+        _rootDir = utils.rootDir;
+      }
+      const proxyData = createProxyFile(proxyList, _rootDir, dir, fileName)
+      if (proxyData?.proxyConfig) {
+        if (this.router?.isEnabled) {
+          this.router?.load(proxyList);
+        }
+        res.json({
+          code: 200,
+          message: '代理配置保存成功',
+          data: proxyData.proxyConfig,
+          proxyList: proxyList,
+          rootDir: proxyData.rootDir,
+          dir: proxyData.dir,
+          cache: proxyData.cache,
+          fileName: proxyData.fileName,
+        });
+      } else {
+        res.json({
+          code: 404,
+          message: '生成配置文件错误',
+        });
+      }
+    } catch (error: any) {
+      res.status(500).json({
+        code: 500,
+        message: '保存代理配置失败',
+        error: error.message
+      });
+    }
+  }
+
+  @Get('/_proxy')
+  get_proxy(req: express.Request, res: express.Response) {
+    try {
+      const savePath = (req.query.dir as string)?.trim()
+      const saveFileName = (req.query.fileName as string)?.trim()
+      const rootDir = (req.query.rootDir as string)?.trim()
+      const proxyData = getProxyFile(rootDir, savePath, saveFileName);
+      if (proxyData?.proxyList) {
+        res.json({
+          code: 200,
+          message: '读取代理配置成功',
+          data: proxyData.proxyList,
+          rootDir: proxyData.rootDir,
+          dir: proxyData.dir,
+          cache: proxyData.cache,
+          fileName: proxyData.fileName,
+        });
+      } else {
+        res.json({
+          code: 404,
+          message: '代理配置文件不存在',
+        });
+      }
+    } catch (error: any) {
+      res.status(500).json({
+        code: 500,
+        message: '读取代理配置失败',
+        error: error.message
+      });
+    }
+  }
+
+  /**检查代理服务是否启用*/
+  @Get('/_proxy/_is_enabled')
+  get_proxy_enabled(req: express.Request, res: express.Response) {
+    res.json({
+      code: 200,
+      message: '代理服务是否启用',
+      data: this.router?.isEnabled,
+    });
+  }
+
+  /**启动代理服务*/
+  @Get('/_proxy/_start')
+  get_proxy_start(req: express.Request, res: express.Response) {
+    try {
+      const savePath = (req.query.dir as string)?.trim()
+      const saveFileName = (req.query.fileName as string)?.trim();
+      const rootDir = (req.query.rootDir as string)?.trim()
+      const proxyData = getProxyFile(rootDir, savePath, saveFileName);
+      if (proxyData?.proxyList) {
+        this.router?.load(proxyData.proxyList);
+        res.json({
+          code: 200,
+          message: '启动代理服务成功',
+          data: proxyData.proxyList,
+          rootDir: rootDir,
+          dir: proxyData.dir,
+          cache: proxyData.cache,
+          fileName: proxyData.fileName,
+          isEnabled: true,
+        });
+      } else {
+        res.json({
+          code: 404,
+          message: '代理配置文件不存在',
+        });
+      }
+    } catch (error: any) {
+      res.status(500).json({
+        code: 500,
+        message: '启动代理配置失败',
+        error: error.message
+      });
+    }
+  }
+
+  /**销毁代理服务*/
+  @Get('/_proxy/_destroy')
+  get_proxy_destroy(req: express.Request, res: express.Response) {
+    try {
+      if (this.router?.router) {
+        this.router?.destroy("销毁proxy路由器实例");
+      } else {
+        res.json({
+          code: 404,
+          message: '代理服务不存在',
+        });
+      }
+      res.json({
+        code: 200,
+        message: '销毁代理服务成功',
+      });
+    } catch (error: any) {
+      res.status(500).json({
+        code: 500,
+        message: '销毁代理服务失败',
+        error: error.message
+      });
+    }
+  }
+
+  start = (rootDir?: string, dir?: string, fileName?: string) => {
+    try {
+      const proxyData = getProxyFile(rootDir, dir, fileName);
+      if (proxyData?.proxyList) {
+        try {
+          this.router?.load(proxyData.proxyList);
+          console.log(chalk.green(`  启动代理服务成功，配置文件：${proxyData.rootDir}/${proxyData.dir}/${proxyData.fileName}.ts`))
+          console.log('')
+        } catch (error) {
+          console.log(chalk.red(`  启动代理服务失败，配置文件：${proxyData.rootDir}/${proxyData.dir}/${proxyData.fileName}.ts`))
+          console.log('')
+        }
+      }
+    } catch (error) {
+      console.log(chalk.red(`  启动代理服务失败`))
+      console.log('')
+    }
+  }
+
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from "./base.js"
+export * from "./main.js"
+export * from "./connect.js"
+export * from "./ci.js"
+export * from "./plugins/rsbuild.js"

package/src/main.ts

@@ -0,0 +1,59 @@
+
+import express from 'express';
+import chalk from 'chalk';
+import { fairysMockerBase } from './base.js';
+import { detect } from 'detect-port';
+
+export class FairysMockerExpress {
+  base = fairysMockerBase;
+  /**创建 app*/
+  createApp = (cb?: () => void) => {
+    return fairysMockerBase.initApp(express(), cb)
+  }
+  // 使用express
+  /**检测端口，返回实际端口*/
+  detectPort = (port?: number) => {
+    /**启动服务器*/
+    const PORT = port || process.env.PORT || 6901;
+    return new Promise((resolve, reject) => {
+      detect(PORT)
+        .then(realPort => {
+          resolve(realPort);
+        })
+        .catch(err => {
+          reject(err);
+        });
+    })
+  }
+
+  /**启动服务器*/
+  listen = async (port?: number, callback?: (error?: Error) => void) => {
+    if (!fairysMockerBase.app) {
+      console.log(chalk.red('请先初始化 app'));
+      return;
+    }
+    const app = fairysMockerBase.mainApp
+    const realPort = await this.detectPort(port);
+    // @ts-ignore
+    fairysMockerBase.server = app.listen(realPort, (...rest) => {
+      fairysMockerBase.logServer(realPort as number);
+      callback?.(...rest);
+    });
+    return fairysMockerBase.server
+  }
+  staticServer = fairysMockerBase.staticServer;
+  /**启动 app*/
+  start = (cb?: () => void) => {
+    this.createApp(cb);
+    this.listen();
+  }
+
+  close = () => {
+    if (fairysMockerBase.server) {
+      fairysMockerBase.server.close();
+    }
+  }
+}
+
+export const fairysMockerExpress = new FairysMockerExpress();
+

package/src/plugins/rsbuild.ts

@@ -0,0 +1,14 @@
+import type { RsbuildPlugin } from '@rsbuild/core';
+import { fairysMockerBase } from '../base.js';
+
+export const fairysMockerRsbuildPlugin = () => ({
+  setup(api) {
+    api.onBeforeStartDevServer(({ server }) => {
+      fairysMockerBase.initApp(server.middlewares, () => {
+        fairysMockerBase.logServer(server.port);
+      });
+      // @ts-ignore
+      fairysMockerBase.server = server.httpServer
+    });
+  },
+} as RsbuildPlugin);