SuperAPI AI 工具集

scaffold-exercises

通用与其它

查看项目

更新于 10-16 03:15

技能介绍

用途:按给定计划批量搭建练习目录结构,使其通过 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)。名称使用小写连字符。

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

必需文件:每个子文件夹需有非空 readme.md,且无失效链接。打桩时创建含标题和描述的最小 readme。若子文件夹含代码,还需 main.ts(超过 1 行);仅 readme 的练习也可。

工作流:解析计划提取章节、练习与变体类型;用 mkdir -p 创建目录;为每个变体文件夹创建带标题的 readme 占位;运行 pnpm ai-hero-cli internal 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。

限制:资料未提供该技能的安装方式、收费、支持平台及具体效果信息。