用途
Scaffold Exercises 用于创建练习(exercise)目录结构,使其能通过 pnpm ai-hero-cli internal lint 检查,然后通过 git commit 提交。当用户想要搭建练习脚手架、根据计划批量生成练习题目时使用。
目录命名规则
- 章节(Sections):exercises/ 内的 XX-section-name/(例如 01-retrieval-skill-building)
- 练习(Exercises):章节内的 XX.YY-exercise-name/(例如 01.03-retrieval-with-bm25)
- 章节编号为 XX,练习编号为 XX.YY
- 名称为 dash-case(小写、连字符)
练习变体
每个练习至少需要以下子文件夹之一:
- problem/ - 含 TODO 的学生工作区
- solution/ - 参考实现
- explainer/ - 概念材料,不含 TODO
搭建存根时,除非计划(plan)另有说明,默认使用 explainer/。
必需文件
每个子文件夹(problem/、solution/、explainer/)都需要一个 readme.md,要求:
- 非空(必须有真实内容,即使只有一行标题也可)
- 没有失效链接
搭建存根时,创建一个带标题和描述的最小 readme:
# Exercise Title
Description here
如果子文件夹包含代码,则还需要 main.ts(超过 1 行)。但对于存根而言,只有 readme 的练习是可以的。
工作流程
- 解析计划 - 提取章节名称、练习名称和变体类型
- 创建目录 - 对每个路径执行 mkdir -p
- 创建存根 readme - 为每个变体文件夹创建一个带标题的 readme.md
- 运行 lint - pnpm ai-hero-cli internal lint 进行校验
- 修复错误 - 反复迭代直到 lint 通过
Lint 规则摘要
linter(pnpm ai-hero-cli internal lint)检查:
- 每个练习有子文件夹(problem/、solution/、explainer/)
- problem/、explainer/ 或 explainer.1/ 中至少有一个存在
- 主文件夹中 readme.md 存在且非空
- 没有 .gitkeep 文件
- 没有 speaker-notes.md 文件
- readme 中没有失效链接
- readme 中没有 pnpm run exercise 命令
- 除非仅有 readme,否则每个子文件夹需要 main.ts
移动/重命名练习
当重新编号或移动练习时:
- 使用 git mv(而不是 mv)重命名目录 - 保留 git 历史
- 更新数字前缀以维持顺序
- 移动后重新运行 lint
示例:
git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings
示例:根据计划搭建存根
给定如下计划:
Section 05: Memory Skill Building
- 05.01 Introduction to Memory
- 05.02 Short-term Memory (explainer + problem + solution)
- 05.03 Long-term Memory
创建:
mkdir -p exercises/05-memory-skill-building/05.01-introduction-to-memory/explainer
mkdir -p exercises/05-memory-skill-building/05.02-short-term-memory/{explainer,problem,solution}
mkdir -p exercises/05-memory-skill-building/05.03-long-term-memory/explainer
然后创建 readme 存根:
- exercises/05-memory-skill-building/05.01-introduction-to-memory/explainer/readme.md -> "# Introduction to Memory"
- exercises/05-memory-skill-building/05.02-short-term-memory/explainer/readme.md -> "# Short-term Memory"
- exercises/05-memory-skill-building/05.02-short-term-memory/problem/readme.md -> "# Short-term Memory"
- exercises/05-memory-skill-building/05.02-short-term-memory/solution/readme.md -> "# Short-term Memory"
- exercises/05-memory-skill-building/05.03-long-term-memory/explainer/readme.md -> "# Long-term Memory"
适用场景
适用于需要批量搭建课程或训练练习目录结构、并保证其通过 lint 校验的开发和教学内容准备场景。
限制
关于收费、价格、支持平台等信息,资料暂未提供。