Skip to content

Clarify the Performance section benchmarks directory mode - #161

Closed
stijnvanhulle wants to merge 1 commit into
mainfrom
claude/migration-guide-timing-validation-1dnhvc
Closed

Clarify the Performance section benchmarks directory mode#161
stijnvanhulle wants to merge 1 commit into
mainfrom
claude/migration-guide-timing-validation-1dnhvc

Conversation

@stijnvanhulle

Copy link
Copy Markdown
Contributor

🎯 Changes

A reader flagged that a separate hey-api/orval benchmark (not published here) reported a ~2.6x v4-vs-v5 speedup on the same big spec where this page says "up to 5x," and asked whether the two numbers conflict.

They don't, but the migration guide's wording didn't make why obvious. "Both versions writing to a fresh directory" reads as just "a clean output folder," when the real point is that scripts/benchmark/v4-vs-v5 runs every plugin in output.mode: 'directory' (one file per schema/operation) on both v4 and v5. Validated by actually running both kubb v4 and v5 in both file mode and directory mode on the same fixtures: switching both to kubb's default file mode makes both versions slower, but costs v5 disproportionately more (2.5x slower in file mode vs. v4's 1.3x slower), which is most of the difference between the "up to 5x" here and a flatter, smaller number in file mode. This PR spells that out in the Performance section's intro paragraph instead of leaving the mode choice implicit.

No numbers in the guide changed, this is a wording clarification.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I am using USA English (serialize, color, center, canceled, analyze, license).
  • I ran the humanizer check on any new documentation I wrote.

Generated by Claude Code

"writing to a fresh directory" read as just a clean output folder,
not output.mode: 'directory' on every plugin. Spells that out and
notes that switching to kubb's default file mode changes the numbers
substantially, since it costs v5 more than v4, validated against a
real run of both modes.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019xRkYw3bDucJ342j15p9yg
@changeset-bot

changeset-bot Bot commented Jul 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: f9f6c59

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants