SuperAPI AI 工具集

scaffold-exercises

编程与开发

查看项目

更新于 10-16 06: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。名称使用短横线小写(dash-case)。

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

必需文件:每个子文件夹需有 readme.md,且不能为空(至少一行标题即可),不得含失效链接。若子文件夹含代码,还需 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 保留历史,更新数字前缀维持顺序,移动后重新 lint,例如 git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings。

限制:仅覆盖上述目录规范、存根与 lint 流程;具体课程内容、依赖版本、收费或平台差异暂未提供。