@x-9lab/xlab 1.0.4-alpha.1 → 1.0.6

package/@types/components/return-code/index.d.ts

@@ -1,44 +1,7 @@
 /**
  * 状态详细信息
  */
-declare const CODE_DETAIL: {
-    FAIL: {
-        errorcode: number;
-        msg: string;
-    };
-    SUCCESS: {
-        errorcode: number;
-        msg: string;
-    };
-    BUSY: {
-        errorcode: number;
-        msg: string;
-    };
-    WRONG_PARAMETER: {
-        errorcode: number;
-        msg: string;
-    };
-    NOT_FOUND: {
-        errorcode: number;
-        msg: string;
-    };
-    PERMISSION_DENIED: {
-        errorcode: number;
-        msg: string;
-    };
-    SERVER_BUSY: {
-        errorcode: number;
-        msg: string;
-    };
-    SERVER_TIMEOUT: {
-        errorcode: number;
-        msg: string;
-    };
-    UNCHECK_ERROR: {
-        errorcode: number;
-        msg: string;
-    };
-};
+declare const CODE_DETAIL: XLab.ICodeDetail;
 /**
  * 根据状态码获取错误定义信息
  * @param  code 状态码
@@ -72,88 +35,14 @@ export { getReturnCode };
  * 获取错误代码
  * @return 错误代码
  */
-declare function getCodeDetail(): {
-    FAIL: {
-        errorcode: number;
-        msg: string;
-    };
-    SUCCESS: {
-        errorcode: number;
-        msg: string;
-    };
-    BUSY: {
-        errorcode: number;
-        msg: string;
-    };
-    WRONG_PARAMETER: {
-        errorcode: number;
-        msg: string;
-    };
-    NOT_FOUND: {
-        errorcode: number;
-        msg: string;
-    };
-    PERMISSION_DENIED: {
-        errorcode: number;
-        msg: string;
-    };
-    SERVER_BUSY: {
-        errorcode: number;
-        msg: string;
-    };
-    SERVER_TIMEOUT: {
-        errorcode: number;
-        msg: string;
-    };
-    UNCHECK_ERROR: {
-        errorcode: number;
-        msg: string;
-    };
-};
+declare function getCodeDetail(): XLab.ICodeDetail;
 export { getCodeDetail };
 /**
  * 设置新的错误代码
  * @param data 新的错误代码数据
  */
-declare function set(data: XLab.ICodeDetail): void;
+declare function set(data: Record<string, XLab.ICodeItem>): void;
 export { set };
 /**错误类型对象 */
-declare const ErrorTypes: {
-    FAIL: {
-        errorcode: number;
-        msg: string;
-    };
-    SUCCESS: {
-        errorcode: number;
-        msg: string;
-    };
-    BUSY: {
-        errorcode: number;
-        msg: string;
-    };
-    WRONG_PARAMETER: {
-        errorcode: number;
-        msg: string;
-    };
-    NOT_FOUND: {
-        errorcode: number;
-        msg: string;
-    };
-    PERMISSION_DENIED: {
-        errorcode: number;
-        msg: string;
-    };
-    SERVER_BUSY: {
-        errorcode: number;
-        msg: string;
-    };
-    SERVER_TIMEOUT: {
-        errorcode: number;
-        msg: string;
-    };
-    UNCHECK_ERROR: {
-        errorcode: number;
-        msg: string;
-    };
-};
+declare const ErrorTypes: XLab.ICodeDetail;
 export { ErrorTypes };

package/@types/dot-file.d.ts

@@ -0,0 +1,3 @@
+/**处理根目录下可能存在的配置文件 */
+declare function processDotFile(env: string, logger: any): void;
+export { processDotFile };

package/@types/global.d.ts

@@ -47,6 +47,8 @@ declare global {
     * @param  conf 配置项
     */
     function setSysConfig(conf: XLab.IConfig): void;
+    /**全局注入挂在对象 */
+    var XLAB: Record<string, XLab.JsonValue>;
     namespace XLab {
         /**JSON 基本数据类型 */
         type JsonValue = boolean | string | number | null | undefined | JsonArray | JsonObject;
@@ -163,7 +165,30 @@ declare global {
             msg: string;
         }
         /**业务错误定义 */
-        type ICodeDetail = Record<string, ICodeItem>;
+        interface ICodeDetail {
+            /**
+            操作失败
+
+            作为任何未定义失败的默认返回
+             */
+            FAIL: ICodeItem;
+            /**操作成功 */
+            SUCCESS: ICodeItem;
+            /**业务繁忙 */
+            BUSY: ICodeItem;
+            /**参数错误 */
+            WRONG_PARAMETER: ICodeItem;
+            /**数据不存在 */
+            NOT_FOUND: ICodeItem;
+            /**没有权限 */
+            PERMISSION_DENIED: ICodeItem;
+            /**服务繁忙 */
+            SERVER_BUSY: ICodeItem;
+            /**服务超时 */
+            SERVER_TIMEOUT: ICodeItem;
+            /**未知错误 */
+            UNCHECK_ERROR: ICodeItem;
+        }
         /**模块配置 */
         interface XConfig {
             /**watch 模式配置 */

package/README.md

@@ -18,6 +18,11 @@ X-9lab 通用服务端
     模块会自动检测执行根目录中是否存在 `xlab.config.js` 文件。如存在该文件则会使用该文件为模块的启动配置文件。支持的配置项：
     1. `watch` 是否开启 watch 模式
     1. `business` 业务目录名称。注意当前只支持根目录下的文件夹
+- 配置文件 `.xlab`
+    该文件用于定义系统中的全局变量，模块会自动检测执行根目录中是否存在 `.xlab` 文件。该类型文件一般用于定义一些不方便在代码中声明的敏感数据，因此 `.xlab` 及附属的环境文件 **不应该** 被提交到仓库中。
+    - 使用 `<key>=<value>` 的方式定义数据
+    - 文件中的数据会被加载到 `global.XLAB` 对象中
+    - `.xlab` 为生产环境定义，`.xlab.development` 为开发环境定义，`.xlab.sandbox` 为沙箱环境定义
 - `watch` 模式
     `xlab` 支持自动重启业务，开发中使用该功能可以减少大量手动重启业务的操作。
     启用方式：

package/dist/bin/watch.js

@@ -1,5 +1,5 @@
 "use strict";
-const XConfig = require("../default-x-config");
+const XConfig = require("../default-x-config").default;
 const { date  } = require("@x-drive/utils");
 const crossSpawn = require("cross-spawn");
 const colors = require("colors/safe");

package/dist/dot-file.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "processDotFile", {
+    enumerable: true,
+    get: ()=>processDotFile
+});
+const _path = /*#__PURE__*/ _interopRequireDefault(require("path"));
+const _fs = /*#__PURE__*/ _interopRequireDefault(require("fs"));
+const _utils = require("@x-drive/utils");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+/**行分割正则 */ const LINE_SPLIT_REGEXP = /[\s]?=[\s]?/;
+/**处理根目录下可能存在的配置文件 */ function processDotFile(env, logger) {
+    env = env.toLowerCase();
+    if (env === "production") {
+        env = "";
+    } else {
+        env = `.${env}`;
+    }
+    const dotFile = _path.default.resolve(process.cwd(), `.xlab${env}`);
+    try {
+        const fileStr = _fs.default.readFileSync(dotFile, "utf8");
+        const lines = fileStr.split("\n");
+        for(let i = 0; i < lines.length; i++){
+            const line = lines[i];
+            const linePart = line.split(LINE_SPLIT_REGEXP);
+            if ((0, _utils.isArray)(linePart) && linePart.length === 2) {
+                global.XLAB[linePart[0]] = JSON.parse(linePart[1]);
+            }
+        }
+    } catch (e) {
+        if (e.code !== "ENOENT") {
+            logger.error(e);
+        }
+    }
+}

package/dist/global.js

@@ -66,3 +66,4 @@ global.getSysConfig = getSysConfig;
     (0, _config.update)(conf);
 }
 global.setSysConfig = setSysConfig;
+global.XLAB = {};

package/dist/server.js

@@ -17,6 +17,7 @@ require("./global");
 const _log = require("./components/log");
 const _cron = require("./components/cron");
 const _defaultXConfig = /*#__PURE__*/ _interopRequireDefault(require("./default-x-config"));
+const _dotFile = require("./dot-file");
 const _koaStatic = /*#__PURE__*/ _interopRequireDefault(require("koa-static"));
 const _koaRouter = /*#__PURE__*/ _interopRequireDefault(require("koa-router"));
 const _path = /*#__PURE__*/ _interopRequireDefault(require("path"));
@@ -72,6 +73,7 @@ function _interopRequireWildcard(obj, nodeInterop) {
     return newObj;
 }
 const logger = _log.globalLog.getLogger("system");
+(0, _dotFile.processDotFile)(_config.default.env, logger);
 // 只在 master 上输出的日志
 global.masterLog = _config.log;
 // 服务实例

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@x-9lab/xlab",
-    "version": "1.0.4-alpha.1",
+    "version": "1.0.6",
     "description": "9lab 服务端模块",
-    "versionDesc": "修改配置文件名称, 修改服务端主要业务目录",
+    "versionDesc": "支持根目录下的点配置文件",
     "scripts": {
         "dev": "swc src -D ./src/bin --config-file .swcrc -d dist -w",
         "compile": "swc src -D ./src/bin --config-file .swcrc -d dist",