Skip to content

Redocly/redocly-cli / packages/client-generator/eject-assets/skills/mock-generator

mock-generator

Verified

Design of the ejected Redocly `mock` client generator. Read it, and update it, before changing generators/mock/.

FileKindSize
SKILL.mdskill md3.9 KB
---
name: mock-generator
description: Design of the ejected Redocly `mock` client generator. Read it, and update it, before changing generators/mock/.
---

# The `mock` generator — its skill

This file is the DESIGN of your ejected `mock` generator (`generators/mock/`):
**to change the generator, edit this skill first, then make the code match it** — a diff
to `generators/mock/` that has no covering sentence here is incomplete.

## What it emits

A standalone MSW module: `create<Name>()` data factories, `<op>Handler()` /
`<op>ErrorHandler(status, body?)` request handlers, and a `handlers` array.

## Design decisions that must hold

- **Two data modes:** `mockData: static` bakes deterministic samples from the schema
  (examples/defaults first); `faker` emits `faker.*` calls with a seed (`mockSeed`) so
  runs are reproducible.
- **Interpolated identifiers are gated** (`codeIdent`): an operation name or method
  reaching a code position is validated, never trusted, even though the pipeline
  sanitizes upstream.
- **Mock data satisfies the description** it came from, so it passes the zod schemas
  generated from the same description:
  - Numeric samples respect `minimum`, `maximum`, `exclusiveMinimum`,
    `exclusiveMaximum`, and `multipleOf`. A static sample is `0` when `0` is in range,
    else the lowest valid value (the highest one when only an upper bound is set).
    Faker mode passes the same inclusive range to `faker.number.*`; when only one side
    is set, the other side is 100 steps away, because faker's own defaults can sit on
    the wrong side of the bound.
  - Mocks are response data, and responses never carry `writeOnly` properties. An
    optional one is never emitted. A required one stays in the factories, because the
    named type (and its zod schema) demands it. A handler whose response leaves the
    `writeOnly` properties out (an `omit` body) samples that shape inline, typed
    `Partial<Omit<Name, …>>`, so its body leaves them out too.
  - The default handler of a paginated operation ends the walk. A cursor page is the
    last page: the next cursor is `null` when nullable, absent when optional, and `""`
    otherwise, and `hasMore` is `false`. A `body-link` page is the last page the same
    way, through its next link. So `.pages()` ends after one page. Offset and
    page-number styles stop only on an empty page, so the handler answers any position
    past the first with an empty item list, and `.pages()` ends after that empty page.
    The handler's `override` sets the first page: it is spread into an object page, or
    replaces a page that is the item array. The empty page sets its items after the
    spread, so an override cannot refill it.
- Handlers are opt-in overrides: `<op>ErrorHandler` is NOT in `handlers`.
- The module references the sdk's TYPES only — never its runtime.

## The stage files

`render.ts` assembles the module (factories, handlers, the `handlers` array);
`sample.ts` bakes deterministic sample values from the schema, `values.ts` renders the
data trees, and `faker.ts` emits the faker-mode expressions. `index.ts` is the entry.

## Ejecting it

`redocly eject-generator mock` copies this generator's TypeScript source folder to
`generators/mock/`, exactly as we wrote it, importing `@redocly/client-generator`,
`@redocly/client-generator/printers/typescript`, and `@redocly/openapi-core`. 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 data strategy, the handler shape,
or the factory surface, and regenerate.

## The modify loop

1. Edit this skill: state the new behavior or decision.
2. Make `generators/mock/` 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 mock --update`.
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: 322kUpdated Claude CodeCodexVerifiedInstall
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: 198kUpdated Claude CodeCodexVerifiedInstall
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: 198kUpdated Claude CodeCodexVerifiedInstall
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: 198kUpdated Claude CodeCodexVerifiedInstall