SuperAPI AI 工具集

scaffold-exercises

编程与开发

查看项目

更新于 10-15 21:08

技能介绍

用途:搭建能通过 pnpm ai-hero-cli internal lint 的练习目录结构,完成后用 git commit 提交。

目录命名:章节位于 exercises/ 下的 XX-section-name/,练习位于章节下的 XX.YY-exercise-name/,名称使用 dash-case。

练习类型:每个练习至少包含 problem/(学生工作区,含 TODO)、solution/(参考实现)、explainer/(概念材料,不含 TODO)之一。占位时默认使用 explainer/。

必需文件:每个子目录需有非空 readme.md,无无效链接。占位时创建含标题和描述的最小 readme。若子目录含代码,还需 main.ts(>1 行);纯 readme 占位也可。

工作流:解析计划提取章节、练习名称与类型;用 mkdir -p 创建目录;创建占位 readme;运行 pnpm ai-hero-cli internal lint 验证;迭代修复直到通过。

Lint 规则:检查每个练习有子目录;problem/、explainer/ 或 explainer.1/ 中至少存在一个;主子目录有非空 readme.md;无 .gitkeep;无 speaker-notes.md;readme 无无效链接;readme 无 pnpm run exercise 命令;除纯 readme 练习外每个子目录需 main.ts。

移动或重命名:使用 git mv 保留历史,更新数字前缀维持顺序,移动后重新运行 lint。示例:git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings。

限制:资料未提供该技能的具体安装方式、收费信息或平台支持范围。