@vsilk/vite-plugin-extract-config
v1.0.1
Published
用来提取配置文件的插件,可在外部修改应用的配置
Downloads
1
Readme
@vsilk/vite-plugin-extract-config
@vsilk/vite-plugin-extract-config
是一个用于构建模式下的插件包,旨在从环境变量中提取具有指定前缀的变量,并将其保存到一个独立的文件中,以便于维护。通过这个插件,你可以轻松地管理和组织你的环境相关的配置信息。
安装
你可以使用 pnpm 或者 yarn 来安装 @vsilk/vite-plugin-extract-config
插件包。
使用 pnpm:
pnpm add @vsilk/vite-plugin-extract-config -D
使用 yarn:
yarn add @vsilk/vite-plugin-extract-config -D
参数说明
viteExternalConfigPlugin(options)
Options
| 参数 | 类型 | 默认值 | 说明 |
|------------|-----------|----------------|----------------------------------------------------------|
| enabled | boolean
| true | 是否启用插件。当设置为 true
时,插件将会起作用;当设置为 false
时,插件将不会执行任何操作。 |
| output | string
| app.config.js | 指定保存提取的配置信息的文件路径。默认值是插件工作目录下的 _app.config.js
文件。 |
| prefix | string
| VITE_GLOB | 用于提取环境变量的前缀。插件将会从所有以该前缀开头的环境变量中提取配置信息。 |
| globalName | string
| - | 指定一个全局变量名,该变量将会包含所有提取的配置信息。 |
插件使用
你需要在你的 Vite 项目中导入插件并将其添加到配置中。
import { viteExternalConfigPlugin } from "@vsilk/vite-plugin-extract-config/vite";
import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
export default defineConfig({
plugins: [
vue(),
viteExternalConfigPlugin({
enabled: true,
output: '_app.config.js',
prefix: 'VITE_GLOB_',
globalName: ''
})
]
});
使用提取的配置信息
import { getGlobSetting } from '@vsilk/vite-plugin-extract-config';
// 获取提取配置
const { appTitle } = getGlobSetting();
// 输出配置中的 appTitle
console.log(appTitle);