Optimized the root .gitignore to exclude virtual environments, node modules, and temp folders to ensure clean and lightweight version tracking. Co-authored-by: Cursor <cursoragent@cursor.com>
1.9 KiB
1.9 KiB
开发指南
开发流程:阅读 spec.md → 编写代码 → 运行验收脚本 → 按错误信息修复
项目结构与命名
src/
├── prototypes/<name>/
│ ├── index.tsx # 必需
│ ├── spec.md # 必需
│ ├── style.css # 可选
│ ├── hack.css # 可选(AI 不应修改)
│ └── components/ # 可选:内部子组件目录
└── components/<name>/
├── index.tsx
├── spec.md
└── (同上)
- 入口文件必须是 `index.tsx`
- 目录内必须包含 `spec.md`
- 目录(`name`)使用小写字母、数字、连字符(如 `login-page`)
- 支持可选子目录 `components/` 用于拆分内部子组件
## 核心约束
### 1. 文件头注释(必需)
每个 `index.tsx` 顶部必须包含 `@name`:
```typescript
/**
* @name 显示名
*
*/
@name必须存在,且为中文显示名
2. 依赖与样式
- React 与 Hooks 直接从
react导入 - 第三方库按需导入,新增依赖需同步安装
- 使用 Tailwind 时必须导入
style.css,且样式文件需包含:
@import "tailwindcss";
验收流程
1. 运行验收脚本
node scripts/check-app-ready.mjs /components/[组件目录]
# 或
node scripts/check-app-ready.mjs /prototypes/[原型目录]
关键返回字段:
status:READY/ERROR/TIMEOUTtargetUrl: 本次验收目标地址errors: 构建/运行时/页面加载错误列表
2. 错误处理
当状态为 ERROR:按 errors 修复后重新执行验收脚本,直到通过。
验收清单(提交前)
index.tsx与spec.md完整存在- 顶部包含
@name注释与参考资料 - 依赖导入方式符合规范,新增依赖已安装
- 使用 Tailwind 时已正确引入
@import "tailwindcss"; check-app-ready.mjs验收通过