Redocly/redocly-cli / packages/client-generator/eject-assets/skills/transformers-generator
transformers-generator
VerifiedDesign of the ejected Redocly `transformers` client generator. Read it, and update it, before changing generators/transformers/.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 2.4 KB |
SKILL.md
View on GitHub---
name: transformers-generator
description: Design of the ejected Redocly `transformers` client generator. Read it, and update it, before changing generators/transformers/.
---
# The `transformers` generator — its skill
This file is the DESIGN of your ejected `transformers` generator (`generators/transformers/`):
**to change the generator, edit this skill first, then make the code match it** — a diff
to `generators/transformers/` that has no covering sentence here is incomplete.
## What it emits
Per-schema `to<Name>()` / `from<Name>()` converters that turn wire JSON into typed
values and back — the bridge for `dateType: Date` clients.
## Design decisions that must hold
- **Requires `dateType: Date`** (declared as `dateTypes: ['Date']`, so a mismatched
selection fails fast): the converters assign `Date` objects to fields the sdk types as
`Date`, which only type-checks in that mode.
- **Imports the sdk's schema TYPES** (so `typescript` is required) and nothing else.
- Converters are pure and total: every named schema gets a pair, nested structures
recurse, and a missing optional stays missing.
- **A transform takes response data.** A response never carries `writeOnly`
properties, so the sdk types it `Omit<Name, …>`. The transform of a schema with
`writeOnly` properties takes that shape and returns the type it was given:
`<T extends Omit<Name, …>>(input: T): T`. Other transforms keep `(data: Name): Name`.
## The stage files
`render.ts` holds the whole converter renderer; `index.ts` is the entry. Naming comes
from the TypeScript printer (`@redocly/client-generator/printers/typescript`).
## Ejecting it
`redocly eject-generator transformers` copies this generator's TypeScript source folder
to `generators/transformers/`, 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 which fields are converted, or how,
and regenerate.
## The modify loop
1. Edit this skill: state the new behavior or decision.
2. Make `generators/transformers/` match it.
3. Run `redocly generate-client` and inspect the `git diff` of the generated output —
generated files are never hand-edited.
Newer built-in versions merge in with `redocly eject-generator transformers --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: 322k | 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: 198k | 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: 198k | 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: 198k | Updated | Claude CodeCodex | Verified | Install |