@ai-setting/roy-agent-cli 1.3.14 → 1.3.16

package/dist/coder-harness/src/plugins/plugin-hook-adapter.d.ts

@@ -0,0 +1,192 @@
+/**
+ * @fileoverview PluginHookAdapter - CLI Plugin 与 Core HookManager 的桥接
+ *
+ * 将 LSPPlugin/CodeCheckPlugin/ReminderPlugin 的 onAfterTool 方法适配为标准 Hook 接口
+ */
+import { HookManager } from "@ai-setting/roy-agent-core";
+import type { LSPPlugin, LSPPluginConfig } from "./lsp-plugin";
+import type { CodeCheckPlugin } from "./code-check-plugin";
+import type { CodeCheckPluginConfig } from "../types/linter";
+import type { ReminderPlugin, ReminderPluginConfig } from "./reminder-plugin";
+/**
+ * after.tool Hook 数据类型
+ */
+export interface AfterToolHookData {
+    /** 工具名称 */
+    toolName: string;
+    /** 工具参数 */
+    args: Record<string, unknown>;
+    /** 工具执行结果 */
+    result: {
+        success: boolean;
+        output?: string | Record<string, unknown>;
+        error?: string;
+        metadata?: Record<string, unknown>;
+    };
+}
+/**
+ * BuiltInPluginsConfig - 内置 Plugins 批量注册配置（别名，兼容旧代码）
+ */
+export interface BuiltInPluginsConfig extends PluginHookAdapterConfig {
+}
+/**
+ * PluginHookAdapter 配置
+ *
+ * 支持两种命名风格：
+ * - enableLSP/enableCodeCheck/enableReminder (简洁风格)
+ * - lspEnabled (详细风格)
+ */
+export interface PluginHookAdapterConfig {
+    /** 是否启用 LSPPlugin (简洁风格) */
+    enableLSP?: boolean;
+    /** LSPPlugin 配置 */
+    lspConfig?: LSPPluginConfig;
+    /** 是否启用 LSPPlugin (详细风格，兼容) */
+    lspEnabled?: boolean;
+    /** 是否启用 CodeCheckPlugin */
+    enableCodeCheck?: boolean;
+    /** CodeCheckPlugin 配置 */
+    codeCheckConfig?: CodeCheckPluginConfig;
+    /** 是否启用 ReminderPlugin */
+    enableReminder?: boolean;
+    /** ReminderPlugin 配置 */
+    reminderConfig?: ReminderPluginConfig;
+    /** 是否启用 ReminderPlugin (详细风格，兼容) */
+    reminderEnabled?: boolean;
+}
+/**
+ * PluginHookAdapter
+ *
+ * 桥接 CLI Plugin（LSPPlugin/CodeCheckPlugin/ReminderPlugin）与 Core HookManager
+ *
+ * @example
+ * ```typescript
+ * // 创建 Adapter
+ * const adapter = new PluginHookAdapter(hookManager);
+ *
+ * // 注册单个 Plugin
+ * const lsp = new LSPPlugin({ enabled: true });
+ * adapter.registerLSPPlugin(lsp);
+ *
+ * // 或批量注册
+ * adapter.registerBuiltInPlugins({
+ *   enableLSP: true,
+ *   enableCodeCheck: true,
+ *   enableReminder: true,
+ * });
+ *
+ * // 初始化（启动 LSP 预加载等）
+ * await adapter.initialize();
+ *
+ * // 清理
+ * await adapter.dispose();
+ * ```
+ */
+export declare class PluginHookAdapter {
+    /** 关联的 HookManager */
+    private hookManager;
+    /** 已注册的 Plugin */
+    private registrations;
+    /** Hook 点名称 - 使用统一的 hook 点命名规范 */
+    private readonly HOOK_POINT;
+    /** LSP Plugin 实例引用（用于初始化和清理） */
+    private lspPlugin;
+    /** CodeCheckPlugin 实例引用 */
+    private codeCheckPlugin;
+    /** ReminderPlugin 实例引用 */
+    private reminderPlugin;
+    /**
+     * 优先级常量
+     */
+    static readonly PRIORITY: {
+        readonly LSP_PLUGIN: 80;
+        readonly CODE_CHECK_PLUGIN: 90;
+        readonly REMINDER_PLUGIN: 100;
+    };
+    constructor(hookManager: HookManager);
+    /**
+     * 初始化所有已注册的 Plugins
+     *
+     * 对于 LSPPlugin，会根据配置启动 LSP 预加载
+     *
+     * @example
+     * ```typescript
+     * adapter.registerBuiltInPlugins({ enableLSP: true, lspConfig: { preloadMode: "startup" } });
+     * await adapter.initialize();  // 预加载 LSP 服务器
+     * ```
+     */
+    initialize(): Promise<void>;
+    /**
+     * 注册 LSPPlugin
+     */
+    registerLSPPlugin(plugin: LSPPlugin): void;
+    /**
+     * 注册 CodeCheckPlugin
+     */
+    registerCodeCheckPlugin(plugin: CodeCheckPlugin): void;
+    /**
+     * 注册 ReminderPlugin
+     *
+     * ReminderPlugin 使用不同的 hook 点（agent:before.llm）和方法（execute）
+     */
+    registerReminderPlugin(plugin: ReminderPlugin): void;
+    /**
+     * 批量注册内置 Plugins
+     *
+     * @param config - 配置对象，包含各 Plugin 的启用状态和配置
+     */
+    registerBuiltInPlugins(config: PluginHookAdapterConfig): void;
+    /**
+     * 清理所有注册的 Plugin
+     */
+    dispose(): Promise<void>;
+    /**
+     * 获取已注册的 Plugin 名称列表
+     */
+    getRegisteredPlugins(): string[];
+    /**
+     * 检查指定 Plugin 是否已注册
+     */
+    isPluginRegistered(pluginName: string): boolean;
+    /**
+     * 注册 Plugin（防止重复注册）
+     */
+    private registerPlugin;
+    /**
+     * 从 Plugin 创建标准 Hook
+     */
+    private createHookFromPlugin;
+    /**
+     * 从配置创建并注册 LSPPlugin
+     */
+    private registerLSPPluginFromConfig;
+    /**
+     * 从配置创建并注册 CodeCheckPlugin
+     */
+    private registerCodeCheckPluginFromConfig;
+    /**
+     * 从配置创建并注册 ReminderPlugin
+     */
+    private registerReminderPluginFromConfig;
+}
+/**
+ * 创建 PluginHookAdapter 实例的工厂函数
+ *
+ * @example
+ * ```typescript
+ * const adapter = createPluginHookAdapter(hookManager, {
+ *   enableLSP: true,
+ *   lspConfig: { preloadMode: "startup" },
+ * });
+ *
+ * // 初始化（启动 LSP 预加载等）
+ * await adapter.initialize();
+ *
+ * // ... 使用 adapter ...
+ *
+ * // 清理
+ * await adapter.dispose();
+ * ```
+ */
+export declare function createPluginHookAdapter(hookManager: HookManager, config?: PluginHookAdapterConfig): PluginHookAdapter;
+//# sourceMappingURL=plugin-hook-adapter.d.ts.map

package/dist/coder-harness/src/plugins/plugin-hook-adapter.js

@@ -0,0 +1,294 @@
+/**
+ * @fileoverview PluginHookAdapter - CLI Plugin 与 Core HookManager 的桥接
+ *
+ * 将 LSPPlugin/CodeCheckPlugin/ReminderPlugin 的 onAfterTool 方法适配为标准 Hook 接口
+ */
+/**
+ * 创建 Hook 的工厂函数
+ *
+ * 复制自 @roy-agent/core 以避免模块解析问题
+ */
+function createHook(meta, fn) {
+    return {
+        ...meta,
+        execute: fn,
+    };
+}
+/**
+ * PluginHookAdapter
+ *
+ * 桥接 CLI Plugin（LSPPlugin/CodeCheckPlugin/ReminderPlugin）与 Core HookManager
+ *
+ * @example
+ * ```typescript
+ * // 创建 Adapter
+ * const adapter = new PluginHookAdapter(hookManager);
+ *
+ * // 注册单个 Plugin
+ * const lsp = new LSPPlugin({ enabled: true });
+ * adapter.registerLSPPlugin(lsp);
+ *
+ * // 或批量注册
+ * adapter.registerBuiltInPlugins({
+ *   enableLSP: true,
+ *   enableCodeCheck: true,
+ *   enableReminder: true,
+ * });
+ *
+ * // 初始化（启动 LSP 预加载等）
+ * await adapter.initialize();
+ *
+ * // 清理
+ * await adapter.dispose();
+ * ```
+ */
+export class PluginHookAdapter {
+    /** 关联的 HookManager */
+    hookManager;
+    /** 已注册的 Plugin */
+    registrations = new Map();
+    /** Hook 点名称 - 使用统一的 hook 点命名规范 */
+    HOOK_POINT = "tool:after.execute";
+    /** LSP Plugin 实例引用（用于初始化和清理） */
+    lspPlugin = null;
+    /** CodeCheckPlugin 实例引用 */
+    codeCheckPlugin = null;
+    /** ReminderPlugin 实例引用 */
+    reminderPlugin = null;
+    /**
+     * 优先级常量
+     */
+    static PRIORITY = {
+        LSP_PLUGIN: 80,
+        CODE_CHECK_PLUGIN: 90,
+        REMINDER_PLUGIN: 100,
+    };
+    constructor(hookManager) {
+        this.hookManager = hookManager;
+    }
+    /**
+     * 初始化所有已注册的 Plugins
+     *
+     * 对于 LSPPlugin，会根据配置启动 LSP 预加载
+     *
+     * @example
+     * ```typescript
+     * adapter.registerBuiltInPlugins({ enableLSP: true, lspConfig: { preloadMode: "startup" } });
+     * await adapter.initialize();  // 预加载 LSP 服务器
+     * ```
+     */
+    async initialize() {
+        // 初始化 LSP Plugin
+        if (this.lspPlugin && typeof this.lspPlugin.initialize === "function") {
+            await this.lspPlugin.initialize();
+        }
+    }
+    /**
+     * 注册 LSPPlugin
+     */
+    registerLSPPlugin(plugin) {
+        this.registerPlugin("LSPPlugin", plugin, plugin.priority ?? PluginHookAdapter.PRIORITY.LSP_PLUGIN);
+        // 保存 LSPPlugin 引用，用于初始化和清理
+        this.lspPlugin = plugin;
+    }
+    /**
+     * 注册 CodeCheckPlugin
+     */
+    registerCodeCheckPlugin(plugin) {
+        this.registerPlugin("CodeCheckPlugin", plugin, plugin.priority ?? PluginHookAdapter.PRIORITY.CODE_CHECK_PLUGIN);
+        this.codeCheckPlugin = plugin;
+    }
+    /**
+     * 注册 ReminderPlugin
+     *
+     * ReminderPlugin 使用不同的 hook 点（agent:before.llm）和方法（execute）
+     */
+    registerReminderPlugin(plugin) {
+        // 检查是否已注册
+        if (this.registrations.has("ReminderPlugin")) {
+            console.warn("PluginHookAdapter: ReminderPlugin is already registered, skipping.");
+            return;
+        }
+        // ReminderPlugin 使用 agent:before.llm hook 点
+        const hookPoint = "agent:before.llm";
+        const priority = plugin.priority ?? PluginHookAdapter.PRIORITY.REMINDER_PLUGIN;
+        // 创建 Hook
+        const hook = {
+            name: plugin.name,
+            priority,
+            description: plugin.description,
+            execute: async (ctx) => {
+                await plugin.execute(ctx);
+            },
+        };
+        // 注册到 HookManager
+        this.hookManager.register(hookPoint, hook);
+        // 记录注册信息
+        this.registrations.set("ReminderPlugin", {
+            name: "ReminderPlugin",
+            hooks: new Map([[hookPoint, hook]]),
+        });
+        this.reminderPlugin = plugin;
+    }
+    /**
+     * 批量注册内置 Plugins
+     *
+     * @param config - 配置对象，包含各 Plugin 的启用状态和配置
+     */
+    registerBuiltInPlugins(config) {
+        // 支持别名兼容
+        const enableLSP = config.enableLSP ?? config.lspEnabled ?? false;
+        const enableCodeCheck = config.enableCodeCheck ?? false;
+        const enableReminder = config.enableReminder ?? config.reminderEnabled ?? false;
+        const { lspConfig, codeCheckConfig, reminderConfig } = config;
+        // 注册 LSP Plugin
+        if (enableLSP) {
+            this.registerLSPPluginFromConfig(lspConfig);
+        }
+        // 注册 CodeCheck Plugin
+        if (enableCodeCheck) {
+            this.registerCodeCheckPluginFromConfig(codeCheckConfig);
+        }
+        // 注册 Reminder Plugin
+        if (enableReminder) {
+            this.registerReminderPluginFromConfig(reminderConfig);
+        }
+    }
+    /**
+     * 清理所有注册的 Plugin
+     */
+    async dispose() {
+        // 清理 LSP Plugin
+        if (this.lspPlugin && typeof this.lspPlugin.dispose === "function") {
+            await this.lspPlugin.dispose();
+            this.lspPlugin = null;
+        }
+        // 清理 CodeCheckPlugin
+        if (this.codeCheckPlugin && typeof this.codeCheckPlugin.dispose === "function") {
+            await this.codeCheckPlugin.dispose();
+            this.codeCheckPlugin = null;
+        }
+        // 清理 ReminderPlugin
+        if (this.reminderPlugin) {
+            this.reminderPlugin = null;
+        }
+        // 取消注册所有 Hooks
+        for (const [, registration] of this.registrations) {
+            for (const [hookPoint, hook] of registration.hooks) {
+                this.hookManager.unregister(hookPoint, hook.name);
+            }
+        }
+        // 清空注册表
+        this.registrations.clear();
+    }
+    /**
+     * 获取已注册的 Plugin 名称列表
+     */
+    getRegisteredPlugins() {
+        return Array.from(this.registrations.keys());
+    }
+    /**
+     * 检查指定 Plugin 是否已注册
+     */
+    isPluginRegistered(pluginName) {
+        return this.registrations.has(pluginName);
+    }
+    // ========================================================================
+    // 私有方法
+    // ========================================================================
+    /**
+     * 注册 Plugin（防止重复注册）
+     */
+    registerPlugin(pluginName, plugin, priority) {
+        // 检查是否已注册
+        if (this.registrations.has(pluginName)) {
+            console.warn(`PluginHookAdapter: ${pluginName} is already registered, skipping.`);
+            return;
+        }
+        // 创建 Hook
+        const hook = this.createHookFromPlugin(plugin, priority);
+        // 直接注册到 HookManager
+        this.hookManager.register(this.HOOK_POINT, hook);
+        // 记录注册信息
+        this.registrations.set(pluginName, {
+            name: pluginName,
+            hooks: new Map([[this.HOOK_POINT, hook]]),
+        });
+    }
+    /**
+     * 从 Plugin 创建标准 Hook
+     */
+    createHookFromPlugin(plugin, priority) {
+        // 检查是否有 onAfterTool 方法
+        const pluginHook = plugin;
+        if (!pluginHook.onAfterTool) {
+            throw new Error(`Plugin "${plugin.name}" does not have onAfterTool method. ` +
+                "Cannot register as after.tool hook.");
+        }
+        // 保存 plugin 引用，确保 onAfterTool 调用时 this 上下文正确
+        const boundPlugin = plugin;
+        // 使用 createHook 工厂函数创建 Hook
+        return createHook({
+            name: plugin.name,
+            priority,
+            description: plugin.description,
+        }, async (ctx) => {
+            await pluginHook.onAfterTool.call(boundPlugin, ctx);
+        });
+    }
+    /**
+     * 从配置创建并注册 LSPPlugin
+     */
+    registerLSPPluginFromConfig(config) {
+        // 动态导入避免循环依赖
+        const { LSPPlugin } = require("./lsp-plugin");
+        const plugin = new LSPPlugin(config);
+        this.registerLSPPlugin(plugin);
+    }
+    /**
+     * 从配置创建并注册 CodeCheckPlugin
+     */
+    registerCodeCheckPluginFromConfig(config) {
+        // 动态导入避免循环依赖
+        const { CodeCheckPlugin } = require("./code-check-plugin");
+        const plugin = new CodeCheckPlugin(config);
+        this.registerCodeCheckPlugin(plugin);
+    }
+    /**
+     * 从配置创建并注册 ReminderPlugin
+     */
+    registerReminderPluginFromConfig(config) {
+        // 动态导入避免循环依赖
+        const { ReminderPlugin } = require("./reminder-plugin");
+        const plugin = new ReminderPlugin(config);
+        this.registerReminderPlugin(plugin);
+    }
+}
+/**
+ * 创建 PluginHookAdapter 实例的工厂函数
+ *
+ * @example
+ * ```typescript
+ * const adapter = createPluginHookAdapter(hookManager, {
+ *   enableLSP: true,
+ *   lspConfig: { preloadMode: "startup" },
+ * });
+ *
+ * // 初始化（启动 LSP 预加载等）
+ * await adapter.initialize();
+ *
+ * // ... 使用 adapter ...
+ *
+ * // 清理
+ * await adapter.dispose();
+ * ```
+ */
+export function createPluginHookAdapter(hookManager, config) {
+    const adapter = new PluginHookAdapter(hookManager);
+    // 如果提供了配置，批量注册插件
+    if (config) {
+        adapter.registerBuiltInPlugins(config);
+    }
+    return adapter;
+}
+//# sourceMappingURL=plugin-hook-adapter.js.map

package/dist/coder-harness/src/plugins/plugin-hook-adapter.test.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @fileoverview PluginHookAdapter 测试
+ */
+export {};
+//# sourceMappingURL=plugin-hook-adapter.test.d.ts.map