SuperAPI AI 工具集

scaffold-exercises

编程与开发

查看项目

更新于 10-16 05:53

技能介绍

用途:根据计划(plan)创建练习目录结构,使其通过 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,且非空、无失效链接。打桩时创建含标题与描述的最小 readme。若子文件夹含代码,还需 main.ts(超过 1 行);仅 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 命令;每个子文件夹需 main.ts,除非仅 readme。

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

限制:该技能仅负责搭建符合 lint 的目录骨架,不涉及具体练习内容实现;是否需提交、计划格式细节等暂未提供。