@yumerijs/loader 3.1.1 → 3.1.3

package/dist/index.d.ts

@@ -3,6 +3,7 @@ interface Plugin {
     apply: (ctx: Context, config: Config) => Promise<void>;
     disable: (ctx: Context) => Promise<void>;
     depend: Array<string>;
+    optional?: Array<string>;
     provide: Array<string>;
     render?: string;
     config?: Schema<any>;
@@ -23,6 +24,7 @@ export declare class PluginLoader {
     plugins: {
         [name: string]: Plugin & {
             depend?: string[];
+            optional?: string[];
             provide?: string[];
         };
     };
@@ -51,7 +53,7 @@ export declare class PluginLoader {
     unregall(pluginName: string): void;
     loadConfig(configPath: string): Promise<void>;
     loadPlugins(): Promise<void>;
-    loadSinglePlugin(pluginName: string, triggerPendingCheck?: boolean, onlypending?: boolean): Promise<boolean>;
+    loadSinglePlugin(pluginName: string, triggerPendingCheck?: boolean, onlypending?: boolean, requireOptionalDependencies?: boolean): Promise<boolean>;
     private _loadPendingPlugins;
     unloadPlugin(pluginNameToUnload: string, ispending?: boolean): Promise<void>;
     private _unloadSinglePlugin;
@@ -61,6 +63,8 @@ export declare class PluginLoader {
     private isNpxInvocation;
     private detectPackageManager;
     private confirmPluginInstall;
+    private isPluginModuleResolvable;
+    private installMissingPluginModules;
     private installMissingPlugin;
     private importPluginModule;
     loadModule(pluginName: string): Promise<Plugin>;

package/dist/index.js

@@ -153,26 +153,22 @@ export class PluginLoader {
             this.logger.info('No enabled plugins found in configuration.');
             return;
         }
-        let loadedInLastPass = true;
-        while (loadedInLastPass) {
-            loadedInLastPass = false;
-            for (const pluginName of enabledPlugins) {
-                if (this.pluginStatus[pluginName] === "enabled" /* PluginStatus.ENABLED */) {
-                    continue;
-                }
-                const success = await this.loadSinglePlugin(pluginName, false);
-                if (success) {
-                    loadedInLastPass = true;
-                }
-            }
+        // Resolve and install every configured plugin before any plugin module is loaded.
+        await this.installMissingPluginModules(allEntries.filter(entry => entry.enabled));
+        // 第一阶段：将 optional 与 depend 一样处理，尽量让可选服务先完成加载并注入。
+        while (await this._loadPendingPlugins(true)) {
+            // Continue scanning until no plugin can satisfy all required and optional dependencies.
+        }
+        // 第二阶段：严格扫描无法推进后，忽略尚未提供的 optional；depend 仍必须满足。
+        while (await this._loadPendingPlugins(false)) {
+            // Continue scanning in relaxed mode until only genuinely missing dependencies remain.
         }
-        await this._loadPendingPlugins();
         const pendingPlugins = Object.keys(this.pluginStatus).filter(p => this.pluginStatus[p] === "pending" /* PluginStatus.PENDING */);
         if (pendingPlugins.length > 0) {
-            // this.logger.warn('Some plugins could not be loaded due to unresolved dependencies:', pendingPlugins);
+            this.logger.warn('Some plugins could not be loaded due to unresolved required dependencies:', pendingPlugins);
         }
     }
-    async loadSinglePlugin(pluginName, triggerPendingCheck = true, onlypending = false) {
+    async loadSinglePlugin(pluginName, triggerPendingCheck = true, onlypending = false, requireOptionalDependencies = true) {
         if (!this.pluginStatus[pluginName]) {
             this.pluginStatus[pluginName] = "pending" /* PluginStatus.PENDING */;
         }
@@ -211,7 +207,10 @@ export class PluginLoader {
                     }
                 }
             }
-            const deps = pluginInstance.depend || [];
+            const deps = [
+                ...(pluginInstance.depend || []),
+                ...(requireOptionalDependencies ? (pluginInstance.optional || []) : []),
+            ];
             const unmetDependencies = deps.filter(dep => !this.core.components[dep] && !this.core.services[dep]);
             if (unmetDependencies.length > 0) {
                 return false;
@@ -231,7 +230,7 @@ export class PluginLoader {
             await this.core.plugin(pluginInstance, context, finalConfig);
             this.pluginStatus[pluginName] = "enabled" /* PluginStatus.ENABLED */;
             if (triggerPendingCheck) {
-                await this._loadPendingPlugins();
+                await this._loadPendingPlugins(requireOptionalDependencies);
             }
             if (this.isDev) {
                 let pluginPathToWatch = null;
@@ -265,13 +264,14 @@ export class PluginLoader {
             return false;
         }
     }
-    async _loadPendingPlugins() {
+    async _loadPendingPlugins(requireOptionalDependencies = true) {
         const pendingPlugins = Object.keys(this.pluginStatus).filter(p => this.pluginStatus[p] === "pending" /* PluginStatus.PENDING */);
-        if (pendingPlugins.length === 0)
-            return;
+        let loadedAny = false;
         for (const pluginName of pendingPlugins) {
-            await this.loadSinglePlugin(pluginName, false);
+            const loaded = await this.loadSinglePlugin(pluginName, false, true, requireOptionalDependencies);
+            loadedAny ||= loaded;
         }
+        return loadedAny;
     }
     async unloadPlugin(pluginNameToUnload, ispending = false) {
         const dependents = [];
@@ -325,7 +325,10 @@ export class PluginLoader {
         this.logger.info(`Reloading plugin: "${pluginName}"...`);
         await this.reloadConfigFile();
         await this.unloadPlugin(pluginName, true);
-        const success = await this.loadSinglePlugin(pluginName, true, false);
+        let success = await this.loadSinglePlugin(pluginName, true, false, true);
+        if (!success) {
+            success = await this.loadSinglePlugin(pluginName, true, false, false);
+        }
         if (success) {
             this.logger.info(`Plugin "${pluginName}" reloaded successfully.`);
             this.core.emit('plugin-reloaded', pluginName);
@@ -413,7 +416,36 @@ export class PluginLoader {
             readline.close();
         }
     }
+    isPluginModuleResolvable(moduleName) {
+        try {
+            import.meta.resolve(moduleName);
+            return true;
+        }
+        catch (error) {
+            if (this.isMissingModuleError(error, moduleName))
+                return false;
+            throw error;
+        }
+    }
+    async installMissingPluginModules(entries) {
+        const missingModules = [...new Set(entries.map(entry => entry.moduleName))]
+            .filter(moduleName => !this.isPluginModuleResolvable(moduleName));
+        for (const moduleName of missingModules) {
+            const shouldInstall = await this.confirmPluginInstall(moduleName);
+            if (!shouldInstall)
+                continue;
+            try {
+                await this.installMissingPlugin(moduleName);
+            }
+            catch (error) {
+                this.logger.error(`Failed to install missing plugin "${moduleName}":`, error);
+            }
+        }
+    }
     async installMissingPlugin(moduleName) {
+        if (!/^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9._-]*$/i.test(moduleName)) {
+            throw new Error(`Cannot automatically install invalid package name "${moduleName}".`);
+        }
         const packageManager = this.detectPackageManager();
         const global = this.isNpxInvocation();
         const argsByManager = {
@@ -426,21 +458,21 @@ export class PluginLoader {
         const command = process.platform === 'win32' ? `${packageManager}.cmd` : packageManager;
         this.logger.info(`Installing missing plugin "${moduleName}" with ${command} ${args.join(' ')}` +
             (global ? ' (global)' : ''));
+        // Windows command shims (for example npm.cmd) require cmd.exe; execFile
+        // otherwise fails before the package manager can start with spawn EINVAL.
+        if (process.platform === 'win32') {
+            await execFileAsync(process.env.ComSpec || 'cmd.exe', [
+                '/d',
+                '/s',
+                '/c',
+                `${command} ${args.join(' ')}`,
+            ], { cwd: process.cwd() });
+            return;
+        }
         await execFileAsync(command, args, { cwd: process.cwd() });
     }
     async importPluginModule(moduleName) {
-        try {
-            return await import(moduleName);
-        }
-        catch (error) {
-            if (!this.isMissingModuleError(error, moduleName))
-                throw error;
-            const shouldInstall = await this.confirmPluginInstall(moduleName);
-            if (!shouldInstall)
-                throw error;
-            await this.installMissingPlugin(moduleName);
-            return await import(moduleName);
-        }
+        return await import(moduleName);
     }
     async loadModule(pluginName) {
         const entry = this.getPluginEntry(pluginName);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yumerijs/loader",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "description": "Module loader for yumeri",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",