feat: params lowercase

couriourc · Sep 8, 2024 · 5a51a9e · 5a51a9e
1 parent c8fe1f6
commit 5a51a9e
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 75 deletions.
diff --git a/example/.simple-mock.yaml b/example/.simple-mock.yaml
@@ -1,10 +1,16 @@
-ROOT_DIR: .
-API_DIR: apis
-STATIC_DIR: ./static
-STATIC_ROUTE_PREFIX: static
-PORT: 3000
-SILENT:
-ERROR_LOG_FILE_PATH: ./error.log
-LOG_SIZE: 10M
-DEBUG_LOG_FILE_PATH: ./debug.log
-WATCH:
+root_dir: .
+api_dir: apis
+static_dir: ./static
+static_route_prefix: static
+port: 3000
+silent:
+error_log_file_path: ./error.log
+log_size: 10M
+debug_log_file_path: ./debug.log
+watch:
+plugins:
+  peer-stream:
+    enabled: true
+    options:
+      peerId: 'peer-stream-id'
+      secretKey: 'peer-stream-secret-key'
diff --git a/example/plugins/peer-stream/index.js b/example/plugins/peer-stream/index.js
@@ -1,7 +1,7 @@
-export default function({app, logger}) {
+export default function({app, logger, option}) {
   app.ws('/ws', {
     message(ws, message) {
-      logger.info(message);
+      logger.info(option);
     },
   });
 }
diff --git a/index.ts b/index.ts
@@ -40,7 +40,7 @@ program.option('-d, --debug', 'output extra debugging')
 const command = program.parse(process.argv);
 // E 配置启动命令信息
 const parsedConfig = yaml.parse<IConfigParameter>(await safeRun(() => {
-        const configFilePath = cwd(command.getOptionValue('cwd') ?? DEFAULT_CONFIG.ROOT_DIR, command.getOptionValue('config') ?? "./.simple-mock.yaml");
+        const configFilePath = cwd(command.getOptionValue('cwd') ?? DEFAULT_CONFIG.root_dir, command.getOptionValue('config') ?? "./.simple-mock.yaml");
         if (!fs.existsSync(configFilePath)) {
             return '';
         }
@@ -58,59 +58,62 @@ const choice = (cmd: any, parsed: any, defaultConfig: any) => {
         parsed;
 };
 const config = mergeDeep(DEFAULT_CONFIG, {
-    PORT: choice(command.getOptionValue('port'), parsedConfig?.PORT, DEFAULT_CONFIG.PORT),
-    SILENT: choice(command.getOptionValue("silent"), parsedConfig?.SILENT, DEFAULT_CONFIG.SILENT),
-    ERROR_LOG_FILE_PATH: choice(command.getOptionValue("error_log"), parsedConfig?.ERROR_LOG_FILE_PATH, DEFAULT_CONFIG.ERROR_LOG_FILE_PATH),
-    DEBUG_LOG_FILE_PATH: choice(command.getOptionValue("debug_log"), parsedConfig?.DEBUG_LOG_FILE_PATH, DEFAULT_CONFIG.DEBUG_LOG_FILE_PATH),
-    WATCH: choice(command.getOptionValue("watch"), parsedConfig?.WATCH, DEFAULT_CONFIG.WATCH),
-    STATIC_DIR: choice(command.getOptionValue("static-dir"), parsedConfig?.STATIC_DIR, DEFAULT_CONFIG.STATIC_DIR),
-    STATIC_ROUTE_PREFIX: choice(command.getOptionValue("static-route-prefix"), parsedConfig?.STATIC_ROUTE_PREFIX, DEFAULT_CONFIG.STATIC_ROUTE_PREFIX)
+    port: choice(command.getOptionValue('port'), parsedConfig?.port, DEFAULT_CONFIG.port),
+    silent: choice(command.getOptionValue("silent"), parsedConfig?.silent, DEFAULT_CONFIG.silent),
+    error_log_file_path: choice(command.getOptionValue("error_log"), parsedConfig?.error_log_file_path, DEFAULT_CONFIG.error_log_file_path),
+    debug_log_file_path: choice(command.getOptionValue("debug_log"), parsedConfig?.debug_log_file_path, DEFAULT_CONFIG.debug_log_file_path),
+    watch: choice(command.getOptionValue("watch"), parsedConfig?.watch, DEFAULT_CONFIG.watch),
+    static_dir: choice(command.getOptionValue("static-dir"), parsedConfig?.static_dir, DEFAULT_CONFIG.static_dir),
+    static_route_prefix: choice(command.getOptionValue("static-route-prefix"), parsedConfig?.static_route_prefix, DEFAULT_CONFIG.static_route_prefix)
 } as Partial<IConfigParameter>);
-const resolve = (p?: string) => path.resolve(cwd(config.ROOT_DIR), p ?? '');
+const resolve = (p?: string) => path.resolve(cwd(config.root_dir), p ?? '');
 
 // E 相关配置
 
 {
     // 创建默认配置文件夹
-    if (!fs.existsSync(resolve(config.STATIC_DIR))) {
-        fs.mkdirSync(resolve(config.STATIC_DIR));
+    if (!fs.existsSync(resolve(config.static_dir))) {
+        fs.mkdirSync(resolve(config.static_dir));
     }
-    if (!fs.existsSync(resolve(config.API_DIR))) {
-        fs.mkdirSync(resolve(config.API_DIR));
+    if (!fs.existsSync(resolve(config.api_dir))) {
+        fs.mkdirSync(resolve(config.api_dir));
     }
 }
 
 // S 打印日志配置
 const plugins: ({
     name: string;
     execute: Function;
+    option: any
 }) [] = [];
 const logger = new Logger({
-    sponsor: !config.SILENT,
-    info: !config.SILENT,
-    debug: !config.SILENT,
+    sponsor: !config.silent,
+    info: !config.silent,
+    debug: !config.silent,
     rotate: {
-        size: config.LOG_SIZE,
+        size: config.log_size,
         encoding: "utf8",
     },
 });
 
-
 {
     // 加载插件
     const glob = new Glob("*/package.json");
-    const resolvedPluginPath = resolve(config.PLUGIN_DIR);
+    const resolvedPluginPath = resolve(config.plugin_dir);
     if (fs.existsSync(resolvedPluginPath)) {
         for await (const file of glob.scan(resolvedPluginPath)) {
             const plugin = await import(path.join(resolvedPluginPath, file));
             if (!plugin.main) {
                 logger.error("Manifest need main field!");
             }
             const main = await import( path.resolve(path.dirname(path.resolve(resolvedPluginPath, file)), plugin.main));
+            const enabled = parsedConfig.plugins?.[plugin.name]?.enabled ?? true;
+            if (!enabled) continue;
             if (typeof main.default === "function") {
                 plugins.push({
-                    name: plugin.name ?? file,
+                    name: plugin.name,
                     execute: main.default,
+                    option: parsedConfig.plugins?.[plugin.name] ?? {}
                 });
             }
         }
@@ -149,7 +152,7 @@ const routeTable = new Table({
     },
 });
 let apiLength = 0;
-for await (const file of glob.scan(resolve(config.API_DIR))) {
+for await (const file of glob.scan(resolve(config.api_dir))) {
     let [_, url, method] = [undefined, '', 'get'];
     const group = path.normalize(path.parse(path.normalize(file)).dir).replaceAll(path.sep, '/');
     app.group(group.replaceAll(".", ""), (app) => {
@@ -161,7 +164,7 @@ for await (const file of glob.scan(resolve(config.API_DIR))) {
         }
         const finalUrl = urlRewrite(url, method,);
         app[method]?.(finalUrl, async (req) => {
-            let res = Bun.file(resolve(path.join(config.API_DIR, file)));
+            let res = Bun.file(resolve(path.join(config.api_dir, file)));
             logger.debug(JSON.stringify(pick(req, ['cookie', 'user-agent', 'headers', 'body', 'route', 'query', 'content-type'])));
             switch (path.extname(file)) {
                 case ".json":
@@ -174,24 +177,24 @@ for await (const file of glob.scan(resolve(config.API_DIR))) {
             index: ++apiLength,
             url: path.normalize(path.join(group, finalUrl || '/')).replaceAll(path.sep, '/'),
             method,
-            file: path.normalize(path.relative(resolve(), resolve(path.join(config.API_DIR, file))))
+            file: path.normalize(path.relative(resolve(), resolve(path.join(config.api_dir, file))))
         }, {
             color: method
         });
         return app;
     });
 }
 //    logger.info(process.argv.shift())
-config.WATCH && fs.watch(path.resolve(config.API_DIR,), async (event, filename) => {
-    logger.warning(`${config.API_DIR} has already changed,I Will Restart,Please wait a moment!!`);
+config.watch && fs.watch(path.resolve(config.api_dir), async (event, filename) => {
+    logger.warning(`${config.api_dir} has already changed,I Will Restart,Please wait a moment!!`);
     restart();
 });
 // 静态资源信息处理
 await safeRun(() => {
     // @ts-ignore
     return app.use(staticPlugin({
-        prefix: `${config.STATIC_ROUTE_PREFIX}`, // prefix
-        assets: resolve(config.STATIC_DIR),
+        prefix: `${config.static_route_prefix}`, // prefix
+        assets: resolve(config.static_dir),
         indexHTML: true,
         noCache: true,
         alwaysStatic: false // 文件动态获取信息
@@ -201,35 +204,35 @@ await safeRun(() => {
 {
     plugins.map((plugin) => {
         try {
-            plugin.execute({app, logger, config});
+            plugin.execute({app, logger, config, option: plugin.option});
         } catch (err) {
+            /*@ts-ignore*/
             logger.error(`Load plugin ${chalk.redBright.bold(plugin.name)} error: ${err.message}`);
         }
     });
     logger.debug(`Loaded ${plugins.length} Plugin`);
 }
 // 监听
-app
-    .use(midLogger({
-        logIP: false,
-        writer: {
-            write(msg: string) {
-                logger.debug(msg);
-            }
+app.use(midLogger({
+    logIP: false,
+    writer: {
+        write(msg: string) {
+            logger.debug(msg);
         }
-    }))
-    .listen(~~config.PORT);
+    }
+}))
+    .listen(~~config.port);
 // 欢迎信息
 // @ts-ignore
 logger.info(`
 > Hi,I'm SimpleMockServer, 
 · Now dir configuration: 
 | Root: ${chalk.white.bold(resolve(""))}  
-| API_DIR: ${chalk.white.bold(resolve(config.API_DIR))}
-| STATIC_DIR: ${chalk.white.bold(resolve(config.STATIC_DIR))}
+| api_dir: ${chalk.white.bold(resolve(config.api_dir))}
+| static_dir: ${chalk.white.bold(resolve(config.static_dir))}
 · Now Server: 
-| ServerApi: running on http://localhost:${config.PORT}
-| StaticFile: running on http://localhost:${config.PORT}/${config.STATIC_ROUTE_PREFIX}
+| ServerApi: running on http://localhost:${config.port}
+| StaticFile: running on http://localhost:${config.port}/${config.static_route_prefix}
 · Tips: 
 | Restart: Press key ${chalk.redBright.bold('R')}
 | Exit: Press key ${chalk.redBright.bold('Q')}

diff --git a/src/constants/index.ts b/src/constants/index.ts
@@ -4,16 +4,16 @@ import * as process from "process";
 export {default as COLOR_MAPS} from "./colors.ts";
 
 export const DEFAULT_CONFIG: IConfigParameter = {
-    ROOT_DIR: process.env.NODE_ENV === "development" ? "example" : ".",
-    API_DIR: 'apis',
-    STATIC_DIR: './static/',
-    STATIC_ROUTE_PREFIX: 'static',
-    PORT: "3000",
-    SILENT: false,
-    ERROR_LOG_FILE_PATH: "./error.log",
-    LOG_SIZE: "10M",
-    DEBUG_LOG_FILE_PATH: "./debug.log",
-    WATCH: false,
-    PLUGIN_DIR: "./plugins",
+    root_dir: process.env.NODE_ENV === "development" ? "example" : ".",
+    api_dir: 'apis',
+    static_dir: './static/',
+    static_route_prefix: 'static',
+    port: "3000",
+    silent: false,
+    error_log_file_path: "./error.log",
+    log_size: "10M",
+    debug_log_file_path: "./debug.log",
+    watch: false,
+    plugin_dir: "./plugins",
 };
 
diff --git a/src/types/index.ts b/src/types/index.ts
@@ -1,13 +1,13 @@
 export interface IConfigParameter {
-    LOG_SIZE: "10B" | "10K" | "10M" | "10G";
-    PORT: string;
-    SILENT: boolean;
-    ERROR_LOG_FILE_PATH: string;
-    DEBUG_LOG_FILE_PATH: string;
-    WATCH: boolean;
-    ROOT_DIR: string;
-    API_DIR: string;
-    STATIC_DIR: string;
-    STATIC_ROUTE_PREFIX: string;
-    PLUGIN_DIR: string;
+    log_size: "10B" | "10K" | "10M" | "10G";
+    port: string;
+    silent: boolean;
+    error_log_file_path: string;
+    debug_log_file_path: string;
+    watch: boolean;
+    root_dir: string;
+    api_dir: string;
+    static_dir: string;
+    static_route_prefix: string;
+    plugin_dir: string;
 }