@eggjs/tegg-config 3.29.0 → 3.30.0

package/app.js

@@ -1,18 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tegg_common_util_1 = require("@eggjs/tegg-common-util");
+const ModuleScanner_1 = require("./lib/ModuleScanner");
 class App {
     constructor(app) {
         this.app = app;
     }
     configWillLoad() {
         const { readModuleOptions } = this.app.config.tegg || {};
-        this.app.moduleReferences = tegg_common_util_1.ModuleConfigUtil.readModuleReference(this.app.baseDir, readModuleOptions || {});
+        const moduleScanner = new ModuleScanner_1.ModuleScanner(this.app.baseDir, readModuleOptions);
+        this.app.moduleReferences = moduleScanner.loadModuleReferences();
         this.app.moduleConfigs = {};
         for (const reference of this.app.moduleReferences) {
             const absoluteRef = {
                 path: tegg_common_util_1.ModuleConfigUtil.resolveModuleDir(reference.path, this.app.baseDir),
                 name: reference.name,
+                optional: reference.optional,
             };
             const moduleName = tegg_common_util_1.ModuleConfigUtil.readModuleNameSync(absoluteRef.path);
             this.app.moduleConfigs[moduleName] = {
@@ -24,4 +27,4 @@ class App {
     }
 }
 exports.default = App;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiYXBwLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EsOERBQTJEO0FBRTNELE1BQXFCLEdBQUc7SUFHdEIsWUFBWSxHQUFnQjtRQUMxQixJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQztJQUNqQixDQUFDO0lBRUQsY0FBYztRQUNaLE1BQU0sRUFBRSxpQkFBaUIsRUFBRSxHQUFHLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDekQsSUFBSSxDQUFDLEdBQUcsQ0FBQyxnQkFBZ0IsR0FBRyxtQ0FBZ0IsQ0FBQyxtQkFBbUIsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxpQkFBaUIsSUFBSSxFQUFFLENBQUMsQ0FBQztRQUM1RyxJQUFJLENBQUMsR0FBRyxDQUFDLGFBQWEsR0FBRyxFQUFFLENBQUM7UUFDNUIsS0FBSyxNQUFNLFNBQVMsSUFBSSxJQUFJLENBQUMsR0FBRyxDQUFDLGdCQUFnQixFQUFFLENBQUM7WUFDbEQsTUFBTSxXQUFXLEdBQUc7Z0JBQ2xCLElBQUksRUFBRSxtQ0FBZ0IsQ0FBQyxnQkFBZ0IsQ0FBQyxTQUFTLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDO2dCQUN6RSxJQUFJLEVBQUUsU0FBUyxDQUFDLElBQUk7YUFDckIsQ0FBQztZQUVGLE1BQU0sVUFBVSxHQUFHLG1DQUFnQixDQUFDLGtCQUFrQixDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUN6RSxJQUFJLENBQUMsR0FBRyxDQUFDLGFBQWEsQ0FBQyxVQUFVLENBQUMsR0FBRztnQkFDbkMsSUFBSSxFQUFFLFVBQVU7Z0JBQ2hCLFNBQVMsRUFBRSxXQUFXO2dCQUN0QixNQUFNLEVBQUUsbUNBQWdCLENBQUMsb0JBQW9CLENBQUMsV0FBVyxDQUFDLElBQUksRUFBRSxTQUFTLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRTthQUN0RyxDQUFDO1FBQ0osQ0FBQztJQUNILENBQUM7Q0FDRjtBQXpCRCxzQkF5QkMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiYXBwLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EsOERBQTRFO0FBQzVFLHVEQUFvRDtBQUVwRCxNQUFxQixHQUFHO0lBR3RCLFlBQVksR0FBZ0I7UUFDMUIsSUFBSSxDQUFDLEdBQUcsR0FBRyxHQUFHLENBQUM7SUFDakIsQ0FBQztJQUVELGNBQWM7UUFDWixNQUFNLEVBQUUsaUJBQWlCLEVBQUUsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ3pELE1BQU0sYUFBYSxHQUFHLElBQUksNkJBQWEsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxpQkFBaUIsQ0FBQyxDQUFDO1FBQzdFLElBQUksQ0FBQyxHQUFHLENBQUMsZ0JBQWdCLEdBQUcsYUFBYSxDQUFDLG9CQUFvQixFQUFFLENBQUM7UUFFakUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxhQUFhLEdBQUcsRUFBRSxDQUFDO1FBQzVCLEtBQUssTUFBTSxTQUFTLElBQUksSUFBSSxDQUFDLEdBQUcsQ0FBQyxnQkFBZ0IsRUFBRSxDQUFDO1lBQ2xELE1BQU0sV0FBVyxHQUFvQjtnQkFDbkMsSUFBSSxFQUFFLG1DQUFnQixDQUFDLGdCQUFnQixDQUFDLFNBQVMsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUM7Z0JBQ3pFLElBQUksRUFBRSxTQUFTLENBQUMsSUFBSTtnQkFDcEIsUUFBUSxFQUFFLFNBQVMsQ0FBQyxRQUFRO2FBQzdCLENBQUM7WUFFRixNQUFNLFVBQVUsR0FBRyxtQ0FBZ0IsQ0FBQyxrQkFBa0IsQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDekUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxhQUFhLENBQUMsVUFBVSxDQUFDLEdBQUc7Z0JBQ25DLElBQUksRUFBRSxVQUFVO2dCQUNoQixTQUFTLEVBQUUsV0FBVztnQkFDdEIsTUFBTSxFQUFFLG1DQUFnQixDQUFDLG9CQUFvQixDQUFDLFdBQVcsQ0FBQyxJQUFJLEVBQUUsU0FBUyxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUU7YUFDdEcsQ0FBQztRQUNKLENBQUM7SUFDSCxDQUFDO0NBQ0Y7QUE1QkQsc0JBNEJDIn0=

package/lib/ModuleScanner.d.ts

@@ -0,0 +1,11 @@
+import { ModuleReference, ReadModuleReferenceOptions } from '@eggjs/tegg-common-util';
+export declare class ModuleScanner {
+    private readonly baseDir;
+    private readonly readModuleOptions;
+    constructor(baseDir: string, readModuleOptions: ReadModuleReferenceOptions);
+    /**
+     * - load module references from config or scan from baseDir
+     * - load framework module as optional module reference
+     */
+    loadModuleReferences(): readonly ModuleReference[];
+}

package/lib/ModuleScanner.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModuleScanner = void 0;
+const tegg_common_util_1 = require("@eggjs/tegg-common-util");
+const path_1 = __importDefault(require("path"));
+class ModuleScanner {
+    constructor(baseDir, readModuleOptions) {
+        this.baseDir = baseDir;
+        this.readModuleOptions = readModuleOptions;
+    }
+    /**
+     * - load module references from config or scan from baseDir
+     * - load framework module as optional module reference
+     */
+    loadModuleReferences() {
+        var _a;
+        const moduleReferences = tegg_common_util_1.ModuleConfigUtil.readModuleReference(this.baseDir, this.readModuleOptions || {});
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const appPkg = require(path_1.default.join(this.baseDir, 'package.json'));
+        const framework = (_a = appPkg.egg) === null || _a === void 0 ? void 0 : _a.framework;
+        if (!framework) {
+            return moduleReferences;
+        }
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const frameworkPkg = require.resolve(`${framework}/package.json`, {
+            paths: [this.baseDir],
+        });
+        const frameworkDir = path_1.default.dirname(frameworkPkg);
+        const optionalModuleReferences = tegg_common_util_1.ModuleConfigUtil.readModuleReference(frameworkDir, this.readModuleOptions || {});
+        return [
+            ...moduleReferences,
+            ...optionalModuleReferences.map(t => {
+                return {
+                    ...t,
+                    optional: true,
+                };
+            }),
+        ];
+    }
+}
+exports.ModuleScanner = ModuleScanner;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiTW9kdWxlU2Nhbm5lci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIk1vZHVsZVNjYW5uZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsOERBQXdHO0FBQ3hHLGdEQUF3QjtBQUV4QixNQUFhLGFBQWE7SUFJeEIsWUFBWSxPQUFlLEVBQUUsaUJBQTZDO1FBQ3hFLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO1FBQ3ZCLElBQUksQ0FBQyxpQkFBaUIsR0FBRyxpQkFBaUIsQ0FBQztJQUM3QyxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsb0JBQW9COztRQUNsQixNQUFNLGdCQUFnQixHQUFHLG1DQUFnQixDQUFDLG1CQUFtQixDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsSUFBSSxDQUFDLGlCQUFpQixJQUFJLEVBQUUsQ0FBQyxDQUFDO1FBQzFHLDhEQUE4RDtRQUM5RCxNQUFNLE1BQU0sR0FBRyxPQUFPLENBQUMsY0FBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLGNBQWMsQ0FBQyxDQUFDLENBQUM7UUFDaEUsTUFBTSxTQUFTLEdBQUcsTUFBQSxNQUFNLENBQUMsR0FBRywwQ0FBRSxTQUFTLENBQUM7UUFDeEMsSUFBSSxDQUFDLFNBQVMsRUFBRSxDQUFDO1lBQ2YsT0FBTyxnQkFBZ0IsQ0FBQztRQUMxQixDQUFDO1FBQ0QsOERBQThEO1FBQzlELE1BQU0sWUFBWSxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsR0FBRyxTQUFTLGVBQWUsRUFBRTtZQUNoRSxLQUFLLEVBQUUsQ0FBRSxJQUFJLENBQUMsT0FBTyxDQUFFO1NBQ3hCLENBQUMsQ0FBQztRQUNILE1BQU0sWUFBWSxHQUFHLGNBQUksQ0FBQyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUM7UUFDaEQsTUFBTSx3QkFBd0IsR0FBRyxtQ0FBZ0IsQ0FBQyxtQkFBbUIsQ0FBQyxZQUFZLEVBQUUsSUFBSSxDQUFDLGlCQUFpQixJQUFJLEVBQUUsQ0FBQyxDQUFDO1FBQ2xILE9BQU87WUFDTCxHQUFHLGdCQUFnQjtZQUNuQixHQUFHLHdCQUF3QixDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsRUFBRTtnQkFDbEMsT0FBTztvQkFDTCxHQUFHLENBQUM7b0JBQ0osUUFBUSxFQUFFLElBQUk7aUJBQ2YsQ0FBQztZQUNKLENBQUMsQ0FBQztTQUNILENBQUM7SUFDSixDQUFDO0NBQ0Y7QUFyQ0Qsc0NBcUNDIn0=

package/package.json

@@ -3,7 +3,7 @@
   "eggPlugin": {
     "name": "teggConfig"
   },
-  "version": "3.29.0",
+  "version": "3.30.0",
   "description": "module config plugin for egg",
   "keywords": [
     "egg",
@@ -17,6 +17,8 @@
     "app.js",
     "app.d.ts",
     "typings/index.d.ts",
+    "lib/**/*.js",
+    "lib/**/*.d.ts",
     "agent.js",
     "agent.d.ts"
   ],
@@ -41,7 +43,7 @@
     "node": ">=14.0.0"
   },
   "dependencies": {
-    "@eggjs/tegg-common-util": "^3.29.0"
+    "@eggjs/tegg-common-util": "^3.30.0"
   },
   "devDependencies": {
     "@types/mocha": "^10.0.1",
@@ -55,5 +57,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "bc9d4257fa2d8c0596841593419ab59b304e87f1"
+  "gitHead": "7ac47ca5919b706c6e65a004bef9ad48a33ee106"
 }