docs: add vite plugin by mrlubos · Pull Request #3684 · hey-api/openapi-ts

mrlubos · 2026-04-04T08:13:15Z

bolt-new-by-stackblitz · 2026-04-04T08:13:18Z

Run & review this pull request in StackBlitz Codeflow.

pullfrog · 2026-04-04T08:13:19Z

Reviewed PR #3684. Found two minor issues in docs/openapi-ts/configuration/vite.md: an h3 heading (### About) that skips h2 and is inconsistent with sibling config pages, and a configuration link pointing to get-started instead of the configuration page. Submitted review with inline suggestions.

Task list (3/3 completed)

Read the full diff to understand all changes
Review each changed file for correctness and issues
Submit review or report progress

^{｜ View workflow run ｜ Triggered by Pullfrog ｜ 𝕏}

changeset-bot · 2026-04-04T08:13:19Z

⚠️ No Changeset found

Latest commit: 6b2c666

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

vercel · 2026-04-04T08:13:20Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
hey-api-docs	Ready	Preview, Comment	Apr 4, 2026 8:13am

pullfrog · 2026-04-04T08:14:28Z

TL;DR — Adds documentation for the @hey-api/vite-plugin package across the docs site and READMEs, and cleans up existing docs by replacing npm install with npm add and removing a Mintlify reference.

Key changes

Add @hey-api/vite-plugin documentation page — New docs/openapi-ts/configuration/vite.md with installation, usage, and inline config examples for the Vite plugin.
Add Vite plugin section to Get Started and README — Surfaces the Vite integration path early in onboarding docs alongside the existing CLI and programmatic usage sections.
Replace npm install with npm add — Standardizes install commands across docs and READMEs to use the shorter npm add alias.
Remove Mintlify reference from SDK plugin docs — Drops the Mintlify link from the examples display section, keeping only Scalar.
Add sidebar entry for Vite configuration page — Registers the new Vite page under the Configuration section in the VitePress navigation.

_{Summary ｜ 9 files ｜ 1 commit ｜ base: main ← docs/vite-plugin}

Vite plugin documentation

Before: No documentation existed for @hey-api/vite-plugin; users had to discover the package independently.
After: A dedicated configuration page at /openapi-ts/configuration/vite documents installation, basic usage with heyApiPlugin(), and inline config via the config option.

The new page follows the same structure as other configuration docs — features list, install code groups for all four package managers, and two usage examples (auto-detect config file vs. inline config). The Get Started page and packages/openapi-ts/README.md both gain a "Vite" subsection that introduces the plugin and links to the full page.

docs/openapi-ts/configuration/vite.md · docs/openapi-ts/get-started.md · packages/openapi-ts/README.md

`npm install` → `npm add` and Mintlify removal

Before: Several docs used npm install for package installation; SDK examples page referenced both Mintlify and Scalar.
After: All npm install commands use npm add; only Scalar is referenced as a documentation tool.

These are minor consistency and cleanup changes spread across the Nuxt client docs, migration guide, changelog, json-schema-ref-parser README, and the SDK plugin page.

docs/openapi-ts/clients/nuxt.md · docs/openapi-ts/migrating.md · docs/openapi-ts/plugins/sdk.md

^{｜ View workflow run ｜ Triggered by Pullfrog ｜ 𝕏}

codecov · 2026-04-04T08:15:11Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 39.39%. Comparing base (549a42e) to head (6b2c666).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3684   +/-   ##
=======================================
  Coverage   39.39%   39.39%           
=======================================
  Files         520      520           
  Lines       19279    19279           
  Branches     5708     5708           
=======================================
  Hits         7595     7595           
  Misses       9445     9445           
  Partials     2239     2239

Flag	Coverage Δ
unittests	`39.39% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

pullfrog

Docs look good overall — clean Vite plugin page and consistent npm install → npm add sweep. Two small heading/link nits below.

^{｜ Fix all ➔ ｜ Fix 👍s ➔ ｜ View workflow run ｜ 𝕏}

pullfrog · 2026-04-04T08:15:21Z

docs/openapi-ts/configuration/vite.md

+
+# Vite
+
+### About


### About (h3) directly under # Vite (h1) skips h2 and is inconsistent with the sibling config pages (input.md, output.md, parser.md), which all jump straight into ## sections after the h1. Consider either promoting this to ## About or dropping the heading and folding the two sentences into the intro paragraph under # Vite.

Suggested change

### About

## About

pullfrog · 2026-04-04T08:15:21Z

docs/openapi-ts/configuration/vite.md

+## Features
+
+- runs automatically as part of your Vite build
+- reads your existing [configuration](/openapi-ts/get-started) (or accepts inline config)


This links to /openapi-ts/get-started, but that page covers installation & quickstart, not the configuration file format. Line 61 of this same file already links correctly to /openapi-ts/configuration. Should this point there too?

Suggested change

- reads your existing [configuration](/openapi-ts/get-started) (or accepts inline config)

- reads your existing [configuration](/openapi-ts/configuration) (or accepts inline config)

pkg-pr-new · 2026-04-04T08:16:02Z

Open in StackBlitz

@hey-api/codegen-core

npm i https://pkg.pr.new/@hey-api/codegen-core@3684

@hey-api/json-schema-ref-parser

npm i https://pkg.pr.new/@hey-api/json-schema-ref-parser@3684

@hey-api/nuxt

npm i https://pkg.pr.new/@hey-api/nuxt@3684

@hey-api/openapi-ts

npm i https://pkg.pr.new/@hey-api/openapi-ts@3684

@hey-api/shared

npm i https://pkg.pr.new/@hey-api/shared@3684

@hey-api/spec-types

npm i https://pkg.pr.new/@hey-api/spec-types@3684

@hey-api/types

npm i https://pkg.pr.new/@hey-api/types@3684

@hey-api/vite-plugin

npm i https://pkg.pr.new/@hey-api/vite-plugin@3684

commit: 6b2c666

docs: add vite plugin

6b2c666

mrlubos marked this pull request as ready for review April 4, 2026 08:13

dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. docs 📃 Documentation updates. labels Apr 4, 2026

mrlubos mentioned this pull request Apr 4, 2026

Vite plugin docs & thoughts #1878

Closed

pullfrog bot reviewed Apr 4, 2026

View reviewed changes

mrlubos merged commit 8d3167c into main Apr 4, 2026
12 checks passed

mrlubos deleted the docs/vite-plugin branch April 4, 2026 08:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: add vite plugin#3684

docs: add vite plugin#3684
mrlubos merged 1 commit intomainfrom
docs/vite-plugin

mrlubos commented Apr 4, 2026

Uh oh!

bolt-new-by-stackblitz bot commented Apr 4, 2026

Uh oh!

pullfrog bot commented Apr 4, 2026 •

edited

Loading

Uh oh!

changeset-bot bot commented Apr 4, 2026

Uh oh!

vercel bot commented Apr 4, 2026

Uh oh!

pullfrog bot commented Apr 4, 2026

Uh oh!

codecov bot commented Apr 4, 2026 •

edited

Loading

Uh oh!

pullfrog bot left a comment

Uh oh!

pullfrog bot Apr 4, 2026

Uh oh!

pullfrog bot Apr 4, 2026

Uh oh!

pkg-pr-new bot commented Apr 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	- reads your existing [configuration](/openapi-ts/get-started) (or accepts inline config)
	- reads your existing [configuration](/openapi-ts/configuration) (or accepts inline config)

Uh oh!

Conversation

mrlubos commented Apr 4, 2026

Uh oh!

bolt-new-by-stackblitz bot commented Apr 4, 2026

Uh oh!

pullfrog bot commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Apr 4, 2026

⚠️ No Changeset found

Uh oh!

vercel bot commented Apr 4, 2026

Uh oh!

pullfrog bot commented Apr 4, 2026

Key changes

Vite plugin documentation

npm install → npm add and Mintlify removal

Uh oh!

codecov bot commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pullfrog bot left a comment

Choose a reason for hiding this comment

Uh oh!

pullfrog bot Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

pullfrog bot Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new bot commented Apr 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

pullfrog bot commented Apr 4, 2026 •

edited

Loading

`npm install` → `npm add` and Mintlify removal

codecov bot commented Apr 4, 2026 •

edited

Loading