scaffold-exercises脚手架工具：自动化创建符合规范的练习目录结构

scaffold-exercises by mattpocock/skills

512 周安装量

9,900 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/mattpocock/skills --skill scaffold-exercises

教育科技开发自动化

🇨🇳中文介绍

脚手架练习

创建能通过 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）
章节编号 = XX，练习编号 = XX.YY

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

相关 Skills

FlyClaw：零登录航班聚合查询工具，Python实现多源航班信息与价格搜索

4,000,000 周安装

find-skills 技能搜索工具 - Vercel Labs 开源智能体技能包管理器

762,600 周安装

Vercel React 最佳实践指南 | 58条Next.js性能优化规则与代码重构

258,600 周安装

Vercel Web界面规范检查工具 - 自动检测代码是否符合Web设计指南

208,300 周安装

名称使用短横线命名法（小写，连字符分隔）

每个练习至少需要包含以下子文件夹之一：

problem/ - 包含待办事项的学生工作区
solution/ - 参考实现
explainer/ - 概念性材料，无待办事项

创建存根时，除非计划另有说明，否则默认使用 explainer/。

每个子文件夹（problem/、solution/、explainer/）都需要一个 readme.md 文件，该文件：

非空（必须有实际内容，即使只有一行标题也可以）
没有损坏的链接

创建存根时，创建一个包含标题和描述的最小化 readme：

# 练习标题

此处为描述

如果子文件夹包含代码，则还需要一个 main.ts 文件（>1 行）。但对于存根，仅包含 readme 的练习也可以。

解析计划 - 提取章节名称、练习名称和变体类型
创建目录 - 为每个路径执行 mkdir -p
创建存根 readme - 为每个变体文件夹创建一个带有标题的 readme.md
运行 lint - 执行 pnpm ai-hero-cli internal lint 进行验证
修复任何错误 - 迭代直到 lint 通过

linter (pnpm ai-hero-cli internal lint) 检查以下内容：

每个练习都有子文件夹（problem/、solution/、explainer/）
至少存在 problem/、explainer/ 或 explainer.1/ 中的一个
在主（primary）子文件夹中存在 readme.md 且非空
没有 .gitkeep 文件
没有 speaker-notes.md 文件
readme 中没有损坏的链接
readme 中没有 pnpm run exercise 命令
除非是仅包含 readme 的练习，否则每个子文件夹都需要 main.ts

移动/重命名练习

当重新编号或移动练习时：

使用 git mv（而不是 mv）重命名目录 - 保留 git 历史记录
更新数字前缀以保持顺序
移动后重新运行 lint

git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings

示例：根据计划创建存根

给定如下计划：

Section 05: Memory Skill Building
- 05.01 Introduction to Memory
- 05.02 Short-term Memory (explainer + problem + solution)
- 05.03 Long-term Memory

mkdir -p exercises/05-memory-skill-building/05.01-introduction-to-memory/explainer
mkdir -p exercises/05-memory-skill-building/05.02-short-term-memory/{explainer,problem,solution}
mkdir -p exercises/05-memory-skill-building/05.03-long-term-memory/explainer

然后创建 readme 存根：

exercises/05-memory-skill-building/05.01-introduction-to-memory/explainer/readme.md -> "# Introduction to Memory"
exercises/05-memory-skill-building/05.02-short-term-memory/explainer/readme.md -> "# Short-term Memory"
exercises/05-memory-skill-building/05.02-short-term-memory/problem/readme.md -> "# Short-term Memory"
exercises/05-memory-skill-building/05.02-short-term-memory/solution/readme.md -> "# Short-term Memory"
exercises/05-memory-skill-building/05.03-long-term-memory/explainer/readme.md -> "# Long-term Memory"

🇺🇸English

Scaffold Exercises

Create exercise directory structures that pass pnpm ai-hero-cli internal lint, then commit with git commit.

Directory naming

Sections : XX-section-name/ inside exercises/ (e.g., 01-retrieval-skill-building)
Exercises : XX.YY-exercise-name/ inside a section (e.g., 01.03-retrieval-with-bm25)
Section number = XX, exercise number = XX.YY
Names are dash-case (lowercase, hyphens)

Exercise variants

Each exercise needs at least one of these subfolders:

problem/ - student workspace with TODOs
solution/ - reference implementation
explainer/ - conceptual material, no TODOs

When stubbing, default to explainer/ unless the plan specifies otherwise.

Required files

Each subfolder (problem/, solution/, explainer/) needs a readme.md that:

Is not empty (must have real content, even a single title line works)
Has no broken links

When stubbing, create a minimal readme with a title and a description:

# Exercise Title

Description here

If the subfolder has code, it also needs a main.ts (>1 line). But for stubs, a readme-only exercise is fine.

Workflow

Parse the plan - extract section names, exercise names, and variant types
Create directories - mkdir -p for each path
Create stub readmes - one readme.md per variant folder with a title
Run lint - pnpm ai-hero-cli internal lint to validate
Fix any errors - iterate until lint passes

Lint rules summary

The linter (pnpm ai-hero-cli internal lint) checks:

Each exercise has subfolders (problem/, solution/, explainer/)
At least one of problem/, explainer/, or explainer.1/ exists
readme.md exists and is non-empty in the primary subfolder
No .gitkeep files
No speaker-notes.md files
No broken links in readmes
No pnpm run exercise commands in readmes

Moving/renaming exercises

When renumbering or moving exercises:

Use git mv (not mv) to rename directories - preserves git history
Update the numeric prefix to maintain order
Re-run lint after moves

Example:

git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings

Example: stubbing from a plan

Given a plan like:

Section 05: Memory Skill Building
- 05.01 Introduction to Memory
- 05.02 Short-term Memory (explainer + problem + solution)
- 05.03 Long-term Memory

Create:

mkdir -p exercises/05-memory-skill-building/05.01-introduction-to-memory/explainer
mkdir -p exercises/05-memory-skill-building/05.02-short-term-memory/{explainer,problem,solution}
mkdir -p exercises/05-memory-skill-building/05.03-long-term-memory/explainer

Then create readme stubs:

exercises/05-memory-skill-building/05.01-introduction-to-memory/explainer/readme.md -> "# Introduction to Memory"
exercises/05-memory-skill-building/05.02-short-term-memory/explainer/readme.md -> "# Short-term Memory"
exercises/05-memory-skill-building/05.02-short-term-memory/problem/readme.md -> "# Short-term Memory"
exercises/05-memory-skill-building/05.02-short-term-memory/solution/readme.md -> "# Short-term Memory"
exercises/05-memory-skill-building/05.03-long-term-memory/explainer/readme.md -> "# Long-term Memory"

Weekly Installs

452

Repository

mattpocock/skills

GitHub Stars

9.5K

First Seen

11 days ago

Security Audits

Gen Agent Trust HubPass SocketPass SnykPass

Installed on

codex433

cursor430

gemini-cli429

github-copilot429

opencode429

amp428

agent-browser 浏览器自动化工具 - Vercel Labs 命令行网页操作与测试

138,300 周安装

main.ts required per subfolder unless it's readme-only