关于 scaffold-exercises
用于创建带编号的练习目录,并通过项目检查器验证。它为开发者说明如何生成练习变体、满足文件要求及安全重命名。
主要功能
- 01分节与练习编号路径
- 02题目、解答和讲解变体
- 03README 与代码文件要求
- 04检查及修复流程
- 05使用 Git 重命名练习
适用场景
- 01根据计划搭建练习目录
- 02添加最小练习占位内容
- 03提交前检查练习结构
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ polya20/ grill-me --skill scaffold-exercises安装后在 Claude Code 中输入/scaffold-exercises确认已加载。
详细介绍
搭建练习骨架
创建能通过 pnpm ai-hero-cli internal lint 检查的练习目录结构,然后使用 git commit 提交。
目录命名
- 章节:
exercises/内的XX-section-name/(例如01-retrieval-skill-building) - 练习:章节内的
XX.YY-exercise-name/(例如01.03-retrieval-with-bm25) - 章节编号 =
XX,练习编号 =XX.YY - 名称使用短横线命名法(小写字母加连字符)
练习变体
每个练习至少需要以下子文件夹之一:
problem/- 含 TODO 的学生练习区solution/- 参考实现explainer/- 概念讲解材料,不含 TODO
生成占位时,除非计划另有说明,默认使用 explainer/。
必需文件
每个子文件夹(problem/、explainer/、solution/)都需要一个 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 规则摘要
Lint 工具(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"
评论
支持 Markdown