npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vite-plugin-valibot-env

v0.9.2

Published

A Vite plugin to validate environment variables against a Valibot schema

Downloads

785

Readme

vite-plugin-valibot-env

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

License Version: npm Version: jsr CI: Node CI: Deno

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

Installation

npm install -D 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),
	]
});

[!TIP] You might want to use loadEnv in your configuration to load .env files.

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 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 after any issues have been printed.

options.onAfterIssues

Type: function
Default: undefined

A callback function executed after all issues have been printed.

[!TIP] You could use this 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 use.

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

Related

License

This work is licensed under The MIT License.