A Vite plugin to validate environment variables against a Valibot schema.
It's generally a good idea to check that you're all set up early in the development process. Validating that your environment variables have been defined and are of the expected type is a part of that – for yourself and your colleagues. While there are many libraries to validate against a schema, Valibot stands out for its versatility and modularity. The small footprint makes it an ideal candidate for validation in the frontend. So why not use it in your development process as well?
npm install -D vite-plugin-valibot-env valibot
Let's start with a very basic example
import { defineConfig } from 'vite';
import * as v from 'valibot';
import valibot from 'vite-plugin-valibot-env';
const envSchema = v.object({
VITE_API_ENDPOINT: v.pipe(v.string(), v.url()),
VITE_LOCALE: v.literal('en_US'),
});
export default defineConfig({
plugins: [
valibot(envSchema),
]
});valibot(schema, options?)
Type: Boolean
Default: false
Setting this to true will also validate unprefixed environment variables.
Tip
Vite uses a prefix to prevent leaking all environment variables into your code. The same limitation applies to the validator. However, there might be use cases where you want validate unprefixed environment variables as well, e.g. HOST and PORT to configure the Vite server.
Type: Boolean
Default: false
Setting this to true will try and transform string values to their respective types. Supports booleans, integers, floats, and null.
This work is licensed under The MIT License.