Merge pull request #3776 from hey-api/feat/vite-plugin-api

feat: expose vite options

Author: mrlubos

.changeset/ten-candles-stick.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/vite-plugin": patch
+---
+
+**api**: expose `vite` options

.vscode/tasks.json

@@ -8,7 +8,10 @@
       "args": ["turbo", "run", "build", "--filter=@hey-api/openapi-ts"],
       "group": "build",
       "problemMatcher": ["$tsc"],
-      "presentation": { "reveal": "silent", "close": true }
+      "presentation": {
+        "reveal": "silent",
+        "close": true
+      }
     },
     {
       "label": "build:openapi-python",
@@ -17,7 +20,10 @@
       "args": ["turbo", "run", "build", "--filter=@hey-api/openapi-python"],
       "group": "build",
       "problemMatcher": ["$tsc"],
-      "presentation": { "reveal": "silent", "close": true }
+      "presentation": {
+        "reveal": "silent",
+        "close": true
+      }
     }
   ]
 }

docs/openapi-ts/configuration/vite.md

@@ -1,6 +1,6 @@
 ---
 title: Vite Plugin
-description: Integrate @hey-api/openapi-ts into your Vite build pipeline with the official Vite plugin.
+description: Integrate @hey-api/openapi-ts into your Vite 5, 6, 7, or 8 build pipeline with the official Vite plugin.
 ---
 
 # Vite
@@ -15,7 +15,7 @@ The Vite plugin integrates `@hey-api/openapi-ts` into the Vite build pipeline, r
 
 - runs automatically as part of your Vite build
 - reads your existing [configuration](/openapi-ts/get-started) (or accepts inline config)
-- works with any Vite-based project
+- supports Vite 5, 6, 7, and 8
 
 ## Installation
 
@@ -62,7 +62,7 @@ The plugin will automatically pick up your [configuration](/openapi-ts/configura
 
 ::: code-group
 
-```ts [vite.config.ts]
+```js [vite.config.ts]
 import { heyApiPlugin } from '@hey-api/vite-plugin';
 import { defineConfig } from 'vite';
 
@@ -80,5 +80,32 @@ export default defineConfig({
 
 :::
 
+## Vite Options
+
+You can pass Vite Plugin API options using the `vite` option. For example, to run the plugin only during development:
+
+::: code-group
+
+```js [vite.config.ts]
+import { heyApiPlugin } from '@hey-api/vite-plugin';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  plugins: [
+    heyApiPlugin({
+      config: {
+        input: 'hey-api/backend',
+        output: 'src/client',
+      },
+      vite: {
+        apply: 'serve',
+      },
+    }),
+  ],
+});
+```
+
+:::
+
 <!--@include: ../../partials/examples.md-->
 <!--@include: ../../partials/sponsors.md-->

docs/openapi-ts/get-started.md

@@ -107,7 +107,7 @@ createClient({
 
 ### Vite
 
-If you're using [Vite](https://vite.dev), you can integrate `@hey-api/openapi-ts` directly into your build pipeline with `@hey-api/vite-plugin`. Install it alongside the main package:
+If you're using [Vite](https://vite.dev) 5, 6, 7, or 8, you can integrate `@hey-api/openapi-ts` directly into your build pipeline with `@hey-api/vite-plugin`. Install it alongside the main package:
 
 ::: code-group
 

packages/vite-plugin/README.md

@@ -32,7 +32,7 @@ Part of the Hey API ecosystem.
 
 - runs automatically as part of your Vite build
 - reads your existing configuration (or accepts inline config)
-- works with any Vite-based project
+- supports Vite 5, 6, 7, and 8
 - [sync with Hey API Registry](https://heyapi.dev/openapi-ts/integrations) for spec management
 
 <!-- template-contributing-start -->

packages/vite-plugin/package.json

@@ -55,6 +55,7 @@
     "vite": "8.0.8"
   },
   "peerDependencies": {
-    "@hey-api/openapi-ts": "<2"
+    "@hey-api/openapi-ts": "<2",
+    "vite": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0"
   }
 }

packages/vite-plugin/src/index.ts

@@ -1,16 +1,24 @@
 import { createClient } from '@hey-api/openapi-ts';
+import type { Plugin } from 'vite';
 
-export function heyApiPlugin(options?: {
+export interface HeyApiPluginOptions {
   /**
    * `@hey-api/openapi-ts` configuration options.
    */
   config?: Parameters<typeof createClient>[0];
-}) {
+  /**
+   * Vite plugin API options.
+   */
+  vite?: Omit<Plugin, 'configResolved' | 'name'>;
+}
+
+export function heyApiPlugin(options?: HeyApiPluginOptions): Plugin {
   return {
-    configResolved: async () => {
+    enforce: 'pre',
+    ...options?.vite,
+    async configResolved() {
       await createClient(options?.config);
     },
-    enforce: 'pre',
     name: 'hey-api-plugin',
   };
 }

packages/vite-plugin/tsdown.config.ts

@@ -5,6 +5,9 @@ export default defineConfig({
     ignoreRules: ['cjs-resolves-to-esm'],
     profile: 'esm-only',
   },
+  deps: {
+    neverBundle: ['vite'],
+  },
   publint: true,
   sourcemap: true,
 });