Vite Plus Best Practices

Vite+ Best Practices

Apply these rules when setting up, writing, reviewing, or migrating a Vite+ project — configuring vite.config.ts, running vp commands, or wiring Vite+ into CI / coding agents.

Done when: every touched package uses vite-plus / vite-plus/test imports where required (exceptions: non-config vite imports via the core alias; @nuxt/test-utils packages keeping upstream vitest; pnpm direct vite entries aliased to core — leave those); no legacy per-tool config remains unless a documented exception applies; upgrade/migrate followed the vp migrate path; and vp check && vp test plus vp build (apps) or vp pack (libs/CLIs) pass.

Vite+ is a unified toolchain: one CLI and one config file replace the usual split of Vite, Vitest, ESLint/Oxlint, Prettier/Oxfmt, tsdown, lint-staged, and a task runner.

Setup

Fastest path to a working project. Full details in setup.md (install, env, deps, create, upgrade).

# 1. Install the global vp CLI (once per machine)
curl -fsSL https://vite.plus | bash      # macOS / Linux
irm https://vite.plus/ps1 | iex          # Windows (PowerShell)

# 2. Open a NEW shell, then verify
vp help

# 3a. New project
vp create                                # interactive scaffold
vp install                               # install dependencies

# 3b. OR migrate an existing project (Vite 8+ / Vitest 4.1+ required first)
vp migrate --no-interactive

Daily loop (humans, CI, agents):

vp dev        # dev server (Vite)
vp check      # format + lint + type-check, one pass
vp test       # tests (single run — watch is opt-in)
vp build      # production build (apps) — use vp pack for libs/CLIs

• CI install: use the setup-vp GitHub Action (prefer it over the shell installer in CI).
• Managed runtime: vp manages node / package managers by default (vp env on). Use vp env off for system-first, vp implode to fully remove Vite+.

Golden Rules

High-leverage rules. Each links to deeper reference.

1. Unified config. Everything lives in a single vite.config.ts using blocks (server, build, preview, test, lint, fmt, check, run, pack, staged, create). Put tool settings in those blocks — not in vitest.config.ts, tsdown.config.ts, oxlint.config.*, .oxfmtrc.*, .prettierrc, eslint.config.*, or lint-staged.config.*. → config.md
2. Import from vite-plus for config and tests. Config: import { defineConfig } from 'vite-plus'. Tests: import { … } from 'vite-plus/test' (browser context: vite-plus/test/browser/context). Rewrite nuances, Nuxt, and pnpm vite pins: → monorepo-and-migration.md
3. Built-in ≠ script. vp build / vp test / vp dev always run the bundled tool. To run a same-named package.json script, use vp run <name> (alias vpr). → commands.md
4. vp check is the validation command. It dedupes Oxfmt + Oxlint + type-check (tsgolint/tsgo). Prefer it over chaining standalone vp lint / vp fmt / tsc --noEmit. Keep lint.options.typeAware and typeCheck on. Use the check block to set default skip flags. → config.md
5. vp build for apps, vp pack for libraries/CLIs. Package libraries with vp pack. → config.md
6. Migrate, then verify. Run vp migrate (also the recommended local upgrade path), confirm import rewrites, remove obsolete vitest / @vitest/browser* only where migrate allows (keep intentional pnpm vite→core entries), finally vp install && vp check && vp test plus vp build (apps) or vp pack (libs/CLIs). Prefer vp migrate over hand-updating aliases. → monorepo-and-migration.md

Reference Map

Load on demand: