Redocly/redocly-cli / packages/client-generator/eject-assets/skills/zod-generator
zod-generator
UnverifiedDesign of the ejected Redocly `zod` client generator. Read it, and update it, before changing generators/zod/.
The zod generator — its skill
This file is the DESIGN of your ejected zod generator (generators/zod/):
to change the generator, edit this skill first, then make the code match it — a diff
to generators/zod/ that has no covering sentence here is incomplete.
What it emits
A standalone <stem>.zod.ts: one export const <Name>Schema per named IR schema, the
operationSchemas request/response map, and a zodValidation() middleware.
Design decisions that must hold
- The client stays dependency-free. zod is the CONSUMER's peer dependency; the generated client never imports this module, and this module never imports the client.
- Output-mode-agnostic: one module beside the client whatever the sdk's layout.
- Emits nothing when the model has neither named schemas nor JSON operation bodies — an empty file is worse than no file.
- Validation is opt-in at runtime (
use(zodValidation())), never automatic. - Only ERASABLE TypeScript. The module must run under
node --experimental-strip-typeswith no build step, so nothing that needs a transform is emitted: noenum, nonamespace, and no constructor parameter properties.ZodValidationErrortherefore declares its fields and assigns them in the constructor body —constructor(readonly operationId: string)fails strip-only mode, which is how the generated CLI broke when it imported this module.
The stage files
schemas.ts holds the whole renderer — schema expressions, the operationSchemas map,
and the module assembly; index.ts is the entry. Naming and literal escaping come from
the TypeScript printer (@redocly/client-generator/printers/typescript).
Ejecting it
redocly eject-generator zod copies this generator's TypeScript source folder to
generators/zod/, exactly as we wrote it, importing @redocly/client-generator and
@redocly/client-generator/printers/typescript. Running a .ts generator uses Node's
type stripping (Node 22.18, 23.6, or newer); newer built-in versions merge in per file
with --update. Change the schema shapes, the naming, or what gets a schema at all, and
regenerate.
The modify loop
- Edit this skill: state the new behavior or decision.
- Make
generators/zod/match it. - Run
redocly generate-clientand inspect thegit diffof the generated output — generated files are never hand-edited.
Newer built-in versions merge in with redocly eject-generator zod --update.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |