@ai-setting/roy-agent-cli 1.3.15 → 1.3.17

package/dist/cli/src/services/environment.service.js

@@ -0,0 +1,544 @@
+/**
+ * @fileoverview Environment Service
+ *
+ * 封装 Environment 实例的创建和管理
+ */
+import path from "path";
+import os from "os";
+import fs from "fs/promises";
+import { BaseEnvironment, ConfigComponent, SessionComponent, LLMComponent, ToolComponent, AgentComponent, LogTraceComponent, PromptComponent, TaskComponent, SkillComponent, McpComponent, CommandsComponent, MemoryComponent, EventSourceComponent, } from "@ai-setting/roy-agent-core";
+// 导入 env/workflow 目录下的完整实现
+import { WorkflowComponent } from "@ai-setting/roy-agent-core";
+// 导入 MemoryPlugin
+import { MemoryPlugin } from "@ai-setting/roy-agent-core";
+// 导入 logger
+import { createLogger } from "@ai-setting/roy-agent-core";
+const logger = createLogger("environment-service");
+import { OutputService } from "./output.service.js";
+import { CliQuietModeService } from "./quiet-mode.service.js";
+// Plugin 机制 - 使用全局注册表
+import { globalPluginRegistry } from "../plugin/registry.js";
+/**
+ * CLI 配置目录常量
+ *
+ * 优先级：
+ * 1. 环境变量 XDG_CONFIG_HOME/roy-agent（XDG 标准）
+ * 2. ~/.roy-agent（用户家目录，默认）
+ * 3. {workDir}/.roy-agent（工作目录，项目级覆盖）
+ */
+const CLI_CONFIG_DIR_NAME = "roy-agent";
+const DEFAULT_CONFIG_FILE = "config.jsonc";
+/**
+ * 获取 CLI 用户配置目录
+ *
+ * 按以下顺序查找：
+ * 1. $XDG_CONFIG_HOME/roy-agent（XDG 标准）
+ * 2. ~/.roy-agent（用户家目录，默认）
+ */
+function getUserConfigDir() {
+    // XDG_CONFIG_HOME 优先
+    const xdgConfigHome = process.env.XDG_CONFIG_HOME;
+    if (xdgConfigHome) {
+        return path.join(xdgConfigHome, CLI_CONFIG_DIR_NAME);
+    }
+    // 回退到 ~/.roy-agent
+    return path.join(os.homedir(), ".roy-agent");
+}
+/**
+ * EnvironmentService - CLI 环境服务
+ *
+ * 负责创建和管理 BaseEnvironment 实例及其组件
+ */
+export class EnvironmentService {
+    environment = null;
+    output;
+    options = {};
+    // 组件实例（用于 getSession, getLLM 等方法）
+    configComponent;
+    sessionComponent;
+    llmComponent;
+    toolComponent;
+    agentComponent;
+    skillComponent;
+    logTraceComponent;
+    promptComponent;
+    taskComponent;
+    mcpComponent;
+    commandsComponent;
+    memoryComponent;
+    memoryPlugin;
+    eventSourceComponent;
+    workflowComponent;
+    constructor(output) {
+        this.output = output ?? new OutputService();
+    }
+    /**
+     * 获取已创建的 Environment 实例
+     */
+    getEnvironment() {
+        return this.environment;
+    }
+    /**
+     * 获取 SessionComponent 实例
+     */
+    getSession() {
+        return this.sessionComponent || null;
+    }
+    /**
+     * 获取 LLMComponent 实例
+     */
+    getLLM() {
+        return this.llmComponent || null;
+    }
+    /**
+     * 获取 ToolComponent 实例
+     */
+    getTool() {
+        return this.toolComponent || null;
+    }
+    /**
+     * 获取 AgentComponent 实例
+     */
+    getAgent() {
+        return this.agentComponent || null;
+    }
+    /**
+     * 获取 SkillComponent 实例
+     */
+    getSkill() {
+        return this.skillComponent || null;
+    }
+    /**
+     * 获取 CommandsComponent 实例
+     */
+    getCommands() {
+        return this.commandsComponent || null;
+    }
+    /**
+     * 获取 LogTraceComponent 实例
+     */
+    getLogTrace() {
+        return this.logTraceComponent || null;
+    }
+    /**
+     * 获取 MemoryPlugin 实例（用于 shared instances with MemoryComponent）
+     */
+    getMemoryPlugin() {
+        return this.memoryPlugin || null;
+    }
+    /**
+     * 释放环境资源
+     */
+    async dispose() {
+        // 停止所有组件
+        for (const component of [
+            this.eventSourceComponent,
+            this.memoryComponent,
+            this.commandsComponent,
+            this.mcpComponent,
+            this.skillComponent,
+            this.taskComponent,
+            this.promptComponent,
+            this.logTraceComponent,
+            this.agentComponent,
+            this.toolComponent,
+            this.sessionComponent,
+            this.llmComponent,
+            this.configComponent,
+            this.workflowComponent,
+        ]) {
+            if (component && typeof component.stop === "function") {
+                try {
+                    await component.stop();
+                }
+                catch (e) {
+                    // ignore
+                }
+            }
+        }
+        this.environment = null;
+        this.sessionComponent = undefined;
+        this.llmComponent = undefined;
+        this.toolComponent = undefined;
+        this.agentComponent = undefined;
+        this.skillComponent = undefined;
+        this.logTraceComponent = undefined;
+        this.configComponent = undefined;
+    }
+    /**
+     * 创建 CLI 环境
+     *
+     * 配置目录优先级：
+     * 1. --config 参数指定的路径
+     * 2. 工作目录下的 .roy-agent/config.jsonc（项目级覆盖）
+     * 3. ~/.roy-agent/config.jsonc（用户级默认）
+     */
+    async create(options) {
+        const workDir = options?.workDir ?? process.cwd();
+        const envName = options?.envName ?? "roy-cli";
+        // 启用安静模式（抑制日志输出到控制台）
+        if (options?.quiet) {
+            CliQuietModeService.getInstance().setQuiet(true);
+        }
+        // 确定配置文件路径
+        let configPath = options?.configPath;
+        let configDir;
+        if (!configPath) {
+            // 1. 优先使用工作目录下的配置（项目级覆盖）
+            const workDirConfigPath = path.join(workDir, CLI_CONFIG_DIR_NAME, DEFAULT_CONFIG_FILE);
+            try {
+                await fs.access(workDirConfigPath);
+                configPath = workDirConfigPath;
+                configDir = path.dirname(configPath);
+            }
+            catch {
+                // 2. 回退到用户家目录 ~/.roy-agent
+                configDir = getUserConfigDir();
+                configPath = path.join(configDir, DEFAULT_CONFIG_FILE);
+            }
+        }
+        else {
+            configDir = path.dirname(configPath);
+        }
+        // 确保配置文件目录存在（如果需要初始化的话）
+        try {
+            await fs.mkdir(configDir, { recursive: true });
+        }
+        catch {
+            // 目录已存在，忽略错误
+        }
+        // 保存配置选项
+        this.options = {
+            configPath,
+        };
+        // 1. 创建 BaseEnvironment
+        const env = new BaseEnvironment({
+            name: envName,
+            version: "1.0.0",
+        });
+        // 2. 创建并注册核心组件
+        // ConfigComponent - 必须在其他组件之前创建
+        this.configComponent = new ConfigComponent();
+        const configComponent = this.configComponent;
+        // 设置 XDG_DATA_HOME 为配置文件目录，这样 relativePath 可以正常工作
+        // 注意：这会影响到所有组件的路径解析
+        configComponent.setXdgDataHome(configDir);
+        // LLMComponent - 需要 ConfigComponent 和配置文件路径
+        // 注意：必须在 env.init() 之前初始化，传入配置选项
+        this.llmComponent = new LLMComponent();
+        const llmComponent = this.llmComponent;
+        await llmComponent.init({
+            name: "llm",
+            version: "1.0.0",
+            enabled: true,
+            env,
+            options: {
+                configComponent,
+                configPath: path.basename(configPath), // 使用相对路径
+            },
+        });
+        // SessionComponent
+        this.sessionComponent = new SessionComponent();
+        const sessionComponent = this.sessionComponent;
+        // 构建 session 配置
+        const sessionConfig = {};
+        if (options?.sessionStorage) {
+            if (options.sessionStorage.type) {
+                sessionConfig.storage = { type: options.sessionStorage.type };
+            }
+            if (options.sessionStorage.dbPath) {
+                sessionConfig.storage = {
+                    ...(sessionConfig.storage || {}),
+                    dbPath: options.sessionStorage.dbPath,
+                };
+            }
+        }
+        await sessionComponent.init({
+            name: "session",
+            version: "1.0.0",
+            enabled: true,
+            env,
+            options: { configComponent, config: Object.keys(sessionConfig).length > 0 ? sessionConfig : undefined },
+        });
+        // ToolComponent
+        this.toolComponent = new ToolComponent();
+        const toolComponent = this.toolComponent;
+        await toolComponent.init({
+            name: "tool",
+            version: "1.0.0",
+            enabled: true,
+            env,
+            options: { configComponent },
+        });
+        // AgentComponent
+        this.agentComponent = new AgentComponent();
+        const agentComponent = this.agentComponent;
+        await agentComponent.init({
+            name: "agent",
+            version: "1.0.0",
+            enabled: true,
+            env,
+            options: {
+                configComponent,
+                configPath: path.basename(configPath), // 传入配置路径，以便从配置文件中加载 agent 配置
+            },
+        });
+        // LogTraceComponent
+        this.logTraceComponent = new LogTraceComponent();
+        const logTraceComponent = this.logTraceComponent;
+        await logTraceComponent.init({
+            name: "log-trace",
+            version: "1.0.0",
+            enabled: true,
+            env,
+            options: {
+                configComponent,
+                configPath: path.basename(configPath), // 传入相对路径，让 LogTraceComponent 从 XDG_DATA_HOME 读取
+            },
+        });
+        // PromptComponent
+        this.promptComponent = new PromptComponent();
+        const promptComponent = this.promptComponent;
+        await promptComponent.init({
+            name: "prompt",
+            version: "1.0.0",
+            enabled: true,
+            env,
+            options: { configComponent },
+        });
+        // TaskComponent
+        this.taskComponent = new TaskComponent();
+        const taskComponent = this.taskComponent;
+        await taskComponent.init({
+            name: "task",
+            version: "1.0.0",
+            enabled: true,
+            env,
+            options: { configComponent },
+        });
+        // SkillComponent
+        this.skillComponent = new SkillComponent();
+        const skillComponent = this.skillComponent;
+        await skillComponent.init({
+            name: "skill",
+            version: "1.0.0",
+            enabled: true,
+            env,
+            options: { configComponent },
+        });
+        // McpComponent - 必须在 ToolComponent 之后初始化，以便注册 MCP tools
+        this.mcpComponent = new McpComponent();
+        const mcpComponent = this.mcpComponent;
+        await mcpComponent.init({
+            name: "mcp",
+            version: "1.0.0",
+            enabled: true,
+            env,
+            options: { configComponent },
+        });
+        // CommandsComponent
+        this.commandsComponent = new CommandsComponent();
+        const commandsComponent = this.commandsComponent;
+        await commandsComponent.init({
+            name: "commands",
+            version: "2.0.0",
+            enabled: true,
+            env,
+            options: { configComponent },
+        });
+        // MemoryPlugin - 在 MemoryComponent 之前创建，以便共享实例
+        const memoryWorkDir = workDir || process.cwd();
+        this.memoryPlugin = new MemoryPlugin(memoryWorkDir, {
+            enabled: true,
+        });
+        await this.memoryPlugin.initialize();
+        // MemoryComponent - 必须在 ToolComponent 之后初始化，以便注册 memory tools
+        // 传入 memoryPlugin 以复用其 DraftManager/Organizer 实例
+        this.memoryComponent = new MemoryComponent();
+        const memoryComponent = this.memoryComponent;
+        await memoryComponent.init({
+            name: "memory",
+            version: "1.0.0",
+            enabled: true,
+            env,
+            options: { configComponent, memoryPlugin: this.memoryPlugin },
+        });
+        // EventSourceComponent - 事件源组件
+        this.eventSourceComponent = new EventSourceComponent();
+        const eventSourceComponent = this.eventSourceComponent;
+        await eventSourceComponent.init({
+            name: "event-source",
+            version: "1.0.0",
+            enabled: true,
+            env,
+            options: { configComponent },
+        });
+        // 启用安静模式（必须在 WorkflowComponent 初始化之前设置）
+        if (options?.quiet) {
+            CliQuietModeService.getInstance().setQuiet(true);
+        }
+        // WorkflowComponent - 工作流组件
+        this.workflowComponent = new WorkflowComponent();
+        const workflowComponent = this.workflowComponent;
+        await workflowComponent.init({
+            env,
+            options: {
+                configComponent,
+                toolComponent,
+                llmComponent,
+                logTraceComponent,
+                skillRegistry: skillComponent,
+                env,
+            },
+        });
+        await workflowComponent.start();
+        // 注册所有组件
+        env.registerComponent(configComponent);
+        env.registerComponent(sessionComponent);
+        env.registerComponent(llmComponent);
+        env.registerComponent(toolComponent);
+        env.registerComponent(agentComponent);
+        env.registerComponent(logTraceComponent);
+        env.registerComponent(promptComponent);
+        env.registerComponent(taskComponent);
+        env.registerComponent(skillComponent);
+        env.registerComponent(mcpComponent);
+        env.registerComponent(commandsComponent);
+        env.registerComponent(memoryComponent);
+        env.registerComponent(eventSourceComponent);
+        env.registerComponent(workflowComponent);
+        // 注册 commands-prompt Hook（将收藏命令动态注入 default prompt）
+        this.registerCommandsPromptHook(promptComponent, commandsComponent);
+        // 初始化 BaseEnvironment
+        await env.init();
+        // 启动 Environment - 触发所有组件的 start() 生命周期钩子
+        // 这对于依赖 start() 注册工具的组件至关重要（如 TaskComponent, MemoryComponent、SkillComponent）
+        await env.start();
+        // 刷新 AgentComponent 的依赖组件引用
+        // 原因：AgentComponent 在 onInit() 时调用 refreshDependencies()，
+        // 但此时 env.start() 还未被调用，组件尚未注册到 Environment
+        // 所以需要在 env.start() 之后再次刷新，确保 AgentComponent 能获取到 LLMComponent
+        agentComponent.refreshDependencies();
+        logger.debug("[EnvironmentService] AgentComponent dependencies refreshed after env.start()");
+        // 加载 Component Plugins（组件插件）
+        if (options?.plugins && options.plugins.length > 0) {
+            await this.loadComponentPlugins(options.plugins, {
+                task: taskComponent,
+                memory: memoryComponent,
+                llm: llmComponent,
+            });
+        }
+        // 加载 Coder Plugins
+        if (options?.plugins && options.plugins.length > 0) {
+            await this.loadCoderPlugins(options.plugins);
+        }
+        this.environment = env;
+        return env;
+    }
+    /**
+     * 注册 commands-prompt Hook
+     *
+     * 将收藏命令的能力动态注入 default prompt
+     */
+    registerCommandsPromptHook(promptComponent, commandsComponent) {
+        promptComponent.addHook("prompt.after-render", "commands-prompt", async (ctx) => {
+            // 只对 default prompt 注入
+            const data = ctx.data;
+            if (data.name !== "default")
+                return;
+            try {
+                const metaList = await commandsComponent.getCommandsMeta();
+                // 无命令时不追加内容
+                if (metaList.length === 0)
+                    return;
+                const commandsSection = this.renderCommandsSection(metaList);
+                data.renderedContent += "\n\n" + commandsSection;
+                this.output.log(`[Environment] Injected ${metaList.length} commands into default prompt`);
+            }
+            catch (error) {
+                this.output.error(`Failed to inject commands into prompt: ${error}`);
+            }
+        });
+        this.output.info("Registered commands-prompt Hook");
+    }
+    /**
+     * 加载组件插件
+     *
+     * 通用方法，从全局注册表获取组件插件定义，加载并注册到目标组件
+     */
+    async loadComponentPlugins(pluginNames, components) {
+        for (const name of pluginNames) {
+            try {
+                // 从全局注册表获取组件插件定义
+                const definition = globalPluginRegistry.getComponentPlugin(name);
+                if (!definition) {
+                    this.output.warn(`[EnvironmentService] Component plugin not found: ${name}`);
+                    continue;
+                }
+                // 创建插件实例
+                const plugin = await definition.factory();
+                // 注册到目标组件
+                const targetComponent = components[definition.targetComponent];
+                if (targetComponent && typeof targetComponent.registerPlugin === "function") {
+                    targetComponent.registerPlugin(plugin);
+                    // 验证插件已注册
+                    const registeredPlugins = targetComponent.listPlugins?.() || [];
+                    const isRegistered = registeredPlugins.some((p) => p.name === plugin.name);
+                    this.output.log(`[EnvironmentService] Loaded component plugin: ${name} -> ${definition.targetComponent}`);
+                    this.output.log(`[EnvironmentService] Plugin verified: ${isRegistered ? "YES" : "NO"} (${plugin.name} in ${definition.targetComponent})`);
+                }
+                else {
+                    this.output.warn(`[EnvironmentService] Target component not found or not registerable: ${definition.targetComponent}`);
+                }
+            }
+            catch (error) {
+                this.output.error(`[EnvironmentService] Error loading component plugin "${name}": ${error}`);
+            }
+        }
+    }
+    /**
+     * 渲染命令表格 section
+     */
+    renderCommandsSection(metaList) {
+        // 按名称排序
+        const sortedMeta = [...metaList].sort((a, b) => a.name.localeCompare(b.name));
+        const rows = sortedMeta
+            .map(m => `| \`${m.name}\` | ${m.description} |`)
+            .join("\n");
+        return `## Your Commands Arsenal
+
+You have access to these custom commands:
+
+| Command | Description |
+|---------|-------------|
+${rows}
+
+Progressive Discovery: Run \`<command> --help\` to explore full capabilities.`;
+    }
+    /**
+     * 加载 Coder Plugins
+     *
+     * 根据插件名称列表加载对应的 coder-harness 插件
+     */
+    async loadCoderPlugins(pluginNames) {
+        const { createPluginHookAdapter } = await import("@ai-setting/roy-agent-coder-harness");
+        const { globalHookManager } = await import("@ai-setting/roy-agent-core");
+        // 确定要加载的插件配置
+        const pluginConfigs = {
+            enableLSP: pluginNames.includes("lsp"),
+            enableCodeCheck: pluginNames.includes("code-check"),
+            enableReminder: pluginNames.includes("reminder"),
+        };
+        // 只有在有需要时才创建 adapter
+        if (!pluginConfigs.enableLSP && !pluginConfigs.enableCodeCheck && !pluginConfigs.enableReminder) {
+            return;
+        }
+        // 使用全局 HookManager
+        const hookManager = globalHookManager;
+        // 创建并初始化 PluginHookAdapter
+        const adapter = createPluginHookAdapter(hookManager, pluginConfigs);
+        await adapter.initialize();
+        this.output.log(`[EnvironmentService] Loaded coder plugins: ${pluginNames.join(", ")}`);
+    }
+}
+//# sourceMappingURL=environment.service.js.map

package/dist/cli/src/services/output.service.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @fileoverview Output Service
+ *
+ * 统一的输出格式化服务（非交互式）
+ */
+export interface OutputOptions {
+    quiet?: boolean;
+    jsonOutput?: boolean;
+    noColor?: boolean;
+}
+/**
+ * OutputService - CLI 输出服务
+ *
+ * 提供统一的格式化输出：
+ * - 普通消息
+ * - 成功/警告/错误消息
+ * - JSON 输出
+ */
+export declare class OutputService {
+    private quiet;
+    private jsonOutput;
+    private noColor;
+    /**
+     * 配置输出选项
+     */
+    configure(options: OutputOptions): void;
+    /**
+     * 获取配置状态
+     */
+    isQuiet(): boolean;
+    isJsonOutput(): boolean;
+    isNoColor(): boolean;
+    /**
+     * 输出普通消息
+     */
+    info(message: string): void;
+    /**
+     * 输出日志消息（不添加前缀）
+     */
+    log(message?: string): void;
+    /**
+     * 输出成功消息
+     */
+    success(message: string): void;
+    /**
+     * 输出警告消息
+     */
+    warn(message: string): void;
+    /**
+     * 输出错误消息
+     *
+     * 注意：错误消息即使在安静模式下也会输出
+     */
+    error(message: string): void;
+    /**
+     * 输出错误消息（详细版）
+     */
+    errorDetailed(message: string, details?: unknown): void;
+    /**
+     * 格式化并输出 JSON
+     */
+    printJson(data: unknown, pretty?: boolean): void;
+    /**
+     * 输出 JSON（别名方法）
+     */
+    json(data: unknown): void;
+}
+//# sourceMappingURL=output.service.d.ts.map