module-scaffolding

Generate standard module scaffolds with a Yeoman generator and sync metadata.

6|Updated Feb 20, 2025
One-click install
npx skills add https://github.com/zerobias-org/module --skill module-scaffolding
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: module-scaffolding
Source: https://github.com/zerobias-org/module/tree/main/.claude/skills/module-scaffolding
Command: npx skills add https://github.com/zerobias-org/module --skill module-scaffolding

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a streamlined workflow for scaffolding new modules using a Yeoman generator, ensuring consistent project structure and automated metadata synchronization.

Core Features & Use Cases

  • Generates a standard module scaffold with best-practice structure (package.json, tsconfig.json, src/, test/, etc.)
  • Ensures api.yml metadata stays in sync with package.json via the sync-meta step
  • Validates scaffold readiness and can be used to reproduce module templates across teams

Quick Start

Run the Hub Module generator to scaffold a new module, then run npm run sync-meta to populate api.yml.

Frequently Asked Questions about module-scaffolding

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

FAQPage Schema
How do I scaffold a new module with consistent project structure and metadata?

Module scaffolding is automated using a Yeoman generator to produce a standard project structure with files like package.json and src/, enforcing consistent templates and metadata synchronization across teams.

Why does my module scaffold need a sync-meta step after generation?

The sync-meta step is required after scaffolding to populate api.yml and ensure metadata stays in sync with package.json, maintaining title and version parity across the generated module files.

What is the best way to standardize module templates across multiple development teams?

Standardizing module templates is best achieved by using a Yeoman generator to create repeatable project scaffolds, enforcing structural consistency and automated metadata validation before the module is used.

Can I use Yeoman generators to enforce package.json and api.yml version parity?

Yes, Yeoman generators can enforce title and version parity between package.json and api.yml by requiring a sync-meta execution step and validating the scaffold readiness upon completion.

What files are included in a standard Yeoman module scaffold?

A standard module scaffold includes best-practice files such as package.json, tsconfig.json, src/ directories, and test/ folders, providing a complete and validated starting structure for development.

What happens if I skip validation after scaffolding a module?

Skipping validation risks using an incomplete module scaffold, potentially causing metadata desynchronization between package.json and api.yml and failing to meet execution requirements.