modify: 改进自定义 loader 加载 & 编写配置说明

Author: Houfeng

src/Application/Application.ts

@@ -5,7 +5,7 @@ import { builtLoaders } from "./builtInLoaders";
 import { CONF_RESERVEDS, ENV_NAME } from "./constants";
 import { CONFIG_ENTITY_KEY, ConfigLoader } from "../ConfigLoader";
 import { Container } from "../IoCLoader";
-import { dirname, normalize } from "path";
+import { dirname, normalize, resolve } from "path";
 import { EventEmitter } from "events";
 import { existsSync } from "fs";
 import { IApplication } from "./IApplication";
@@ -103,14 +103,26 @@ export class Application extends EventEmitter implements IApplication {
  return builtLoaders;
  }
 
+ /**
+ * 字符串是不是一个路戏
+ * @param str 字符串
+ */
+ private isPath(str: string) {
+ if (!str) return false;
+ return str.startsWith("/") || str.startsWith(".") || /^[a-z]+\:/i.test(str);
+ }
+
  /**
  * 加载一个 loader
  * @param name loader 名称
  */
  protected importLoader(name: string): ILoaderConstructor {
+ name = String(name);
  const { root } = this.options;
- const path = normalize(`${root}/node_modules/${String(name)}`);
- const loader = require(path);
+ const loaderPath = this.isPath(name)
+ ? resolve(root, name)
+ : normalize(`${root}/node_modules/${name}`);
+ const loader = require(loaderPath);
  return loader.default || loader;
  }
 

src/_example/configs/config.dev.yml

@@ -1,3 +1,40 @@
-port: 8080
+# -----------------------------------------------------------------------------
+# 基础配置
+# 应用默认将自动选取一个可用端口，可在此指定监听端口
+# 此外，也可在 Application 实例化时，通过 options 指定端口
+# -----------------------------------------------------------------------------
 
-loaders:
+# prot: 8080
+
+
+# -----------------------------------------------------------------------------
+# 配置 Loader 第一步：
+# 在此声明要在当前应用启用的 loader，格式为 `<CONF_NAME>: <包括名路径>`
+# 如果有需要，也可在此禁用内建 loader，格式为 `<CONF_NAME>: false`
+# -----------------------------------------------------------------------------
+
+loaders:
+ # loader_conf_name: loader_package
+
+
+# -----------------------------------------------------------------------------
+# 配置 Loader 第二步：
+# 在此配置已经启用的 loader
+# 如有需要，内建 loaders 也可直接在此配置或禁用，格式为 `<CONF_NAME>: false` 
+# -----------------------------------------------------------------------------
+
+# loader_conf_name: 
+# option_a: ...
+# option_b: ...
+
+
+# -----------------------------------------------------------------------------
+# 自定义配置
+# 除了「基础配置」和「Loader 配置」，可在此添加自定义配置
+# 可在 controller/service/model 中，通过 `@config(<path>)` 注入配置内容
+# 另外，配置的整体内容，可通过全局应用实例获取（示例代码：`app.config`）
+# -----------------------------------------------------------------------------
+
+# custom_conf_name: 
+# option_a: ...
+# option_b: ...

src/_example/configs/config.prod.yml

@@ -1,7 +1,6 @@
 import { Application } from "../..";
 
-const application = new Application();
-application
+new Application()
  .launch()
  .then(({ port }) => console.info("Running:", `http://localhost:${port}`))
  .catch(err => console.error(err));