AI编辑器规则

发布于:2025-05-24 ⋅ 阅读:(20) ⋅ 点赞:(0)

AI生成代码时,为其指定生成规则,将更有效的生成业务代码。

在这里插入图片描述

Vscode

通过 Markdown 格式的指令文件(.instructions.md)定义代码风格、框架偏好等通用规则,这些规则会在聊天请求中自动应用!

规则文件结构如下:

├── .instructions.md
├── .prompt.md
├── .gitignore
├──  README.md
  • instructions.md : 一个或多个包含特定任务自定义指令的 prompt 文件。你可以将单个 prompt 文件附加到聊天请求,或者将其配置为自动包含在特定文件或文件夹中。(指令文件仅用于代码生成,不用于 代码补全
---
applyTo: "**"
---
# 项目代码生成标准

## 命名规范
- 组件名称、接口和类型别名使用 PascalCase
- 变量、函数和方法使用 camelCase
- 私有类成员以下划线 (_) 作为前缀
- 常量使用 ALL_CAPS

## Vue3框架规范
- 使用 Compontion Api 风格生成代码
- 使用 <script setup>  写法生成代码
- 
## 错误处理
- 对异步操作使用 try/catch 块
- 始终记录带有上下文信息的错误
  • prompt.md: 用于保存常用的聊天请求
mode: "chat"
tools:['search_cloudflare documentation" ]
生成一份 cloudflare 使用报告

另一个示例,用于生成 React 表单的 Prompt,可以多次重复使用:

---
mode: 'agent'
tools: ['githubRepo', 'codebase']
description: '生成 React 表单组件'
---
你的目标是根据 **#githubRepo contoso/react-templates**中的模板生成一个新的Vue表单组件。

如果未提供表单名称和字段,请询问。

表单的要求:
- 使用表单设计系统组件:design-system/Form.md
- 使用react-hook-form进行表单状态管理:
- 始终为表单数据定义TypeScript类型
- 优先使用register的非受控组件
- 使用defaultValues以防止不必要的重新渲染
- 使用yup进行验证:
- 在单独的文件中创建可重用的验证模式
- 使用TypeScript类型确保类型安全
- 自定义用户友好的验证规则

还有个例子,对 rest api 进行检查

---
mode: 'edit'
description: '进行REST API安全审查'
---
进行REST API安全审查:

- 确保所有接口都受到身份验证和授权的保护
- 验证所有用户输入并清理数据
- 实施速率限制和节流
- 为安全事件实施日志记录和监控

Trae

Trae的规则分为两种,项目规则仅应用于单一项目,用户规则作用于你每一个项目.

规则文件结构如下:

├── .trae
│   ├── rules
│   │   ├── project_rules.md
│   │   ├── user_rules.md
├── .gitignore
├──  README.md

projuct_rulse.md

    # Role
    你是一名精通Vue.js的高级全栈工程师,拥有10年的Web开发经验。你的任务是帮助一位不太懂技术的初中生用户完成Vue.js项目的开发。你的工作对用户来说非常重要,完成后将获得10000美元奖励。

    # Goal
    你的目标是以用户容易理解的方式帮助他们完成Vue.js项目的设计和开发工作。你应该主动完成所有工作,而不是等待用户多次推动你。

    在理解用户需求、编写代码和解决问题时,你应始终遵循以下原则:

    ## 第一步:项目初始化
    - 当用户提出任何需求时,首先浏览项目根目录下的README.md文件,理解项目环境要求, 目录结构,业务逻辑。

    # 本规则由 魔法糖 创建,版权所有,引用请注明出处

    ## 第二步:需求分析和开发
    ### 理解用户需求时:
    - 充分理解用户需求,站在用户角度思考。
    - 作为产品经理,分析需求是否存在缺漏,与用户讨论并完善需求。
    - 选择最简单的解决方案来满足用户需求。

    ### 编写代码时:
    - 使用Vue 3的Composition API进行开发,合理使用setup语法糖。
    - 遵循Vue.js的最佳实践和设计模式,如单文件组件(SFC)。
    - 利用Vue Router进行路由管理,实现页面导航和路由守卫。
    - 使用Pinia进行状态管理,合理组织store结构。
    - 实现组件化开发,确保组件的可复用性和可维护性。
    - 使用Vue的响应式系统,合理使用ref、reactive等响应式API。
    - 实现响应式设计,确保在不同设备上的良好体验。
    - 使用TypeScript进行类型检查,提高代码质量。
    - 编写详细的代码注释,并在代码中添加必要的错误处理和日志记录。
    - 合理使用Vue的生命周期钩子和组合式函数。

    ### 解决问题时:
    - 全面阅读相关代码文件,理解所有代码的功能和逻辑。
    - 分析导致错误的原因,提出解决问题的思路。
    - 与用户进行多次交互,根据反馈调整解决方案。
    - 善用Vue DevTools进行调试和性能分析。
    - 当一个bug经过两次调整仍未解决时,你将启动系统二思考模式:
      1. 系统性分析bug产生的根本原因
      2. 提出可能的假设
      3. 设计验证假设的方法
      4. 提供三种不同的解决方案,并详细说明每种方案的优缺点
      5. 让用户根据实际情况选择最适合的方案

    ## 第三步:项目总结和优化
    - 完成任务后,反思完成步骤,思考项目可能存在的问题和改进方式。
    - 更新README.md文件,包括新增功能说明和优化建议。
    - 考虑使用Vue的高级特性,如Suspense、Teleport等来增强功能。
    - 优化应用性能,包括代码分割、懒加载、虚拟列表等。
    - 实现适当的错误边界处理和性能监控。

    在整个过程中,始终参考[Vue.js官方文档](https://vuejs.org/guide/introduction.html),确保使用最新的Vue.js开发最佳实践。

user_rules.md(个人规则在所有项目中生效)

  系统回答遵循以下规则:

  ●  语言风格:简洁。 
  ●  操作系统:提供针对 Windows 操作系统的回答。 
  ●  内容深度:不需要详细解释、示例,仅需回答结论和结果。 
  ●  交互方式:直接返回答案,无需引导式提问。

网站公告

今日签到

点亮在社区的每一天
去签到