Rules 规则功能
Rule(规则)用于设置 AI 的编码风格和项目规范,让 AI 按照你设定的规则工作。
什么是 Rule?
Section titled “什么是 Rule?”Rule 是一组指令,用于告诉 AI:
- 📝 代码风格 — 使用什么样的编码规范
- 🚫 禁止事项 — 哪些操作是不允许的
- ✅ 最佳实践 — 哪些做法是推荐的
/rule然后在列表中选择你想要的规则。
规则文件位置
Section titled “规则文件位置”| 级别 | 位置 |
|---|---|
| 用户级 | ~/.carry/rules/ |
| 项目级 | <项目目录>/.carry/rules/ |
规则文件格式
Section titled “规则文件格式”# 项目规则
## 代码风格- 使用 2 空格缩进- 使用 TypeScript,避免 any 类型- 函数必须有注释
## 命名规范- 变量使用 camelCase- 常量使用 UPPER_SNAKE_CASE- 类名使用 PascalCase
## 禁止事项- 不要修改 config 目录下的文件- 不要使用 eval()- 不要提交敏感信息
## 最佳实践- 优先使用 const- 错误必须捕获处理- API 接口要有类型定义---name: my-project-ruledescription: 我的项目规则version: 1.0---
# 规则内容...AGENTS.md 项目专属规则
Section titled “AGENTS.md 项目专属规则”在项目根目录创建 AGENTS.md 文件,可以为该项目设置专属规则。
为什么使用 AGENTS.md?
Section titled “为什么使用 AGENTS.md?”- 📁 项目级配置 — 每个项目可以有不同规则
- 🤖 团队共享 — 团队成员自动使用相同规范
- 🔄 版本控制 - 规则可以提交到 Git
创建 AGENTS.md
Section titled “创建 AGENTS.md”在项目根目录创建文件:
# 项目规则
## 代码风格- 使用 2 空格缩进- 使用 TypeScript- 函数必须有 JSDoc 注释
## 禁止事项- 不要修改 node_modules- 不要删除测试文件- 不要提交 .env 文件
## Git 提交规范- 使用 Conventional Commits 格式- 提交前必须运行测试AI 如何使用 AGENTS.md
Section titled “AI 如何使用 AGENTS.md”当你让 AI 帮你修改代码时,它会自动:
- 读取项目根目录的
AGENTS.md - 理解其中的规则
- 按照规则生成代码
Carry Code 提供了一些内置规则:
| 规则名称 | 说明 |
|---|---|
default | 默认规则 |
strict | 严格模式 |
relaxed | 宽松模式 |
Carry Code 会按照以下优先级应用规则:
- AGENTS.md(项目根目录)
- 项目级规则(
.carry/rules/) - 用户级规则(
~/.carry/rules/)
优先级从高到低,高优先级会覆盖低优先级。
示例一:设置代码风格
Section titled “示例一:设置代码风格”创建规则要求使用 4 空格缩进:
## 代码风格- 使用 4 空格缩进- 每行最多 100 字符示例二:保护关键文件
Section titled “示例二:保护关键文件”## 禁止事项- 不要修改 src/config/ 目录- 不要删除 .git 目录- 不要修改 package-lock.json示例三:强制测试
Section titled “示例三:强制测试”## 最佳实践- 所有新函数必须包含测试- 修改代码前先运行测试- 测试覆盖率不能低于 80%查看当前规则
Section titled “查看当前规则”/rule当前使用的规则会显示在界面上。
/rule <规则名称>在规则目录创建新的 .md 文件即可:
~/.carry/rules/my-rule.mdQ:AGENTS.md 和 /rule 有什么区别?
Section titled “Q:AGENTS.md 和 /rule 有什么区别?”| 特性 | AGENTS.md | /rule |
|---|---|---|
| 作用范围 | 当前项目 | 全局 |
| 创建位置 | 项目根目录 | ~/.carry/rules/ |
| 版本控制 | 随项目提交 | 本地 |
Q:规则会影响 AI 回答问题吗?
Section titled “Q:规则会影响 AI 回答问题吗?”不会。规则主要用于代码生成和修改。
Q:可以不设置规则吗?
Section titled “Q:可以不设置规则吗?”可以。不设置规则时,AI 会使用默认方式工作。