SuperAPI AI 工具集

scaffold-exercises

编程与开发

查看项目

更新于 10-16 06:21

技能介绍

用途:按计划搭建练习目录结构,使生成的目录能通过 pnpm ai-hero-cli internal lint 校验,随后用 git commit 提交。

主要能力与命名规则:章节位于 exercises/ 下的 XX-section-name/;练习位于章节内,命名 XX.YY-exercise-name/,其中章节编号为 XX,练习编号为 XX.YY;名称使用小写加连字符。每个练习至少需要 problem/、solution/、explainer/ 中的一个子文件夹:problem/ 是含 TODO 的学员工作区,solution/ 是参考实现,explainer/ 是概念材料且无 TODO。打桩时默认使用 explainer/,除非计划另有说明。

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

工作流:解析计划提取章节名、练习名与变体类型;用 mkdir -p 创建目录;为每个变体文件夹创建带标题的 readme.md 桩;运行 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 以保留历史,更新数字前缀保持顺序,移动后重新运行校验。示例:git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings。

打桩示例:按计划 Section 05 建目录,如 mkdir -p exercises/05-memory-skill-building/05.01-introduction-to-memory/explainer,并为各变体创建标题 readme 桩。

限制:资料未提供其他平台、价格或额外配置信息。