name: 项目设置 description: 使用强类型、代码检查、格式化和测试来引导新项目。支持 Python、TypeScript 和其他语言,带有研究备用方案。
项目设置
核心原则
- 强类型: 启用严格模式;类型在编译时捕获错误
- 强代码检查: 默认严格规则;禁用比后期添加更容易
- 自动格式化: 自动化和一致;无需手动格式化
- 每个阶段检查: 预提交钩子 + CI;早期捕获问题
- 共置测试:
foo.ts→foo.test.ts;明确测试内容 - 行为聚焦: 测试代码做什么,而不是怎么做;仅模拟外部边界
工作流程
- 检查
reference/中的语言指南(Python、TypeScript) - 如果没有指南:网页搜索“[语言] 项目设置最佳实践”
- 遵循设置顺序:类型 → 代码检查 → 格式化 → 测试 → 预提交 → CI
- 对于现有项目:按相同顺序逐步迁移
参考文件
reference/python.md- uv, ruff, basedpyright, pytestreference/typescript.md- pnpm, ESLint, Prettier, Vitestreference/common-patterns.md- 测试哲学、CI 模式、安全
工具选择
优先选择:生态系统标准、积极维护、默认严格、快速、良好集成(编辑器 + CI + 预提交)的工具。
质量检查清单
- [ ] 类型: 最严格模式,没有
any无需正当理由 - [ ] 代码检查: 严格规则,警告视为错误
- [ ] 格式化: 保存时自动格式化 + 预提交
- [ ] 测试: 共置测试,覆盖率 >80%
- [ ] 预提交: 格式化、代码检查、类型检查
- [ ] CI: 相同检查 + 覆盖率报告
- [ ] README: 设置说明
- [ ] 所有检查在初始提交时通过