Agent Rules

本仓库用于管理 Cursor IDE 的 AI 行为规则配置（Rules）。通过预定义的 .mdc 规则文件，确保 AI 助手在生成代码时遵循统一的团队规范和最佳实践。

📂 目录结构

此仓库的核心配置位于 .cursor/rules/ 目录下：

.cursor/rules/
├── common.mdc      # 通用规范 (全局生效)
├── typescript.mdc  # TypeScript 规范
├── javascript.mdc  # JavaScript 规范
├── vue.mdc         # Vue.js 规范
└── react.mdc       # React 规范

📝 规则详情

🟢 通用规范 (Common)

• 文件: common.mdc
• 适用范围: 全局所有文件 (alwaysApply: true)
• 核心内容:
  • 代码质量: 遵循 DRY (不重复) 和 KISS (保持简单) 原则。
  • 注释规范: 注释重点解释 "Why" (原因) 而非 "What"，拒绝废话注释。
  • 样式规范: 严禁行内样式，优先使用项目现有的 CSS 预处理器或 CSS Modules。
  • 错误处理: 拒绝吞没错误，提倡 Fail Fast。

🔵 TypeScript

• 文件: typescript.mdc
• 适用范围: **/*.ts, **/*.tsx
• 核心内容:
  • 强类型: 严禁使用 any，提倡显式类型定义。
  • 定义规范: 明确 Interface 和 Type 的使用场景。
  • 最佳实践: 包含空值处理和工具类型的推荐用法。

🟡 JavaScript

• 文件: javascript.mdc
• 适用范围: **/*.js, **/*.jsx, **/*.cjs, **/*.mjs
• 核心内容:
  • 现代语法: 强制使用 ES6+ 特性 (const, 箭头函数, 解构赋值)。
  • 严谨性: 始终使用全等 (===)，禁用 var。
  • 异步: 优先使用 async/await。

🟢 Vue.js

• 文件: vue.mdc
• 适用范围: **/*.vue
• 核心内容:
  • 技术栈: 强制使用 Composition API (<script setup>) 和 TypeScript。
  • 组件规范: 统一组件结构顺序 (Script -> Template -> Style)。
  • 类型定义: 规范 defineProps 和 defineEmits 的类型标注。

🔵 React

• 文件: react.mdc
• 适用范围: **/*.tsx, **/*.jsx
• 核心内容:
  • 组件形式: 全面使用函数式组件和 Hooks。
  • 性能优化: 合理使用 useMemo 和 useCallback。
  • 最佳实践: 规范 Props 定义、Hooks 依赖管理和组件命名。

🚀 使用方法

将本仓库中的 .cursor 文件夹完整复制到你的项目根目录下。Cursor 编辑器会自动检测并加载 .cursor/rules/ 中的规则文件，从而在 AI 辅助编程时应用这些规范。