multi-env-html-webpack-plugin
v1.0.0
Published
generate multiples indexs by environments
Downloads
3
Maintainers
Readme
multi-env-html-webpack-plugin
这是一个webpack
插件。用来生成被注入了不同script
脚本的html
入口文件。通常用来生成单页面应用的不同环境的入口html文件,以避免构建不同环境的应用包需要进行多次构建过程时,例如:假设需要生成3
个环境的应用包时,原来需要执行3
次构建命令和构建过程。利用这个插件则可以进行1
次构建,生成不同环境的入口index.html
文件,在部署环境时仅需指定对应环境的入口文件即可。原理就是通过改变现有项目中的process.env
通过webpack编译后的输出结果,让它变成一个全局变量,然后在项目的入口文件的所有脚本前面注入该全局变量。
安装
- npm:
npm i multi-env-html-webpack-plugin -D
- yarn:
yarn add multi-env-html-webpack-plugin -D
- pnpm:
pnpm add multi-env-html-webpack-plugin -D
使用
// webpack 配置
const { getEnv, MultiEnvHtmlWebpackPlugin } = require("multi-env-html-webpack-plugin");
const path = require("path");
const globalEnvName='_env_'
module.exports = {
// 第一步改变process.env编译后的输出结果
//webpack项目:
new webpack.DefinePlugin({
"process.env":`window.${globalEnvName}`
})
// vue-cli项目
config.plugin("define").tap(() => {
return [
{
"process.env": `window.${globalEnvName}`,
},
];
});
...
// 第二部配置插件,根据环境配置输出文件路径和对应的环境变量
plugins:[
//单页面应用
new MultiEnvHtmlWebpackPlugin([{
index:path.join(__dirname,"./dist/index.html"),
outputs:[
{
data:{
[`${globalEnvName}`]:getEnv("production"),//加载.env.*文件或者直接自己写入对象
},
file:path.join(__dirname,"./dist/index-production.html")
},
{
data:{
[`${globalEnvName}`]:getEnv("dev"),
},
file:path.join(__dirname,"./dist/index-dev.html")
},
{
data:{
[`${globalEnvName}`]:getEnv("test"),
},
file:path.join(__dirname,"./dist/index-test.html")
},
//process.env.mode 为构建时的环境参数,注意该项一定要放在最后,因为是按顺序进行的,前面的会读取index.html
//(本地开发时,注意需确定入口文件index的路径或者添加环境判断在本地开发时不引入该插件),
{
data: { [`${globalEnvName}`]: getEnv(process.env.mode)},
file: path.join(__dirname,"./dist/index.html",)
},
]
parent: "body",//全局变量的脚本挂载的父节点。脚本会挂载在该父节点的第一个子节点的位置。为可选配置,默认就是'body'选择器
}]),
//多页面应用
new MultiEnvHtmlWebpackPlugin([
{
index:path.join(__dirname,"./dist/pc/index.html"),
outputs:[
{
data:{
[`${globalEnvName}`]:getEnv("production"),
},
file:path.join(__dirname,"./dist/index-production.html")
},
{
data:{
[`${globalEnvName}`]:getEnv("dev"),
},
file:path.join(__dirname,"./dist/index-dev.html")
},
//process.env.mode 为构建时的环境参数,注意该项一定要放在最后,因为是按顺序进行的,前面的会读取index.html
//(本地开发时,注意需确定入口文件index的路径或者添加环境判断在本地开发时不引入该插件),
{
data: { [`${globalEnvName}`]: getEnv(process.env.mode)},
file: path.join(__dirname,"./dist/pc/index.html",)
},
]
},
{
index:path.join(__dirname,"./dist/mobile/index.html"),
outputs:[
{
data:{
[`${globalEnvName}`]:getEnv("pro"),
},
file:path.join(__dirname,"./dist/mobile/index-pro.html")
},
{
data:{
[`${globalEnvName}`]:getEnv("dev"),
},
file:path.join(__dirname,"./dist/mobile/index-dev.html")
},
]
},
]),
]
}