envGuard(options)
ts
envGuard({
schema: {
VITE_API_URL: { pattern: /^https:\/\//, description: "HTTPS API base URL" },
VITE_STAGE: { values: ["development", "production"] },
OPTIONAL_TOKEN: { required: false },
},
onInvalid: "error",
});Rules support required, allowEmpty, pattern, values, and custom validate. Diagnostics contain variable names and failure reasons only, never actual values.
envGuard Validate
Validates environment variables before Vite startup/build to expose missing configuration early.
Signature
ts
export function envGuard(options: EnvGuardPluginOptions): Plugin;Example
ts
import { envGuard } from "fast-vite-plugins";
const plugin = envGuard({ schema: { VITE_API_URL: { required: true, pattern: /^https:\/\// } } });
export default { plugins: [plugin] };Input
| Input | Type | Required / default | Description |
|---|---|---|---|
options | EnvGuardPluginOptions | Required | Environment schema, skipped modes, and failure behavior. |
Returns
| Value | Type | Description |
|---|---|---|
plugin | Plugin | Environment-validation plugin for Vite plugins. |
