用途
scaffold-exercises 用于创建练习目录结构,使生成的目录能够通过 pnpm ai-hero-cli internal lint 的检查,并通过 git commit 提交。当用户想要打桩练习(scaffold exercises)或创建练习目录时使用。
目录命名规则
- 章节:放在 exercises/ 内,格式为 XX-section-name/,例如 01-retrieval-skill-building。
- 练习:放在章节内,格式为 XX.YY-exercise-name/,例如 01.03-retrieval-with-bm25。
- 章节编号为 XX,练习编号为 XX.YY。
- 名称使用 dash-case(小写字母加连字符)。
练习变体
每个练习至少需要以下子文件夹之一:
- problem/ — 含 TODO 的学生工作区
- solution/ — 参考实现
- explainer/ — 概念材料,不含 TODO
打桩时,除非计划另有指定,否则默认使用 explainer/。
必需文件
每个子文件夹(problem/、solution/、explainer/)都需要一个 readme.md,要求:
- 非空(必须有真实内容,哪怕仅有一行标题也可)
- 没有失效链接
打桩时创建包含标题和描述的最小 readme:
# Exercise Title
Description here
如果子文件夹包含代码,则还需要 main.ts(超过 1 行)。但打桩阶段仅含 readme 的练习也可接受。
工作流
- 解析计划 — 提取章节名称、练习名称和变体类型
- 创建目录 — 使用 mkdir -p 为每个路径创建目录
- 创建 stub 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 命令
- 每个子文件夹需要 main.ts,除非仅含 readme
移动或重命名练习
重新编号或移动练习时:
- 使用 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 校验的场合,例如课程或教程项目的练习脚手架搭建。
限制
该技能依赖 pnpm ai-hero-cli internal lint 进行校验,并要求使用 git mv 保留历史记录。资料未提供关于收费、价格、平台兼容性或具体使用效果的更多信息。