https://github.com/sullay/vite-plugin-custom-env
https://github.com/sullay/vite-plugin-custom-env
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sullay/vite-plugin-custom-env
- Owner: sullay
- License: mit
- Created: 2023-11-23T02:32:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-23T06:55:48.000Z (over 2 years ago)
- Last Synced: 2025-09-07T14:59:36.843Z (9 months ago)
- Language: TypeScript
- Size: 7.81 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
vite-plugin-env
`vite-plugin-env` is a Vite plugin designed to simplify the integration and management of environment variables in your Vite projects. It allows you to define and access environment variables efficiently, supporting both arrays and object maps for flexible configuration.
## Features
- Seamless integration of environment variables into Vite projects.
- Supports both arrays and object maps for defining environment variables.
- Easy to configure and use.
## Installation
To install the plugin, you can use npm or yarn:
```bash
npm install vite-plugin-custom-env -D
# or
yarn add vite-plugin-custom-env -D
# or
pnpm add vite-plugin-custom-env -D
```
## Usage
First, import the plugin in your Vite configuration file:
``` js
import { VitePluginEnv } from 'vite-plugin-custom-env';
```
Then, you can use it in your Vite configuration:
``` js
// vite.config.js
import { defineConfig } from 'vite';
import { VitePluginEnv } from 'vite-plugin-custom-env';
export default defineConfig({
plugins: [VitePluginEnv(/* options here */)]
});
```
Options
VitePluginEnv accepts either an array of strings (keys of environment variables), an object map, or undefined. If undefined, all process environment variables will be included.
``` js
VitePluginEnv(['VITE_API_ENDPOINT', 'VITE_APP_TITLE'])
```
Using Object Map
``` js
VitePluginEnv({
'VITE_API_ENDPOINT': 'https://api.example.com',
'VITE_APP_TITLE': 'My Vite App'
})
```
## License
This project is licensed under the MIT License - see the LICENSE file for details.