JSPM

vite-plugin-vue-env

1.0.6
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 160
  • Score
    100M100P100Q73287F
  • License MIT

Provide VUE_APP_ env variables to VITE app

Package Exports

  • vite-plugin-vue-env
  • vite-plugin-vue-env/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vite-plugin-vue-env) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Vite-plugin-vue-env

Provide VUE_APP_* env variables to Vite app.

Installation

npm i -D vite-plugin-vue-env

vite.config.ts

import { defineConfig } from 'vite';
import pluginEnv from 'vite-plugin-vue-env';

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

Add .env file with any VUE_APP_*

Configuration

pluginEnv(variables?, options?)

Variables

Additional variables that will be 'added' to the code, next to .env

  • type: object
  • default: {}
pluginEnv({
  APP_ENV: 'development'
})

// [in code] > console.log(process.env.APP_ENV)

Options

  • fileRegexp: Use this plugin only on files that match this regexp

    • type: RegExp
    • default: /\.(m?jsx?|tsx?|vue)$/i
    pluginEnv({}, {
      fileRegexp: /\.js$/i, // the plugin will be available only in .js files
    })
  • getEnvFullName: Customize replaceable string

    • type: function
    • default: (name: string) => 'process.env.${name}'
    pluginEnv({}, {
      getEnvFullName: (name: string) => `ENV.${name}`,
    })
    
    // [in code] > console.log(ENV.VUE_APP_ENDPOINT)
  • variablePrefix: Customize variable prefix

    • type: string
    • default: VUE_APP_
    pluginEnv({}, {
      variablePrefix: 'VUE_',
    })
    
    // [in code] > console.log(process.env.VUE_ENDPOINT)
  • debug: Print all variables to the console

    • type: boolean
    • default: false

How it works

Simple, maybe stupid

code.replace('process.env.var', 'value')