shenjingnan/dev-workflow-checker

开发流程检查技能

当用户进行代码修改后，此技能确保执行必要的质量检查命令，同时遵循务实开发理念。

技能描述

该技能会在用户完成代码修改后，自动提醒并执行相关的开发流程检查，确保代码质量和类型安全，但不追求过度的完美标准。

技能使用原则

• 保证质量，但避免过度检查：执行必要的检查，但不追求完美的检查流程
• 实用功能优先，理论完美次之：解决实际的代码问题比预防各种可能更重要
• 简单解决方案优于复杂方案：优先选择直接有效的检查方式
• 务实开发指导：评估检查的必要性，避免过度检查

检查内容

前端应用 (apps/frontend)

当修改前端代码时，执行以下检查：

• pnpm typecheck - TypeScript 类型检查
• pnpm lint - Biome linter 检查
• pnpm test - 运行测试套件
• pnpm check:all - 运行所有质量检查（如果需要全面检查）

后端应用 (apps/backend)

当修改后端代码时，执行以下检查：

• pnpm typecheck - TypeScript 类型检查
• pnpm lint - Biome linter 检查
• pnpm test - 运行测试套件
• pnpm check:all - 运行所有质量检查（如果需要全面检查）

使用场景

1. 完成代码修改后：自动提醒用户执行相应的检查命令
2. 提交代码前：确保所有检查都通过
3. PR 创建前：验证代码质量标准
4. 集成测试前：确保基本质量门控通过

检查流程

前端代码修改流程

# 1. 类型检查
pnpm typecheck

# 2. 代码风格检查
pnpm lint

# 3. 运行测试
pnpm test

# 4. 全面检查（可选）
pnpm check:all

后端代码修改流程

# 1. 类型检查
pnpm typecheck

# 2. 代码风格检查
pnpm lint

# 3. 运行测试
pnpm test

# 4. 全面检查（可选）
pnpm check:all

质量标准

必须通过的检查

• ✅ TypeScript 类型检查（零错误）
• ✅ Biome linter 检查（符合项目代码风格）
• ✅ 测试套件（所有测试通过）

推荐检查

• ✅ 代码覆盖率（达到80%目标）
• ✅ 拼写检查
• ✅ 重复代码检查

错误处理

类型检查失败

• 检查 any 类型的使用
• 验证 React 组件属性类型
• 确保路径别名正确使用

Linter 检查失败

• 代码格式不符合项目标准
• 导入顺序不正确
• 未使用的变量或导入

测试失败

• 检查测试用例的逻辑
• 验证 mock 配置
• 确认测试环境设置

项目特定要求

零容忍政策

• 禁止使用 any 类型：必须使用具体类型或 unknown
• 测试文件类型安全：同样禁止 any 类型
• React 组件属性类型：使用具体的 React 组件属性类型

路径别名要求

• 跨目录导入必须使用正确的路径别名
• 避免使用相对路径导入其他目录
• 按照最佳实践排序导入语句

本地化规范

• 代码注释使用中文
• 测试用例描述使用中文
• 变量和函数名继续使用英文

自动化建议

建议在以下场景自动触发检查：

1. Git pre-commit hook
2. CI/CD pipeline
3. IDE 保存时自动检查
4. Pull Request 创建时

注意事项

1. 区分应用目录：根据修改的文件选择正确的检查命令
2. 错误优先级：先修复类型错误，再处理风格问题
3. 性能考虑：全面检查耗时较长，可在关键时刻执行
4. 团队协作：确保所有开发人员遵循相同的检查标准