CodeBuddy 团队代码风格统一可通过五种方法实现:一、配置项目级 Rules 规则文件;二、上传私有知识库文档;三、启用 Hooks 拦截修正;四、CLI 参数注入系统提示词;五、导入已有配置文件自动适配。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如果您正在使用 CodeBuddy 辅助团队协作开发,但发现不同成员触发的 AI 生成代码在命名、缩进、注释、语法选择等方面不一致,则可能是由于 AI 缺乏统一的行为约束机制。以下是让 CodeBuddy 在团队协作中严格遵循统一代码风格的具体方法:
一、配置项目级 Rules 规则文件
项目级 Rules 是强制性风格约束的核心载体,AI 在当前项目上下文中会优先读取并执行该规则,覆盖个人设置与通用模板。该方式适用于所有成员共享同一套硬性规范的场景。
1、在项目根目录创建 .codebuddy/rules 文件夹(若不存在则手动新建)。
2、在该文件夹内新建一个 style.md 文件,使用自然语言书写明确指令。
3、在文件中写入具体规范,例如:变量名必须使用 camelCase;常量全大写加下划线;所有函数必须包含 JSDoc 注释;禁止使用 var 声明变量;SQL 查询语句必须参数化。
4、保存后,在 CodeBuddy 主界面左侧「规则管理」中确认该项目规则已识别并处于「开启生效」状态。
二、上传团队私有知识库文档
私有知识库用于承载非结构化但具有强业务约束力的规范内容,如数十页的《前端编码手册》《安全开发白皮书》或《内部组件调用指南》,AI 在生成时将主动检索并匹配其中的隐式要求。
1、进入企业版管控台,点击「知识库管理」→「新建知识库」。
2、为知识库命名(如“金融事业部_编码规范_v2.3”),选择「团队可见」权限。
3、上传 PDF/DOCX/MD 格式的规范文档,系统自动完成向量化索引。
4、索引完成后,AI 在生成涉及日期筛选表单的代码时,将自动调用公司自研的 daterangepicker 组件而非通用实现。
三、启用 Hooks 实现全流程风格拦截与修正
CodeBuddy Hooks 可在 AI 执行关键操作节点插入脚本,实现事前拦截、事中修正、事后校验,确保风格一致性贯穿整个开发链路。
1、在项目根目录创建 .codebuddy/hooks 文件夹。
2、新建 pre-tool-use.js,编写逻辑:当 AI 尝试生成含 var 的代码时,立即阻止并提示“违反项目规则:禁止使用 var”。
3、新建 post-tool-use.js,调用 Prettier API 对 AI 输出自动格式化,强制应用 2 空格缩进 + 单引号 + 结尾分号。
4、重启 CodeBuddy 插件,触发任意补全操作,观察控制台是否显示 Hook 执行日志。
四、通过 CLI 参数注入系统级风格指令
在命令行启动 CodeBuddy 时追加系统提示词,可全局覆盖模型默认行为,适用于 CI/CD 环境或远程开发容器等无图形界面场景。
1、在终端中执行:codebuddy --append-system-prompt "始终使用 TypeScript 编写,所有接口必须定义类型,函数需带完整 JSDoc"。
2、验证是否生效:在终端中输入 /new-function handleUserLogin,检查输出是否含 interface UserInput 与三段式 JSDoc。
3、将该命令固化为团队统一的启动脚本 start-codebuddy.sh,纳入项目 README 的开发环境说明章节。
五、导入项目已有配置文件实现零配置适配
CodeBuddy 能自动解析项目中已存在的工程配置文件,从中提取缩进宽度、分号偏好、命名前缀等参数,无需人工编写规则即可实现风格对齐。
1、确认项目根目录存在 .editorconfig 或 .eslintrc.js 文件。
2、打开任意 .ts 文件,在光标处输入 const api 后按 Tab 触发补全。
3、观察补全建议中是否自动采用 apiUrl(而非 apiUrl 或 API_URL),该命名方式由已检测到的 .editorconfig 中 naming_convention = camelCase 驱动。











