前端通用 AI Rules 定义
这套通用前端 Rules 模板,是在近期工程实践中反复打磨后的结果。你可以直接将其保存为 .cursor/rules.md,或粘贴到 Trae、Qoder、Windsurf 等工具的自定义指令区域。
核心原则(永远优先遵守)
- 语言选择:优先使用 TypeScript(严格模式),避免隐式 any。
- 组件范式:优先函数式 + hooks 写法,class 组件仅在极特殊场景保留。
- 单一职责:组件尽量小而纯,单个文件控制在 300–400 行以内。
- 状态管理:能用 useState + useReducer 解决就不引入重型库。
- 样式方案:优先 Tailwind CSS + shadcn/ui / Radix UI / Headless UI 组合。
- 代码规范:严格遵循 ESLint + Prettier + typescript-eslint 推荐规则。
- 注释要求:关键工具函数、hooks、复杂组件必须写 JSDoc / TSDoc 注释。
- 语法特性:优先使用现代语法(可选链、nullish 合并、top-level await 等)。
文件与目录命名规范
- 组件文件:PascalCase.tsx(例:UserProfileCard.tsx)
- Hooks 文件:camelCase.ts(例:useDebounce.ts)
- 工具函数:camelCase.ts(例:formatCurrency.ts)
- 常量:UPPER_SNAKE_CASE 或 camelCase(视语义而定)
- 类型定义:统一放在 types/ 或同文件内以 I、T、S 前缀
- 测试文件:同名 + .test.tsx / .spec.tsx
- Storybook 文件:同名 + .stories.tsx
组件编写规范
所有组件必须导出 Props 类型(interface 或 type)。优先使用解构 + 默认值写法,显式声明 children?: ReactNode。动态 className 建议使用 clsx 或 cva。
注意业务逻辑不要写在组件内部超过 30 行,应抽离到 hooks 或 utils。所有副作用必须放在 useEffect 中,并明确依赖数组。自定义 hooks 命名必须以 use 开头,且禁止在 render 阶段产生副作用(如 setState、dispatch 等)。
推荐的组件 Props 写法
interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
variant?: 'primary' | 'secondary' | 'outline' | 'ghost' | 'destructive'
size?: 'sm' | | |
?:
?:
?: .
?: .
}
= .<, >(
{
}
)
. =

