SuperAPI AI 工具集

scaffold-exercises

编程与开发

查看项目

更新于 10-16 05:07

技能介绍

用途:按既定规范搭建练习(exercise)目录结构,使生成结果能通过 lint 校验,再使用 git commit 提交。适合需要批量创建课程或训练题骨架的场景。

目录命名:分节为 exercises/ 下的 XX-section-name/,练习为分节内的 XX.YY-exercise-name/,名称使用短横线小写(dash-case)。

练习变体:每个练习至少包含 problem/(含 TODO 的学生工作区)、solution/(参考实现)、explainer/(概念材料,无 TODO)之一。打桩时默认使用 explainer/,除非计划另有指定。

必需文件:每个子目录都需要 readme.md,内容非空且无失效链接。打桩时创建含标题与描述的最小 readme,例如“# Exercise Title”加描述。若子目录含代码,还需 main.ts(多于一行);仅 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 而非 mv 以保留历史,更新数字前缀以维持顺序,移动后重新运行 lint。示例:git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings

限制:资料未提供该技能的安装方式、支持平台、收费与价格信息;效果与适用范围也暂未提供。