名称: 模块脚手架 描述: 在DevPrep AI中按照6文件夹架构脚手架化新功能模块,包含正确的TypeScript接口、路径别名和质量标准。在创建新领域(如’分析’、'通知’或任何新功能模块)时使用。 允许工具: [读取, 写入, Bash, Glob]
模块脚手架
自动化创建具有适当结构、样板文件并强制执行质量标准的功能模块。
自动触发
由以下关键词自动触发:
- “新模块”、“创建模块”、“脚手架模块”
- “新功能模块”、“添加模块”
快速命令
# 创建新模块
./.claude/skills/module-scaffolder/scripts/create-module.sh <模块名称>
# 向模块添加组件
./.claude/skills/module-scaffolder/scripts/add-component.sh <模块名称> <组件名称>
# 验证模块
./.claude/skills/module-scaffolder/scripts/validate-module.sh <模块名称>
生成的结构
modules/<模块名称>/
├── components/
│ ├── ExampleCard.tsx # 起始组件(重命名/删除)
│ └── index.ts # 桶式导出
├── hooks/
│ └── index.ts
├── utils/
│ └── index.ts
└── types.ts # 模块特定类型
所有生成的文件自动遵循DevPrep AI质量标准。
使用工作流
1. 创建新模块
示例: 创建分析模块
# 1. 脚手架化
./scripts/create-module.sh analytics
# 2. 根据需要添加组件
./scripts/add-component.sh analytics AnalyticsChart
./scripts/add-component.sh analytics AnalyticsSummary
# 3. 验证
./scripts/validate-module.sh analytics
会发生什么:
- 使用适当结构创建模块目录
- 从模板生成样板文件
- 带有I前缀的TypeScript接口
- 配置路径别名
- 强制执行质量标准
2. 添加组件
./scripts/add-component.sh <模块名称> <组件名称>
结果:
- 生成具有适当TypeScript模式的组件文件
- 自动更新桶式导出(
index.ts) - 包含I前缀接口
- 准备实现逻辑
3. 验证模块
./scripts/validate-module.sh <模块名称>
检查:
- 目录结构(6文件夹架构)
- 文件大小限制(≤180行)
- 接口命名(I前缀)
- 无
any类型 - 导入模式
集成
脚手架化之前: 使用brainstorming技能来规划模块设计
脚手架化之后:
- 使用
trpc-scaffolder创建API端点 - 使用
quality-reviewer审查代码质量
文档
详细参考资料可在references/中找到:
6-folder-architecture.md- 模块适合的位置,结构规则naming-conventions.md- I前缀、PascalCase、camelCase规则path-aliases.md- 导入模式,@shared、@lib用法quality-checklist.md- 完整的质量标准
示例: 查看examples/complete-module/以获取完全结构化的参考模块
故障排除
模块名称: 使用小写带连字符(analytics、user-profile)
组件名称: 使用PascalCase(AnalyticsChart、UserCard)
路径错误: 确保从项目根目录运行或使用绝对路径
模板
templates/目录中的所有模板都会被脚本自动使用。修改模板以自定义生成的代码模式。