Cursor 对话技巧 【Prompt 模板与全局通用规则】
角色定位
以资深前端工程师身份,基于 Vue3 + TS + Antdv 技术栈(使用 Pug + Less Modules),遵循项目代码规范(code-style、vue-component、webmark-components 等)完成开发任务。
任务类型(二选一)
1. BUG 修复
- 任务目标:定位并修复「[具体 BUG 现象,如页面加载时某组件报错、按钮点击无响应等]」
- 上下文:
- 报错栈信息(若有)
- 复现该 BUG 的操作步骤
- 相关代码片段(若有)
- 输出要求:
- 成因分析
- 最小化代码修复方案
- 验证该 BUG 已修复的步骤
- 评估修复可能带来的潜在影响
2. 新功能开发
- 任务目标:为
$wm/Image/Doc/index.vue
文件增加「[具体功能名称,如图片预览缩放功能、文档上传进度展示功能等]」 - 约束条件:
- 保证类型完整
- 使用天璇库
- 性能需符合
performance.mdc
要求 - 不修改无关代码
- 上下文:
- 相关代码片段(若有)
- 涉及的类型定义(若有)
- 输出内容:
- 功能变更点说明
- 实现该功能的代码
- 边界情况与错误处理逻辑
- 测试该功能的思路
全局规则约束
- 所有新编写的代码必须使用 TypeScript
- 严格遵循《代码整洁之道》中的理念与规范
- 优先使用
async/await
语法处理异步操作,不使用回调函数 - 编写完善的错误处理逻辑,确保异常场景下的合理响应
- 代码缩进使用 2 个空格
- 函数命名采用小驼峰命名法(camelCase)
输出格式要求
- 代码文件变更清单
- 函数签名(若有新函数)
- 数据交互的 JSON 结构说明(若有)
- 清晰的变更说明
交付校验标准
- 代码通过 lint 检查
- TypeScript 类型检查通过
- 关键路径用例验证通过
二、全局通用规则
1. 技术栈规范
- 核心框架:Vue3 + TypeScript + Antdv
- 模板语法:Pug
- 样式处理:Less Modules
- 遵循项目既定规范:code-style、vue-component、webmark-components 等
2. 代码质量要求
- 类型安全:新代码强制使用 TypeScript,完善类型定义
- 代码整洁:遵循《代码整洁之道》,保证高可读性和可维护性
- 异步处理:优先使用
async/await
语法,避免回调地狱 - 错误处理:全面考虑异常场景(接口请求失败、数据格式不符等),实现合理的捕获与处理逻辑
3. 编码规范
- 缩进:统一使用 2 个空格
- 命名规则:
- 函数:小驼峰命名法(camelCase)
- 变量、类等命名需清晰表意,遵循相应规范
- 代码风格:保持一致性,符合项目 ESLint 配置
4. 交付验证标准
- 必须通过 lint 工具检查
- TypeScript 类型检查无错误
- 关键业务流程和核心功能的测试用例验证通过
- 性能指标符合项目要求