@ai-setting/roy-agent-cli 1.0.0

package/src/commands/config/list.ts

@@ -0,0 +1,281 @@
+/**
+ * @fileoverview config list 子命令
+ * 
+ * 原 show-config 功能的重构版本
+ */
+
+import { CommandModule } from "yargs";
+import chalk from "chalk";
+import { EnvironmentService } from "../../services/environment.service";
+import { OutputService } from "../../services/output.service";
+import { ConfigService } from "./config-service";
+import { SUPPORTED_COMPONENTS, COMPONENT_DESCRIPTIONS, resolveComponentName } from "./types";
+
+export interface ConfigListOptions {
+  component?: string;
+  json?: boolean;
+  keys?: boolean;
+  sources?: boolean;
+  config?: string;
+}
+
+/**
+ * show-config 命令使用示例
+ */
+const USAGE_COMMANDS = [
+  { command: "roy config list", description: "显示帮助信息" },
+  { command: "roy config list tool", description: "查看 tool component 配置" },
+  { command: "roy config list session", description: "查看 session component 配置" },
+  { command: "roy config list all", description: "查看所有 components 概览" },
+  { command: "roy config list tool --json", description: "JSON 格式输出" },
+  { command: "roy config list tool --keys", description: "只显示配置键" },
+];
+
+/**
+ * ConfigListCommand - config list 子命令
+ */
+export const ConfigListCommand: CommandModule<object, ConfigListOptions> = {
+  command: "list [component]",
+  describe: "查看组件配置信息",
+
+  builder: (yargs) =>
+    yargs
+      .positional("component", {
+        type: "string",
+        describe: "Component 名称",
+      })
+      .option("json", {
+        type: "boolean",
+        describe: "JSON 格式输出",
+        alias: "j",
+      })
+      .option("keys", {
+        type: "boolean",
+        describe: "只显示配置键",
+        alias: "k",
+      })
+      .option("sources", {
+        type: "boolean",
+        describe: "只显示配置源",
+        alias: "s",
+      })
+      .option("config", {
+        type: "string",
+        describe: "配置文件路径",
+        alias: "c",
+      })
+      .example("roy config list", "显示帮助信息")
+      .example("roy config list tool", "查看 tool component 配置")
+      .example("roy config list session", "查看 session component 配置")
+      .example("roy config list all", "查看所有 components 概览")
+      .example("roy config list tool --json", "JSON 格式输出")
+      .example("roy config list tool --keys", "只显示配置键"),
+
+  async handler(args) {
+    const output = new OutputService();
+    const envService = new EnvironmentService(output);
+
+    try {
+      await envService.create({ configPath: args.config });
+      const env = envService.getEnvironment();
+      if (!env) {
+        output.error("Failed to get environment");
+        process.exit(1);
+      }
+      const configComponent = env.getComponent("config") as any;
+      if (!configComponent) {
+        output.error("ConfigComponent not available");
+        process.exit(1);
+      }
+      const configService = new ConfigService(configComponent, output);
+
+      // 无参数时显示帮助
+      if (!args.component) {
+        showHelp(output);
+        return;
+      }
+
+      // all: 显示所有 components
+      if (args.component === "all") {
+        await showAllComponents(output, configService);
+        return;
+      }
+
+      // 解析 component 名称（处理别名）
+      const componentName = resolveComponentName(args.component);
+      
+      // 验证 component
+      if (!SUPPORTED_COMPONENTS.includes(componentName as any)) {
+        output.error(`Unknown component: ${args.component}`);
+        output.log("");
+        output.log("Supported components:");
+        for (const comp of SUPPORTED_COMPONENTS) {
+          output.log(`  ${chalk.cyan(comp.padEnd(15))} ${COMPONENT_DESCRIPTIONS[comp] || ""}`);
+        }
+        process.exit(1);
+      }
+
+      // 显示特定 component
+      await showComponentConfig(componentName, output, configService, {
+        json: args.json,
+        keys: args.keys,
+        sources: args.sources,
+      });
+    } catch (error) {
+      output.error(`Failed to show config: ${error}`);
+      process.exit(1);
+    } finally {
+      await envService.dispose();
+    }
+  },
+};
+
+/**
+ * 显示帮助信息
+ */
+function showHelp(output: OutputService) {
+  output.log(chalk.bold.cyan("# roy config list"));
+  output.log("");
+  output.log("查看 roy-agent 组件配置信息");
+  output.log("");
+  output.log(chalk.bold("Usage:"));
+  output.log(`  ${chalk.cyan("roy config list [component] [options]")}`);
+  output.log("");
+  output.log(chalk.bold("Components:"));
+  for (const comp of SUPPORTED_COMPONENTS) {
+    output.log(
+      `  ${chalk.cyan(comp.padEnd(15))} ${chalk.gray(COMPONENT_DESCRIPTIONS[comp] || "")}`
+    );
+  }
+  output.log(`  ${chalk.cyan("all".padEnd(15))} 显示所有 components 概览`);
+  output.log("");
+  output.log(chalk.bold("Options:"));
+  output.log(`  ${chalk.cyan("-j, --json")}     JSON 格式输出`);
+  output.log(`  ${chalk.cyan("-k, --keys")}     只显示配置键`);
+  output.log(`  ${chalk.cyan("-s, --sources")}  只显示配置源`);
+  output.log("");
+  output.log(chalk.bold("Examples:"));
+  for (const { command, description } of USAGE_COMMANDS) {
+    output.log(`  ${chalk.cyan(command.padEnd(40))} ${chalk.gray(description)}`);
+  }
+}
+
+/**
+ * 显示所有 components 概览
+ */
+async function showAllComponents(
+  output: OutputService,
+  configService: ConfigService
+) {
+  const components: Array<{ name: string; config: Record<string, unknown> }> = [];
+
+  for (const compName of SUPPORTED_COMPONENTS) {
+    const config = configService.getComponentConfig(compName);
+    components.push({ name: compName, config });
+  }
+
+  output.log(chalk.bold.cyan("# All Components Overview"));
+  output.log("");
+  output.log(
+    `  ${chalk.cyan("Component".padEnd(15))} ${chalk.cyan("Keys".padEnd(10))} ${chalk.gray("Description")}`
+  );
+  output.log(`  ${chalk.gray("─".repeat(60))}`);
+
+  for (const comp of components) {
+    const keyCount = Object.keys(comp.config).length;
+    output.log(
+      `  ${chalk.cyan(comp.name.padEnd(15))} ${keyCount.toString().padEnd(10)} ${chalk.gray(COMPONENT_DESCRIPTIONS[comp.name] || "")}`
+    );
+  }
+}
+
+/**
+ * 显示特定 component 配置
+ */
+async function showComponentConfig(
+  componentName: string,
+  output: OutputService,
+  configService: ConfigService,
+  options: { json?: boolean; keys?: boolean; sources?: boolean }
+) {
+  const config = configService.getComponentConfig(componentName);
+  const filePath = configService.getComponentFilePath(componentName);
+
+  if (options.json) {
+    output.json({
+      name: componentName,
+      filePath,
+      config,
+    });
+    return;
+  }
+
+  output.log(chalk.bold.cyan(`# ${componentName} Component Configuration`));
+  output.log("");
+
+  // File Path
+  if (filePath) {
+    output.log(chalk.bold("File:"));
+    output.log(`  ${chalk.cyan(filePath)}`);
+    output.log("");
+  }
+
+  // Config Keys
+  if (!options.sources) {
+    output.log(chalk.bold("Configuration:"));
+    if (Object.keys(config).length === 0) {
+      output.log(`  ${chalk.gray("（无配置）")}`);
+    } else {
+      const flatConfig = flattenConfig(config);
+      for (const [key, value] of flatConfig) {
+        const displayValue = formatValue(value);
+        output.log(`  ${chalk.cyan(key + ":")} ${displayValue}`);
+      }
+    }
+    output.log("");
+  }
+}
+
+/**
+ * 扁平化配置对象
+ */
+function flattenConfig(
+  obj: unknown,
+  prefix = ""
+): Array<[string, unknown]> {
+  const result: Array<[string, unknown]> = [];
+
+  if (typeof obj !== "object" || obj === null) {
+    if (prefix) {
+      result.push([prefix, obj]);
+    }
+    return result;
+  }
+
+  for (const [key, value] of Object.entries(obj)) {
+    const fullKey = prefix ? `${prefix}.${key}` : key;
+    if (typeof value === "object" && value !== null && !Array.isArray(value)) {
+      result.push(...flattenConfig(value, fullKey));
+    } else {
+      result.push([fullKey, value]);
+    }
+  }
+
+  return result;
+}
+
+/**
+ * 格式化值显示
+ */
+function formatValue(value: unknown): string {
+  if (value === undefined) {
+    return chalk.gray("undefined");
+  }
+  if (value === null) {
+    return chalk.gray("null");
+  }
+  if (typeof value === "object") {
+    return chalk.gray(JSON.stringify(value));
+  }
+  return String(value);
+}

package/src/commands/config/roy-config-e2e.test.ts

@@ -0,0 +1,297 @@
+/**
+ * @fileoverview roy config 命令端到端测试
+ * 
+ * 验证 roy config export 能正确导出 config.jsonc 中各 component 的配置（包括默认值）
+ * 
+ * TDD 流程：
+ * - RED: 测试应该失败（因为当前实现有问题）
+ * - GREEN: 实现最小代码让测试通过
+ */
+
+import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
+import * as fsSync from "fs";
+import * as path from "path";
+import * as os from "os";
+import { EnvironmentService } from "../../services/environment.service";
+import { OutputService } from "../../services/output.service";
+import { ConfigService } from "./config-service";
+
+describe("roy config export integration", () => {
+  let tempDir: string;
+  let configFilePath: string;
+
+  beforeEach(() => {
+    // 创建临时目录
+    tempDir = fsSync.mkdtempSync(path.join(os.tmpdir(), "roy-config-e2e-"));
+    configFilePath = path.join(tempDir, "config.jsonc");
+  });
+
+  afterEach(() => {
+    // 清理临时目录
+    if (fsSync.existsSync(tempDir)) {
+      fsSync.rmSync(tempDir, { recursive: true });
+    }
+    vi.restoreAllMocks();
+  });
+
+  describe("ConfigService.getComponentConfig should read from file source", () => {
+    it("should export llm config from file source", async () => {
+      // 创建 config.jsonc 文件，包含 llm 配置
+      const configContent = `{
+  // LLM 配置
+  "llm": {
+    "defaultModel": "gpt-4o",
+    "defaultProvider": "openai",
+    "temperature": 0.7,
+    "providers": {
+      "openai": {
+        "apiKey": "sk-test-key",
+        "baseURL": "https://api.openai.com/v1"
+      }
+    }
+  }
+}`;
+      fsSync.writeFileSync(configFilePath, configContent, "utf-8");
+
+      // 使用 EnvironmentService 创建环境
+      const output = new OutputService();
+      const envService = new EnvironmentService(output);
+
+      try {
+        await envService.create({ 
+          configPath: configFilePath,
+          sessionStorage: { type: "memory" }  // 使用内存存储，避免污染正式数据库
+        });
+        const env = envService.getEnvironment();
+        expect(env).not.toBeNull();
+
+        const configComponent = env!.getComponent("config");
+        expect(configComponent).toBeDefined();
+
+        const configService = new ConfigService(configComponent as any, output);
+
+        // 导出 llm 配置
+        const llmConfig = configService.getComponentConfig("llm");
+
+        // 验证配置已正确读取
+        expect(llmConfig.defaultModel).toBe("gpt-4o");
+        expect(llmConfig.defaultProvider).toBe("openai");
+        expect(llmConfig.temperature).toBe(0.7);
+        expect(llmConfig.providers).toBeDefined();
+        expect(llmConfig.providers.openai.apiKey).toBe("sk-test-key");
+      } finally {
+        await envService.dispose();
+      }
+    });
+
+    it("should export agent config from file source", async () => {
+      // 创建 config.jsonc 文件，包含 agent 配置
+      const configContent = `{
+  // Agent 配置
+  "agent": {
+    "maxIterations": 100,
+    "maxErrorRetries": 3,
+    "doomLoopThreshold": 5
+  }
+}`;
+      fsSync.writeFileSync(configFilePath, configContent, "utf-8");
+
+      const output = new OutputService();
+      const envService = new EnvironmentService(output);
+
+      try {
+        await envService.create({ 
+          configPath: configFilePath,
+          sessionStorage: { type: "memory" }  // 使用内存存储，避免污染正式数据库
+        });
+        const env = envService.getEnvironment();
+
+        const configComponent = env!.getComponent("config");
+        const configService = new ConfigService(configComponent as any, output);
+
+        // 导出 agent 配置
+        const agentConfig = configService.getComponentConfig("agent");
+
+        // 验证配置已正确读取
+        expect(agentConfig.maxIterations).toBe(100);
+        expect(agentConfig.maxErrorRetries).toBe(3);
+        expect(agentConfig.doomLoopThreshold).toBe(5);
+      } finally {
+        await envService.dispose();
+      }
+    });
+
+    it("should export multiple components from the same config file", async () => {
+      // 创建 config.jsonc 文件，包含多个 component 配置
+      const configContent = `{
+  // LLM 配置
+  "llm": {
+    "defaultModel": "claude-3-sonnet",
+    "defaultProvider": "anthropic"
+  },
+  // Agent 配置
+  "agent": {
+    "maxIterations": 50
+  },
+  // Tool 配置
+  "tool": {
+    "timeout": 30000
+  }
+}`;
+      fsSync.writeFileSync(configFilePath, configContent, "utf-8");
+
+      const output = new OutputService();
+      const envService = new EnvironmentService(output);
+
+      try {
+        await envService.create({ 
+          configPath: configFilePath,
+          sessionStorage: { type: "memory" }  // 使用内存存储，避免污染正式数据库
+        });
+        const env = envService.getEnvironment();
+
+        const configComponent = env!.getComponent("config");
+        const configService = new ConfigService(configComponent as any, output);
+
+        // 导出各个 component 配置
+        const llmConfig = configService.getComponentConfig("llm");
+        const agentConfig = configService.getComponentConfig("agent");
+        const toolConfig = configService.getComponentConfig("tool");
+
+        // 验证配置
+        expect(llmConfig.defaultModel).toBe("claude-3-sonnet");
+        expect(llmConfig.defaultProvider).toBe("anthropic");
+        expect(agentConfig.maxIterations).toBe(50);
+        expect(toolConfig.timeout).toBe(30000);
+      } finally {
+        await envService.dispose();
+      }
+    });
+
+    it("should export default values when config file only has partial settings", async () => {
+      // 创建 config.jsonc 文件，只包含部分配置
+      const configContent = `{
+  // 只有 llm 配置
+  "llm": {
+    "defaultModel": "gpt-4o"
+  }
+}`;
+      fsSync.writeFileSync(configFilePath, configContent, "utf-8");
+
+      const output = new OutputService();
+      const envService = new EnvironmentService(output);
+
+      try {
+        await envService.create({ 
+          configPath: configFilePath,
+          sessionStorage: { type: "memory" }  // 使用内存存储，避免污染正式数据库
+        });
+        const env = envService.getEnvironment();
+
+        const configComponent = env!.getComponent("config");
+        const configService = new ConfigService(configComponent as any, output);
+
+        // 获取 agent 配置（未在文件中设置）
+        const agentConfig = configService.getComponentConfig("agent");
+
+        // 应该有默认值（即使没有在文件中设置）
+        // 注意：这取决于各 component 是否有注册默认值
+        expect(agentConfig).toBeDefined();
+        // maxIterations 应该有默认值（从 component 注册的 defaults）
+        // 如果当前实现没有默认值，至少应该是空对象而不是 undefined
+        expect(typeof agentConfig).toBe("object");
+      } finally {
+        await envService.dispose();
+      }
+    });
+
+    it("should handle JSONC format with comments", async () => {
+      // 创建带注释的 JSONC 文件
+      const configContent = `{
+  // LLM 配置
+  "llm": {
+    // 模型设置
+    "defaultModel": "gpt-4-turbo",  // inline comment
+    "temperature": 0.5
+  },
+  // Agent 配置
+  "agent": {
+    "maxIterations": 200
+  }
+}`;
+      fsSync.writeFileSync(configFilePath, configContent, "utf-8");
+
+      const output = new OutputService();
+      const envService = new EnvironmentService(output);
+
+      try {
+        await envService.create({ 
+          configPath: configFilePath,
+          sessionStorage: { type: "memory" }  // 使用内存存储，避免污染正式数据库
+        });
+        const env = envService.getEnvironment();
+
+        const configComponent = env!.getComponent("config");
+        const configService = new ConfigService(configComponent as any, output);
+
+        // 验证 JSONC 注释被正确解析
+        const llmConfig = configService.getComponentConfig("llm");
+        expect(llmConfig.defaultModel).toBe("gpt-4-turbo");
+        expect(llmConfig.temperature).toBe(0.5);
+
+        const agentConfig = configService.getComponentConfig("agent");
+        expect(agentConfig.maxIterations).toBe(200);
+      } finally {
+        await envService.dispose();
+      }
+    });
+
+    it("should export to file correctly with all components", async () => {
+      // 创建包含完整配置的 config.jsonc
+      const configContent = `{
+  "llm": {
+    "defaultModel": "gpt-4o",
+    "defaultProvider": "openai"
+  },
+  "agent": {
+    "maxIterations": 100
+  }
+}`;
+      fsSync.writeFileSync(configFilePath, configContent, "utf-8");
+
+      const output = new OutputService();
+      const envService = new EnvironmentService(output);
+
+      const exportFilePath = path.join(tempDir, "exported-config.json");
+
+      try {
+        await envService.create({ 
+          configPath: configFilePath,
+          sessionStorage: { type: "memory" }  // 使用内存存储，避免污染正式数据库
+        });
+        const env = envService.getEnvironment();
+
+        const configComponent = env!.getComponent("config");
+        const configService = new ConfigService(configComponent as any, output);
+
+        // 导出 llm 配置到文件
+        await configService.exportToFile("llm", { filePath: exportFilePath });
+
+        // 读取导出的文件
+        const exportedContent = fsSync.readFileSync(exportFilePath, "utf-8");
+        const exportedData = JSON.parse(exportedContent);
+
+        // 验证导出内容
+        expect(exportedData.llm).toBeDefined();
+        expect(exportedData.llm.defaultModel).toBe("gpt-4o");
+        expect(exportedData.llm.defaultProvider).toBe("openai");
+      } finally {
+        await envService.dispose();
+        // 清理导出文件
+        if (fsSync.existsSync(exportFilePath)) {
+          fsSync.unlinkSync(exportFilePath);
+        }
+      }
+    });
+  });
+});

package/src/commands/config/types.ts

@@ -0,0 +1,54 @@
+/**
+ * @fileoverview config 子命令类型定义
+ */
+
+/**
+ * 所有支持的 Components 列表
+ */
+export const SUPPORTED_COMPONENTS = [
+  'tool',
+  'task',
+  'memory',
+  'session',
+  'skill',
+  'commands',
+  'eventsource',
+  'mcp',
+  'agent',
+  'log-trace',
+  'lsp',
+] as const;
+
+export type SupportedComponent = typeof SUPPORTED_COMPONENTS[number];
+
+/**
+ * Component 别名映射（用户输入 -> 内部名称）
+ */
+export const COMPONENT_ALIASES: Record<string, string> = {
+  session: 'session',
+  sessions: 'session',
+};
+
+/**
+ * 获取组件的内部名称（处理别名）
+ */
+export function resolveComponentName(name: string): string {
+  return COMPONENT_ALIASES[name] ?? name;
+}
+
+/**
+ * Component 描述映射
+ */
+export const COMPONENT_DESCRIPTIONS: Record<string, string> = {
+  tool: 'Tool Component - 工具管理',
+  task: 'Task Component - 任务管理',
+  memory: 'Memory Component - 记忆管理',
+  session: 'Session Component - 会话管理',
+  skill: 'Skill Component - 技能管理',
+  commands: 'Commands Component - 命令管理',
+  eventsource: 'EventSource Component - 事件源管理',
+  mcp: 'MCP Component - MCP 服务器管理',
+  agent: 'Agent Component - Agent 配置和循环控制',
+  'log-trace': 'LogTrace Component - 日志和追踪管理',
+  lsp: 'LSP Component - 语言服务器协议管理',
+};

package/src/commands/debug/index.ts

@@ -0,0 +1,38 @@
+/**
+ * @fileoverview Debug Commands Entry
+ * 
+ * Command: roy debug [log|trace|span]
+ * 
+ * 提供调试能力：
+ * - log: 查看日志文件（支持 --tail -n）
+ * - trace: 以 tree 方式查看 trace 的 spans
+ * - span: 通过 spanId 查询详细的 span 信息
+ */
+
+import type { CommandModule } from "yargs";
+import { LogCommand } from "./log";
+import { TraceCommand } from "./trace";
+import { SpanCommand } from "./span";
+
+/**
+ * Debug Command
+ */
+export const DebugCommand: CommandModule = {
+  command: "debug",
+  describe: "调试工具 - 日志查看、trace 分析、span 查询",
+  builder: (yargs) =>
+    yargs
+      .command(LogCommand)
+      .command(TraceCommand)
+      .command(SpanCommand)
+      .demandCommand()
+      .help(),
+  handler: () => {
+    // Default handler - will show help
+  },
+};
+
+// Export subcommands for testing
+export { LogCommand } from "./log";
+export { TraceCommand } from "./trace";
+export { SpanCommand } from "./span";