@universal-deploy/vite

@universal-deploy/vite

Automatically enables the Node.js adapter if no other deployment target (Vercel, Cloudflare, Netlify) is detected in the Vite configuration.

Installation

pnpm add -D @universal-deploy/vite

Usage

Add the universalDeploy plugin to your vite.config.ts:

import universalDeploy from "@universal-deploy/vite";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [
    universalDeploy(),
    // ... other plugins
  ],
});

Are you a framework developer? Read the Framework Developer Guide to learn how to integrate @universal-deploy/vite into your framework.

How it works

The universalDeploy() plugin detects the presence of other deployment adapters in your Vite configuration. If any of the following plugins are found, it automatically disables its own Node.js adapter injection:

• vite-plugin-vercel
• @cloudflare/vite-plugin
• @netlify/vite-plugin (also requires @universal-deploy/netlify for compatibility)

If none of these are present, it enables @universal-deploy/node to provide a default Node.js-compatible server build.

Options

The universalDeploy() plugin accepts the following options:

• node: Same options as the @universal-deploy/node adapter:
  • static: (string | boolean) The directory containing static assets. Defaults to the client output directory.
  • importer: (string) The importer to use when resolving the server entry.
  • precompress: (boolean | object) Emit .br/.gz variants of the static assets at build time and serve those instead of compressing per request. Off by default; see the adapter README.
• entry: (string) Relative or absolute path to override the default server entry.