vite-plugin-domain

2.0.5 verified Mon Apr 27 auth: no javascript

Vite plugin that automatically configures a local domain via Caddy for your dev server. Current version 2.0.5. Active maintenance with TypeScript types. Generates domain names from folder or package.json, sets up Caddy reverse proxy with HTTPS, and shares one Caddy instance across projects. Key differentiator: eliminates localhost port confusion for multi-app development.

Common errors

error ERR_PACKAGE_PATH_NOT_EXPORTED: Package import specifier "vite-plugin-domain" is not defined ↓

cause Missing default export or using named import incorrectly.

fix

Use default import: import domain from 'vite-plugin-domain'

error Error: Cannot find module 'vite-plugin-domain' ↓

cause Package not installed.

fix

pnpm add -D vite-plugin-domain

error Error: connect ECONNREFUSED 127.0.0.1:2019 ↓

cause Caddy admin API not running.

fix

Run 'caddy run' in terminal.

Warnings

breaking Version 2.0 removed default domain generation; now uses folder or package name. ↓

fix Update configuration with nameSource or explicit domain.

gotcha Caddy must be running separately with admin API enabled. ↓

fix Run 'caddy run' before starting Vite.

gotcha Using .local TLD may require /etc/hosts entry to avoid mDNS conflicts. ↓

fix Add '127.0.0.1 yourdomain.local' to /etc/hosts.

gotcha Node.js 18+ required; older versions fail to import. ↓

fix Upgrade Node to >=18.

Install

npm install vite-plugin-domain

yarn add vite-plugin-domain

pnpm add vite-plugin-domain

Imports

default

wrong

import { domain } from 'vite-plugin-domain'

correct

import domain from 'vite-plugin-domain'

Default export only. Named import will fail.

default

wrong

const { domain } = require('vite-plugin-domain')

correct

const domain = require('vite-plugin-domain')

CJS require works, but wrong destructuring.

VitePluginDomainOptions

import type { VitePluginDomainOptions } from 'vite-plugin-domain'

Type is exported for configuration.

Quickstart

Basic setup: imports vite-plugin-domain and adds plugin to Vite config.

// vite.config.ts
import { defineConfig } from 'vite'
import domain from 'vite-plugin-domain'

export default defineConfig({
  plugins: [
    domain()
  ]
})