前端通用 AI Rules 定义
(适用于 Cursor、Trae、Qoder、Windsurf、Zed + AI、Codeium、Copilot 等几乎所有主流 AI 代码助手)
以下内容是 2025–2026 年在前端圈被大量验证、反复迭代后相对好用的'通用前端 Rules'模板。你可以直接复制粘贴到 Cursor 的 Rules / Custom Instructions / 项目 .cursor/rules.md 中,或者 Trae、Qoder 等工具的类似位置。
推荐的通用前端 Rules 结构(2026 年主流写法)
# 前端通用 Rules - 适用于 React / Vue / TypeScript 项目
优先使用 TypeScript(严格模式)
优先函数式 + hooks 写法,class 组件仅在极特殊场景使用
组件尽量小而纯(单一职责),单个文件不超过 300–400 行
UI 优先使用可组合、可复用的原子组件 + 组合组件模式
状态管理:能用 useState + useReducer 解决就不引入 Zustand / Jotai / Redux
样式:优先 Tailwind CSS + shadcn/ui / Radix UI / Headless UI 组合
代码风格严格遵循 ESLint + Prettier + typescript-eslint 推荐规则
永远写 JSDoc / TSDoc 注释(尤其是工具函数、hooks、复杂组件)
优先使用现代语法(可选链、nullish 合并、top-level await 等)
组件文件:PascalCase.tsx(例:UserProfileCard.tsx)
hooks 文件:camelCase.ts(例:useDebounce.ts)
工具函数:camelCase.ts(例:formatCurrency.ts)
常量:UPPERCASE 或 camelCase(看语义)
类型定义:统一放在 types/ 或同文件内以 I、T、S 前缀(视团队习惯)
测试文件:同名 + .test.tsx / .spec.tsx
Storybook 文件:同名 + .stories.tsx
所有组件必须导出类型 Props(interface 或 type)
优先使用解构 + 默认值写法
必须显式声明 children?: ReactNode
动态 className 使用 clsx 或 cva(class-variance-authority)
禁止在组件内部写业务逻辑超过 30 行 → 抽离到 hooks / utils
所有副作用必须放在 useEffect 中,并写清楚依赖数组
自定义 hooks 命名必须以 use 开头
禁止在 render 阶段产生副作用(setState、dispatch 等)

