vite-plugin-valibot-env

A Vite plugin to validate environment variables against a Valibot schema.

Why? 🤔

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 already makes it an ideal candidate for validation in the frontend. So why not use it in your development process as well?

Installation 💿

On NodeJS or Bun you can install from npm

npm install vite-plugin-valibot-env valibot

On Deno you can install using JSR

deno add jsr:@idleberg/vite-plugin-valibot-env valibot

Usage 🚀

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 schema = v.object({
	VITE_API_ENDPOINT: v.pipe(v.string(), v.url()),
	VITE_LOCALE: v.literal("en_US"),
});

export default defineConfig({
	plugins: [valibot(schema)],
});

API ⚙️

valibot(schema, options?)

Options

options.ignoreEnvPrefix

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.

options.transformValues

Type: boolean
Default: false

Setting this to true will try and transform certain string values to their respective types. Supports booleans, integers, floats, and null.

options.language

Type: string
Default: undefined

Language ID for localized error messages.

[!NOTE] When using this option, you need to install @valibot/i18n and import it into your Vite config.

options.onBeforeIssues

Type: function
Default: undefined

A callback function executed before any issues have been printed.

options.onAfterIssues

Type: function
Default: undefined

A callback function executed after all issues have been printed.

[!TIP] This can be useful to point collaborators to the documentation of your project's environment variables.

options.throwError

Type: boolean
Default: false

[!CAUTION] This option exists for testing purposes and is not recommended for other use.

Throws an error rather than exiting gracefully when issues have been found in the schema.

Related 👫

• esbuild-plugin-valibot-env

License ©️

This work is licensed under The MIT License.