|
作者:微信文章
❝
在体验到 AI 编程的强大能力后,你是否想拥有专属的 AI 工程师,让 AI 按照你的想法工作?现在,Trae IDE 已支持配置 AI 规则(Trae Rules),让 AI 按照你的需求执行定制化任务!
一、什么是 Rules
Rules 是一项强大的代码规范管理工具,它允许团队或开发者自定义并强制执行代码风格和最佳实践。
Rules 基于一个很常见的场景:当你频繁使用 AI 时,可能会遇到反复输入同类指令的麻烦 —— 比如每次都要强调语言风格、框架约束、注释格式、安全合规等要求。而 Rules 功能为 AI 提前设定了行为规范,让 AI 每次响应时自动 “读取” 这些预设规则,无需重复提醒也能输出符合预期的内容。同时,不同开发场景时,对应的 Rules 可以让 AI 精准适配当前任务的技术要求,大幅提升开发效率。
二、 使用说明
在更新至 0.5.1 及以上的版本后, Trae IDE 支持两种类型的规则:
01 个人规则
个人规则是基于个人使用习惯和需求为 AI 定制的规则,旨在让 AI 的输出更符合用户的个性化要求。个人规则在所有项目中生效。例如:
语言风格:偏好简洁/严谨/幽默等表达方式。
操作系统:提供针对 Windows 或 macOS 操作系统的回答。
内容深度:是否需要详细解释、示例或仅需结论。
交互方式:如倾向于直接答案,还是引导式提问。
02 项目规则
项目规则是针对当前项目 AI 需要遵循的规则,仅在所配置的项目中生效。例如:
代码风格:缩进(空格/制表符)、命名规范(驼峰式/snake_case)等。
语言与框架:优先使用的编程语言(如 Python/JavaScript)或框架(如 React/Django)。
API 限定:勿使用某些 API。
接下来,小编将分别演示如何设定 AI 规则:
创建个人规则
在 AI 对话窗口右上角,点击设置图标 > 规则。
界面上显示规则窗口。
2. 在 个人规则 部分,点击+ 创建 user_rules.md 按钮。
系统自动创建 user_rules.md 文件并在编辑器中打开。
3. 在 user_rules.md 文件中输入 AI 需要遵守的规则。
4. 保存文件,规则将被应用于所有项目的 AI 行为。
创建项目规则1. 打开一个项目。2. 在 AI 对话窗口右上角,点击设置图标 > 规则。
界面上显示规则窗口。
在 项目规则区域,点击 + 创建 project_rules.md 按钮。
系统自动在项目目录中创建创建 .trae/rules 文件夹,并在该文件夹内创建 project_rules.md 文件。
3. 在 project_rules.md 文件中输入 AI 需要遵守的规则。
4. 保存文件,规则将被应用于当前项目的 AI 行为中。
管理规则
在 规则 窗口中,你可以修改个人规则和项目规则,也可以删除规则文件。
修改规则后,AI 将遵守新的规则。
删除规则文件后,原先定义的所有规则将失效。
三、 实战演示
接下来,小编将通过一个实战案例为你演示如何使用 Rules 来提升开发效率。
假设我们想要使用 Chakra 来优化 CSS,可以通过以下提示词配置 项目规则和个人规则。
项目规则
你是一位精通 React 和 Chakra UI 的前端开发专家。
## 核心原则
- 编写清晰、简洁且技术性强的回答,并提供精确的 Chakra UI 示例。
- 利用 Chakra UI 的组件和工具类来提升开发效率并确保响应式设计
- 注重代码的可维护性和可读性,始终道循简洁规范的 HTML 与 CSS 编码实践。
- 使用具有描述性的类名和结构,提升代码清晰度,方便团队协作。
## Chakra 使用规范
- 通过 Chakra UI 实现合理的组件组合结构
- 使用 Chakra UI 内置的无障碍功能
- 使用 'as' 属性渲染语义化 HTML 标签
- 利用 Chakra UI 的颜色模式实现暗黑模式
- 使用 Chakra UI 的布局组件实现响应式设计
- 遵循 Chakra UI 最佳实践以优化性能
- 在应用的根组件使用 ChakraProvider
- 使用 Chakra UI 组件以保持设计一致性
- 实现自定义主题以适配品牌样式
- 使用 Chakra UI 的断点系统实现响应式样式
- 使用 Chakra UI 的 Hooks 提升功能性
个人规则
1. 请始终保持对话语言为中文
2. 请在生成或编辑代码时补充详细的注释
3. 在回答用户问题时,请详细解释每一步改动的原因
在完成设定后,使用 @Builder 对项目进行整体优化:
“请使用 Chakra 框架对本项目中的所有页面进行 CSS 改造”
可以看到,Builder 已经按照我们设定的项目规则完成了优化改造。
四、 应用场景
Rules 功能可以在各种开发场景中发挥作用,帮助团队和个人保持代码一致性、提高可维护性,并减少低级错误。小编精选了 Rules 功能的五大应用场景,总有一个适合你~
场景一 :团队协作与代码审查
✅ 效果:统一代码风格,减少审查争论
新加入的开发者可能不熟悉团队的代码风格,导致提交的代码风格不一致。通过设定 Rules 可以实现检查变量名、强制使用团队代码架构、修正不合规代码。同时,Rules 还可以帮助团队成员代码格式化、禁止错误写法并强制注释规范等。
场景二:项目维护与代码质量
✅ 效果:检测代码错误,提高可维护性
一方面,针对遗留代码风格混乱难以维护的问题,通过逐步引入规则,配合 AI 对话指令可完成修复,并标记不符合新规范的代码以便后续重构;另一方面,为防止代码中出现低级错误,通过强制 await 用 try - catch 包裹、检测未使用的 import 或变量、禁止使用 == 并强制使用 === 等规则,减少潜在问题,提升代码的规范性与可维护性。
场景三:特定技术栈优化
✅ 效果:强化 React/Vue/Node 最佳实践
前端项目中,组件写法不一致,导致维护困难。 通过设定 Rules,可以强制函数式组件(禁止 class 组件) 、要求 props 必须做类型检查(TypeScript/PropTypes) 以及强制 useEffect 依赖项必须完整 。针对 API 接口风格不统一的问题,Rules 可以强制 REST API 路径格式,要求错误处理必须标准化,并禁止 console.log,强制使用日志库。
场景四:安全与合规性
✅ 效果:防止漏洞,满足行业规范
在安全与合规上,针对代码可能存在的 SQL 注入、XSS 等安全隐患,Rules 可以通过禁止直接拼接 SQL(强制使用参数化查询)、检测未转义的 HTML 输出(防止 XSS)以及禁止使用 eval() 或 new Function() 等方式,有效防范安全漏洞;同时,针对部分行业的特殊合规要求,Rules 可检测敏感信息、强制加密存储密码并确保日志不记录个人身份信息,从而满足合规性检查的需求,保障代码在安全与合规层面的可靠性。
场景五:个人开发习惯优化
✅ 效果:保持一致性,学习新语言更高效
如果开发者希望保持一致的代码风格,可以通过设定 Rules 来实现。在初学 Rust/Go/Python 时,开发者容易写出不符合语言习惯的代码,通过设定 Rules ,强制 Rust 的 Result 处理(禁止直接 unwrap()) 、强制 Go 的错误处理(禁止忽略 err) 和Python 强制类型注解(mypy 兼容规则)可以帮助开发者很好地改善这一问题。
❝
通过设定 Rules, AI 会更精准地适配你的开发习惯,更贴心地融入你的工作流,真正做到「协作无间」。点击阅读原文,直达下载链接,即刻体验!
|
本帖子中包含更多资源
您需要 登录 才可以下载或查看,没有账号?注册
x
|