vite-plugin-environment weekly downloads statistics

vite-plugin-environment

Expose environment variables to your client code in Vite.js

Why? 🤔

Although [Vite.js] provides its [own mechanism][meta env] for exposing environment variables through [import.meta.env][meta env], sometimes it's not possible or desirable to prefix variables with VITE_.

This plugin is a shorthand for exposing environment variables by configuring [define].

It provides the same functionality as webpack's [EnvironmentPlugin], but for Vite.js.

Installation 💿

Install the package as a development dependency:

Usage 🚀

You can provide a list of environment variable names to expose to your client code:

And then use them as:

Usage with default values

You may instead provide an object which maps keys to their default values.

The default value for a key is only used if the variable is not defined.

Use null for optional variables, or undefined for variables that must be provided.

Configuration ⚙️

Have in mind that you can add the plugin several times—passing different options to load different sets of variables.

Loading prefixed variables

In some cases, it's useful to load all environment variables with a certain prefix.

You can achieve that by passing 'all' and providing the prefix option.

and then use it as usual:

Exposing variables differently

When porting apps to Vite or using SSR it can be useful to expose variables in process.env, which is the default.

In other cases, you may use the defineOn option to expose them in a different object, such as import.meta.env.

and then use it as:

Ignoring .env files

By default the plugin will load .env files using the same [strategy][meta env] as Vite.js.

If you want to ignore .env files and only use values in process.env, you can opt out:

Inside the box 📦

The first example in this README is equivalent to [manually configuring][define]:

except it will also use any variables provided by your .env files, and will fail if any of the specified variables is _not defined_.

Acknowledgements

I created this library only because I wanted something that:

• Reused Vite's loadEnv functionality, making the library _very_ light (no dependencies). • Allowed to provide a subset of variables to expose, and their defaults.

The following libraries might be helpful depending on your use case:

• [vite-plugin-env-compatible]: Convenient if you are porting a Vue CLI or create-react-app.

License

This library is available as open source under the terms of the MIT License.

Description from the npm listing.