Vite konfigurieren
Wenn Sie vite von der Kommandozeile aus starten, wird Vite automatisch versuchen, eine Konfigurationsdatei namens vite.config.js im Projektstamm aufzulösen (andere JS- und TS-Erweiterungen werden ebenfalls unterstützt).
Die einfachste Konfigurationsdatei sieht wie folgt aus:
export default {
// config options
}Anmerkung: Um die ES-Module-Syntax in der Konfigurationsdatei zu verwenden, muss sie sich in einer Datei befinden, die Node.js als ESM erkennt, z. B. .mjs oder .js mit "type": "module" in der nächstgelegenen package.json.
Sie können auch explizit eine Konfigurationsdatei angeben, die mit der CLI-Option --config verwendet wird (aufgelöst relativ zu cwd):
vite --config my-config.jsLaden der Konfiguration
Standardmäßig nutzt Vite Rolldown, um die Konfiguration in einer temporären Datei zu bündeln und zu laden. Wenn Sie eine Umgebung mit TypeScript-Support nutzen (z. B. Node 22.18+) oder nur schlichtes JavaScript verwenden, können Sie die Option --configLoader native angeben, um die native Laufzeitumgebung zum Laden der Konfiguration zu verwenden. configLoader: 'native' soll in einer zukünftigen Major-Version zum Standard werden.
Intellisense-Konfiguration
Da Vite mit TypeScript-Typisierungen ausgeliefert wird, können Sie die Intellisense Ihrer IDE mit JSDoc-Typ-Hinweisen nutzen:
/** @type {import('vite').UserConfig} */
export default {
// ...
}Alternativ können Sie die Hilfe defineConfig verwenden, die Intellisense ohne die Notwendigkeit von JSDoc-Annotationen bieten sollte:
import { defineConfig } from 'vite'
export default defineConfig({
// ...
})Vite unterstützt auch TypeScript-Konfigurationsdateien. Sie können vite.config.ts mit der obigen Hilfsfunktion defineConfig oder mit dem Operator satisfies verwenden:
import type { UserConfig } from 'vite'
export default {
// ...
} satisfies UserConfigBedingte Konfigurationen
Wenn die Konfiguration Optionen basierend auf dem Befehl (serve oder build), dem mode, der verwendet wird, wenn es ein SSR-Build ist (isSsrBuild) oder eine Vorschau des Builds ist (isPreview), bestimmen muss, kann sie stattdessen eine Funktion exportieren:
export default defineConfig(({ command, mode, isSsrBuild, isPreview }) => {
if (command === 'serve') {
return {
// dev specific config
}
} else {
// command === 'build'
return {
// build specific config
}
}
})Es ist wichtig zu beachten, dass in der API von Vite der Wert command während der Entwicklung serve ist (im Cli sind vite, vite dev und vite serve Aliase), und build bei der Erstellung für die produktive Umgebung (vite build).
isSsrBuild und isPreview sind zusätzliche optionale Flags, um die Art der build bzw. serve Befehle zu unterscheiden. Einige Werkzeuge, die die Vite-Konfiguration laden, unterstützen diese Flags möglicherweise nicht und übergeben stattdessen undefined. Daher wird empfohlen, explizite Vergleiche gegen true und false zu verwenden.
Asynchrone Konfiguration
Wenn die Konfiguration asynchrone Funktionen aufrufen muss, kann sie stattdessen eine asynchrone Funktion exportieren. Und diese asynchrone Funktion kann auch durch defineConfig für verbesserte Intellisense-Unterstützung übergeben werden:
export default defineConfig(async ({ command, mode }) => {
const data = await asyncFunction()
return {
// vite config
}
})Umgebungsvariablen in der Konfiguration verwenden
Während der Auswertung der Konfiguration selbst stehen nur diejenigen Umgebungsvariablen zur Verfügung, die bereits in der aktuellen Prozessumgebung (process.env) vorhanden sind. Vite verschiebt das Laden von .env*-Dateien bewusst auf einen Zeitpunkt nach der Auflösung der Benutzerkonfiguration, da die zu ladenden Dateien von Konfigurationsoptionen wie root und envDir sowie vom endgültigen mode abhängen.
Das bedeutet, während Ihre vite.config.* ausgeführt wird, werden Variablen definiert in .env, .env.local, .env.[mode], or .env.[mode].local nicht automatisch in process.env injiziert. Sie werden später automatisch geladen und via import.meta.env (mit dem standardmäßigen VITE_-Präfixfilter) wie dokumentiert in Umgebungsvariablen und Modi für den Anwendungscode bereitgestellt. Wenn Sie also nur Werte aus .env*-Dateien für die App bereitstellen müssen, brauchen Sie nichts in der Konfiguration aufrufen.
Beachten Sie, dass Vite die .env-Dateien nicht standardmäßig lädt, da die zu ladenden Dateien nur nach Auswertung der Vite-Konfiguration bestimmt werden können, zum Beispiel beeinflussen die Optionen root und envDir das Ladeverhalten. Sie können jedoch die exportierte loadEnv-Hilfe verwenden, um die spezifische .env-Datei zu laden, falls erforderlich.
import { defineConfig, loadEnv } from 'vite'
export default defineConfig(({ mode }) => {
// Load env file based on `mode` in the current working directory.
// Set the third parameter to '' to load all env regardless of the
// `VITE_` prefix.
const env = loadEnv(mode, process.cwd(), '')
return {
define: {
// Stellen Sie eine explizite Konstante auf App-Ebene bereit, die aus einer Umgebungsvariablen abgeleitet wird.
__APP_ENV__: JSON.stringify(env.APP_ENV),
},
// Beispiel: Verwendung einer Umgebungsvariable, um den Port des Dev-Servers bedingt zu setzen
}
})Debugging der Konfigurationsdatei in VS Code
Die zuverlässigste Debugging-Erfahrung erhalten Sie, wenn Sie Vite mit dem nativen Config-Loader starten:
vite --configLoader nativeDer native Loader führt die ursprüngliche Konfigurationsdatei direkt aus, sodass Haltepunkte in der Konfigurationsdatei und in Plugin-Hooks wie transform auf den ursprünglichen Quellcode abgebildet werden. Er erfordert eine Laufzeitumgebung, die die in Ihrer Konfigurationsdatei verwendete Syntax unterstützt, etwa Node.js 22.18+ für TypeScript-Dateien.
Bei Verwendung von --configLoader bundle (derzeit der Standard, wobei native in einer zukünftigen Major-Version zum Standard werden soll) erzeugt Vite eine Inline-Sourcemap und schreibt die gebündelte Konfiguration vor dem Laden nach node_modules/.vite-temp. Wenn Sie den Bundle-Loader verwenden müssen, fügen Sie das temporäre Verzeichnis für das JavaScript Debug Terminal in .vscode/settings.json hinzu:
{
"debug.javascript.terminalOptions": {
"resolveSourceMapLocations": [
"${workspaceFolder}/**",
"!**/node_modules/**",
"**/node_modules/.vite-temp/**"
]
}
}Diese Einstellung gilt nur für das JavaScript Debug Terminal und wirkt sich nicht auf Startkonfigurationen aus, die über die Ansicht „Ausführen und Debuggen“ gestartet werden. Um dies auch für die Ansicht „Ausführen und Debuggen“ zu unterstützen, fügen Sie das temporäre Verzeichnis in .vscode/launch.json hinzu:
{
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Vite",
"runtimeExecutable": "npm",
"runtimeArgs": ["exec", "vite", "--configLoader", "bundle"],
"console": "integratedTerminal",
"sourceMaps": true,
"resolveSourceMapLocations": [
"${workspaceFolder}/**",
"!**/node_modules/**",
"**/node_modules/.vite-temp/**"
]
}
]
}