scaffold-exercises

Creates lint-compliant course exercise directory structures with sections, problems, solutions, and explainers.

10|3|Updated Jul 18, 2019
One-click install
npx skills add https://github.com/tanqimin/MyFavsORM --skill scaffold-exercises-tanqimin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scaffold-exercises
Source: https://github.com/tanqimin/MyFavsORM/tree/main/.agents/skills/scaffold-exercises
Command: npx skills add https://github.com/tanqimin/MyFavsORM --skill scaffold-exercises-tanqimin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Setting up course exercise folders by hand is error-prone: naming conventions, required readme files, and lint rules are easy to get wrong, causing failed validation runs. This Skill scaffolds the entire exercise directory tree correctly the first time. ## Core Features & Use Cases - Directory Scaffolding: Creates numbered section folders (XX-section-name) and exercise folders (XX.YY-exercise-name) with dash-case naming inside exercises/. - Variant Support: Generates problem/, solution/, and explainer/ subfolders, each with a non-empty readme.md stub containing a title and description. - Lint Validation: Runs pnpm ai-hero-cli internal lint and iterates on errors until the structure passes all rules (no .gitkeep, no broken links, no speaker-notes.md). - Safe Renumbering: Uses git mv to move or renumber exercises while preserving git history. - Use Case: Given a course plan listing sections and exercises, generate the full stub structure for a new 'Memory Skill Building' section with explainer, problem, and solution variants, then validate it with the linter. ## Quick Start Scaffold the exercises from my course plan into the exercises directory and run the lint check until it passes.

Frequently Asked Questions about scaffold-exercises

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I scaffold course exercise directories that pass linting?

Create numbered section folders (XX-section-name) containing exercise folders (XX.YY-exercise-name), each with problem, solution, or explainer subfolders holding a non-empty readme.md. Then run pnpm ai-hero-cli internal lint and fix reported errors until it passes.

What files are required in each exercise subfolder?

Each problem, solution, or explainer subfolder needs a non-empty readme.md with real content and no broken links. If the subfolder contains code, it also needs a main.ts file with more than one line, though readme-only stubs are acceptable.

How do I rename or renumber exercises without losing git history?

Use git mv instead of mv to rename exercise directories, which preserves git history. Update the numeric prefix to maintain ordering, then re-run the lint command to verify the moved structure still validates.

Why does the exercise lint check fail on my new section?

Common failures include empty readme.md files, .gitkeep or speaker-notes.md files, broken links in readmes, pnpm run exercise commands in readmes, or missing problem/solution/explainer subfolders. Fix each reported issue and re-run the linter.

When should I use explainer versus problem and solution folders?

Use explainer for conceptual material with no TODOs, problem for student workspaces containing TODOs, and solution for reference implementations. When stubbing exercises without a detailed plan, default to explainer-only folders.