ChatBuddy/opencode.json at main · Zheng404/ChatBuddy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
{
  "$schema": "https://opencode.ai/config.json",

  // 用户标识（显示在对话中）
  "username": "Zheng404",

  // 默认模型：取消注释并替换为你实际使用的 provider/model
  // 常见可选值：anthropic/claude-sonnet-4-6、openai/gpt-4o、openai/gpt-4o-mini 等
  // "model": "anthropic/claude-sonnet-4-6",
  // "small_model": "anthropic/claude-sonnet-4",

  "default_agent": "build",
  "shell": "/bin/zsh",
  "logLevel": "INFO",
  "share": "manual",
  "autoupdate": "notify",
  "snapshot": true,

  // 项目级指令文件
  "instructions": [
    "AGENTS.md"
  ],

  // 参考资料（@ 引用）
  "references": {
    "readme": "README.md",
    "readme-zh": "README_zh-CN.md",
    "architecture": {
      "path": "docs/ARCHITECTURE.md",
      "description": "ChatBuddy 架构文档，用于理解分层设计"
    },
    "development": {
      "path": "docs/DEVELOPMENT.md",
      "description": "本地开发与调试指南"
    },
    "storage": {
      "path": "docs/STORAGE.md",
      "description": "Compass 存储层实现细节"
    },
    "webview": {
      "path": "docs/WEBVIEW_PROTOCOL.md",
      "description": "WebView 通信协议"
    }
  },

  // 技能搜索路径
  "skills": {
    "paths": [".opencode/skills"]
  },

  // 自定义 Agent
  "agent": {
    "chatbuddy": {
      "description": "ChatBuddy 代码库专家，熟悉 VS Code 扩展、WebView、Compass 存储和 MCP",
      "mode": "subagent",
      "prompt": "你是 ChatBuddy 项目的代码库专家。你熟悉以下技术栈与约束：\n- TypeScript 5.x + Node16/ESM\n- VS Code Extension API（WebView、TreeView、命令、上下文菜单）\n- 分层架构：extension/ 适配层与 chatbuddy/ 业务核心层解耦\n- Compass 结构化存储（JSON + JSONL，原子写入）\n- MCP 运行时（@modelcontextprotocol/client，ESM-only 动态导入）\n- 国际化（i18n/ 中英双语）\n- Zod 运行时校验与 Node 原生测试运行器\n\n回答或实施变更时，优先引用 docs/ 下的架构文档，遵循项目中已有的命名规范、严格 TypeScript 模式和 AGENTS.md 中的工程原则（SOLID、KISS、DRY、YAGNI）。对任何可能破坏 VS Code 扩展启动、WebView CSP 或存储原子性的修改保持谨慎。",
      "permission": {
        "edit": "allow",
        "bash": "ask"
      }
    }
  },

  // 自定义命令
  "command": {
    "build": {
      "template": "运行 npm run compile，报告 TypeScript 编译错误，不要自动修复",
      "description": "编译扩展"
    },
    "test": {
      "template": "运行 npm run test:unit，总结失败的测试用例并指出可能原因",
      "description": "运行单元测试"
    },
    "lint": {
      "template": "运行 npm run lint，仅报告问题，不要自动修改文件",
      "description": "代码静态检查"
    },
    "check": {
      "template": "依次运行 npm run lint、npm run compile、npm run test:unit 和 npm run check:changelog，输出完整结果摘要",
      "description": "发布前完整检查"
    },
    "package": {
      "template": "运行 npm run package 构建 .vsix 包",
      "description": "打包扩展"
    }
  },

  // Provider 与 MCP 服务器统一在全局 ~/.config/opencode/opencode.json 中配置
  // 项目级配置仅保留项目专属内容，避免 API Key 或本地服务器路径泄漏到仓库

  // 权限策略
  "permission": {
    "read": "allow",
    "edit": "allow",
    "glob": "allow",
    "grep": "allow",
    "list": "allow",
    "bash": {
      "git commit*": "ask",
      "git push*": "ask",
      "git reset*": "ask",
      "rm *": "ask",
      "npm run *": "allow",
      "npm test*": "allow",
      "npx *": "ask",
      "*": "ask"
    },
    "task": "allow",
    "external_directory": {
      "*": "ask"
    },
    "todowrite": "allow",
    "question": "allow",
    "webfetch": "allow",
    "websearch": "allow",
    "lsp": "allow",
    "skill": "allow",
    "doom_loop": "ask"
  },

  // 格式化与 LSP
  "formatter": true,
  "lsp": true,

  // 工具输出截断阈值
  "tool_output": {
    "max_lines": 200,
    "max_bytes": 8192
  },

  // 上下文压缩
  "compaction": {
    "auto": true,
    "tail_turns": 15
  },

  // 实验性功能
  "experimental": {
    "mcp_timeout": 30000,
    "batch_tool": true
  }
}