SuperAPI AI 工具集

scaffold-exercises

编程与开发

查看项目

更新于 10-16 01:38

技能介绍

用途:创建能通过 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/、solution/、explainer/ 之一。problem/ 为学生工作区含 TODO,solution/ 为参考实现,explainer/ 为概念材料无 TODO。创建存根时默认使用 explainer/,除非计划另有说明。

必需文件:每个子文件夹都需要非空且无断链的 readme.md。存根可创建带标题和描述的最小 readme。若子文件夹有代码,还需 main.ts(超过1行);存根可仅含 readme。

工作流:解析计划提取章节名、练习名和变体类型;用 mkdir -p 创建目录;为每个变体文件夹创建带标题的 readme.md 存根;运行 pnpm ai-hero-cli internal lint 验证;迭代修复错误直到通过。

Lint 规则:检查每个练习有子文件夹;至少存在 problem/、explainer/ 或 explainer.1/ 之一;主要子文件夹中 readme.md 存在且非空;无 .gitkeep;无 speaker-notes.md;readme 无断链;readme 无 pnpm run exercise 命令;每个子文件夹需要 main.ts 除非仅含 readme。

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