contract-scaffolding

Scaffold OpenAPI contract components with TypeScript type generation.

39|3|Updated Nov 21, 2025

Search Tags:#typescript #templates #openapi #scaffolding #server #generator #contract

Ready to run

npx skills add https://github.com/LiorCohen/sdd --skill contract-scaffolding

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: contract-scaffolding
Source: https://github.com/LiorCohen/sdd/tree/main/plugin/fullstack-typescript/skills/components/contract/contract-scaffolding
Command: npx skills add https://github.com/LiorCohen/sdd --skill contract-scaffolding

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates creating contract components that define the API spec and auto-generates TypeScript types for server and webapp usage.

Core Features & Use Cases

OpenAPI template with placeholders and variables for easy contract creation.
Generates TypeScript types (api-types.ts) from the OpenAPI spec for immediate integration.
Maps contract components under components/contracts/{name}/ via techpack-settings for consistent directory structure.
Supports multiple instances of contract components with centralized tooling.

Quick Start

Run the scaffolding engine to scaffold a new contract component from the template for your contract name.

Frequently Asked Questions about contract-scaffolding

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

FAQPage Schema

How do I generate TypeScript types from an OpenAPI contract?▼

Scaffolding OpenAPI contracts generates api-types.ts files alongside openapi.yaml using template-driven generation. This provides immediate TypeScript type integration for server and webapp components.

Can I scaffold multiple OpenAPI contracts in the same project?▼

You can scaffold multiple OpenAPI contract instances with centralized tooling. It maps each contract under components/contracts/{name}/ directories using techpack-settings for consistent structure.

What is the best way to structure OpenAPI contract components for server and webapp usage?▼

Template-driven scaffolding structures OpenAPI contract components by generating openapi.yaml, package.json, and api-types.ts under mapped contracts/{name}/ directories for consistent server and webapp integration.

Does OpenAPI scaffolding require manual directory configuration for each contract?▼

No manual directory configuration is needed for OpenAPI scaffolding per contract. It uses techpack-settings to automatically map component types and names to consistent directories across projects.

Why should I use a template for OpenAPI contract scaffolding instead of writing the spec manually?▼

Template-driven OpenAPI contract scaffolding automates component creation and TypeScript type generation, ensuring consistent directory mappings like contracts/{name}/ while reducing manual spec writing effort across projects.