vite-plugin-meta-env-inject

【中文】 | 【English】

简介

vite-plugin-meta-env-inject 是一个 Vite 插件，用于将 package.json 中的版本信息和其他元数据自动注入到 import.meta.env 中，使您能够在应用程序中轻松访问这些信息。

功能特性

• 自动从 package.json 注入版本号到 import.meta.env
• 支持自定义数据注入
• 可配置的环境变量前缀
• 支持 TypeScript
• 轻量级，零依赖

安装

npm install vite-plugin-meta-env-inject -D

使用方法

基本使用

在 vite.config.ts 中添加插件：

import { defineConfig } from 'vite';
import metaEnvInject from 'vite-plugin-meta-env-inject';

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

然后在您的代码中访问版本信息：

console.log(import.meta.env.VITE_APP_VERSION); // 输出 package.json 中的版本号

高级配置

import { defineConfig } from 'vite';
import metaEnvInject from 'vite-plugin-meta-env-inject';

export default defineConfig({
	plugins: [
		metaEnvInject({
			// package.json 路径
			packageJsonPath: './package.json',

			// package 包变量键名前缀
			prefixPackageKey: 'VITE_APP_',

			// 环境变量键名前缀
			prefixKey: 'VITE_',

			// 自定义参数
			customData: {
				BUILD_DATE: new Date().toISOString(),
				ENVIRONMENT: 'production'
			},

			// 自定义版本号
			version: '1.0.0'
		})
	]
});

配置选项

| 选项 | 类型 | 默认值 | 描述 | | ------------------ | --------------------- | ---------------------------- | ------------------------- | | packageJsonPath | string | process.cwd()/package.json | package.json 文件的路径 | | prefixPackageKey | string | VITE_APP_ | package 包变量键名前缀 | | prefixKey | string | VITE_ | 环境变量键名前缀 | | customData | Record<string, any> | undefined | 自定义参数 | | version | string | undefined | 自定义版本号 |

API

metaEnvInject(options)

创建 Vite 插件实例。

参数

• options (Options, optional): 插件配置选项

返回值

• PluginOption: Vite 插件实例

示例

查看 example 目录获取完整示例。

许可证

MIT