@fairys/mocker-cli 0.0.1

package/README.md

@@ -0,0 +1,36 @@
+# mocker-cli
+
+用于界面配置生成mock数据和mock服务
+
+[ ] 直接当 mock 服务
+[ ] 生成 mock 数据
+[ ] 服务 + 数据
+
+## 安装
+
+```bash
+npm install @fairys/mocker-cli -D # pnpm install @fairys/mocker-cli -D # yarn add @fairys/mocker-cli -D
+```
+
+## 参数
+
+```bash
+Usage:
+  $ fairys-mocker
+
+Options:
+  --root        设置根目录路径(默认取环境变量中的`FAIRYS_MOCKER_ROOT_DIR`)
+  --dir         设置目录名(默认取环境变量中的`FAIRYS_MOCKER_DIR`)
+  --file        设置文件名(默认取环境变量中的`FAIRYS_MOCKER_FILE`)
+  --file2       设置文件名2(默认取环境变量中的`FAIRYS_MOCKER_PROXY_FILE`)
+  --static      设置静态文件目录
+  --static-prefix 设置静态文件路径前缀
+```
+
+**参数说明**
+
+`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`文件
+

package/bin/fairys-mocker

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+import nodeModule from 'node:module';
+
+// enable on-disk code caching of all modules loaded by Node.js
+// requires Nodejs >= 22.8.0
+const { enableCompileCache } = nodeModule;
+if (enableCompileCache) {
+  try {
+    enableCompileCache();
+  } catch {
+    // ignore errors
+  }
+}
+async function main() {
+  const { runExpressCli } = await import('../esm/ci.js');
+  try {
+    runExpressCli();
+  } catch (err) {
+    console.error(err);
+  }
+}
+main();

package/esm/base.d.ts

@@ -0,0 +1,28 @@
+import express from 'express';
+import connect from 'connect';
+import { ClassStruct } from "./utils/decorator.js";
+import http from "node:http";
+export declare class FairysMockerBase {
+    /**服务*/
+    server: http.Server | undefined;
+    /**主路由*/
+    router: express.Router | undefined;
+    /**内置路由*/
+    fairysMockerRouter: express.Router | undefined;
+    /**子应用*/
+    app: express.Express | undefined;
+    /**主应用*/
+    mainApp: express.Express | connect.Server | undefined;
+    /**类*/
+    controller: ClassStruct[];
+    /**静态文件服务列表*/
+    staticServerList: string[];
+    /**静态文件服务*/
+    staticServer: (dir: string, prefix?: string, isRegister?: boolean) => void;
+    /**初始化 app 服务*/
+    initApp: (app: express.Express | connect.Server, cb?: () => void) => express.Express | connect.Server;
+    /**启动日志打印服务器地址*/
+    logServer: (port: number) => Promise<void>;
+    close: () => void;
+}
+export declare const fairysMockerBase: FairysMockerBase;

package/esm/base.js

@@ -0,0 +1,80 @@
+import express from "express";
+import node_fs from "node:fs";
+import cors from "cors";
+import node_path from "node:path";
+import { fileURLToPath } from "node:url";
+import { MockRouterController } from "./controller/mock.router.js";
+import { registerRoutes } from "./utils/decorator.js";
+import { ProxyRouterController } from "./controller/proxy.router.js";
+import chalk from "chalk";
+const base_filename = fileURLToPath(import.meta.url);
+const base_dirname = node_path.dirname(base_filename);
+class FairysMockerBase {
+    server = void 0;
+    router = void 0;
+    fairysMockerRouter = void 0;
+    app = void 0;
+    mainApp = void 0;
+    controller = [
+        MockRouterController,
+        ProxyRouterController
+    ];
+    staticServerList = [];
+    staticServer = (dir, prefix = '/', isRegister = true)=>{
+        if (!this.app) return;
+        if (node_fs.existsSync(dir)) {
+            const _prefix = /^\/$/.test(prefix) ? prefix : `/${prefix}`;
+            this.app.use(_prefix, express["static"](dir));
+            if (isRegister) this.staticServerList.push(_prefix);
+        } else console.log(chalk.red(`${dir} 目录不存在`));
+    };
+    initApp = (app, cb)=>{
+        if (this.app) {
+            console.log('挂载 主应用 服务');
+            this.mainApp = app;
+            this.mainApp.use(this.app);
+        } else {
+            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 = node_path.join(base_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);
+                const start = newController?.start;
+                if ('function' == typeof start) start();
+            }
+            this.app.use('/', this.router);
+            cb?.();
+            console.log('');
+        }
+        return app;
+    };
+    logServer = async (port)=>{
+        if (!this.app) return void console.log(chalk.red('请先初始化 app'));
+        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();
+    };
+}
+const fairysMockerBase = new FairysMockerBase();
+export { FairysMockerBase, fairysMockerBase };

package/esm/ci.d.ts

@@ -0,0 +1,2 @@
+export declare const runExpressCli: () => void;
+export declare const runConnectCli: () => void;

package/esm/ci.js

@@ -0,0 +1,49 @@
+import yargs_parser 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 = yargs_parser(process.argv.slice(2), {
+    string: [
+        "root",
+        'dir',
+        'file',
+        'file2',
+        'static',
+        'static-prefix'
+    ]
+});
+const runExpressCli = ()=>{
+    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']);
+    });
+};
+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']);
+    });
+};
+export { runConnectCli, runExpressCli };

package/esm/connect.d.ts

@@ -0,0 +1,15 @@
+import connect from 'connect';
+export declare class FairysMockerConnect {
+    base: import("./base.js").FairysMockerBase;
+    /**创建 app*/
+    createApp: (cb?: () => void) => import("express").Express | connect.Server;
+    /**检测端口，返回实际端口*/
+    detectPort: (port?: number) => Promise<unknown>;
+    /**启动服务器*/
+    listen: (port?: number, callback?: (error?: Error) => void) => Promise<import("node:http").Server<typeof import("node:http").IncomingMessage, typeof import("node:http").ServerResponse> | undefined>;
+    staticServer: (dir: string, prefix?: string, isRegister?: boolean) => void;
+    /**启动 app*/
+    start: (cb?: () => void) => void;
+    close: () => void;
+}
+export declare const fairysMockerConnect: FairysMockerConnect;

package/esm/connect.js

@@ -0,0 +1,38 @@
+import connect from "connect";
+import chalk from "chalk";
+import { fairysMockerBase } from "./base.js";
+import { detect } from "detect-port";
+class FairysMockerConnect {
+    base = fairysMockerBase;
+    createApp = (cb)=>fairysMockerBase.initApp(connect(), cb);
+    detectPort = (port)=>{
+        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, callback)=>{
+        if (!fairysMockerBase.mainApp) return void console.log(chalk.red('请先初始化 app'));
+        const app = fairysMockerBase.mainApp;
+        const realPort = await this.detectPort(port);
+        fairysMockerBase.server = app.listen(realPort, (...rest)=>{
+            fairysMockerBase.logServer(realPort);
+            callback?.(...rest);
+        });
+        return fairysMockerBase.server;
+    };
+    staticServer = fairysMockerBase.staticServer;
+    start = (cb)=>{
+        this.createApp(cb);
+        this.listen();
+    };
+    close = ()=>{
+        if (fairysMockerBase.server) fairysMockerBase.server.close();
+    };
+}
+const fairysMockerConnect = new FairysMockerConnect();
+export { FairysMockerConnect, fairysMockerConnect };

package/esm/controller/base.d.ts

@@ -0,0 +1,2 @@
+export declare class BaseController {
+}

package/esm/controller/base.js

@@ -0,0 +1,3 @@
+class BaseController {
+}
+export { BaseController };

package/esm/controller/index.d.ts

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

package/esm/controller/index.js

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

package/esm/controller/mock.router.d.ts

@@ -0,0 +1,21 @@
+import express from 'express';
+import { MockRouter } from "../router/mock.js";
+import { BaseController } from "./base.js";
+/**路由*/
+export declare class MockRouterController extends BaseController {
+    /**mock 路由器实例*/
+    router: MockRouter | null;
+    constructor();
+    /**保存 Mock 配置*/
+    post_mock(req: express.Request, res: express.Response): void;
+    /**读取 Mock 配置*/
+    get_mock(req: express.Request, res: express.Response): void;
+    /**检查 Mock 配置服务是否启用*/
+    get_mock_enabled(req: express.Request, res: express.Response): void;
+    /**启动 Mock 配置服务*/
+    get_mock_start(req: express.Request, res: express.Response): void;
+    /**销毁 Mock 配置服务*/
+    get_mock_destroy(req: express.Request, res: express.Response): void;
+    /**启动 Mock 配置服务*/
+    start: (rootDir?: string, dir?: string, fileName?: string) => void;
+}