EnvironmentPlugin

EnvironmentPlugin 是 DefinePlugin 在 process.env 键上的简写。

用法

EnvironmentPlugin 接受一个键数组，或一个将其键映射到其默认值的对象。

new webpack.EnvironmentPlugin(['NODE_ENV', 'DEBUG']);

这等同于以下 DefinePlugin 应用：

new webpack.DefinePlugin({
  'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV),
  'process.env.DEBUG': JSON.stringify(process.env.DEBUG),
});

带默认值的用法

或者，EnvironmentPlugin 支持一个对象，该对象将键映射到其默认值。如果 process.env 中未定义某个键，则会采用该键的默认值。

new webpack.EnvironmentPlugin({
  NODE_ENV: 'development', // use 'development' unless process.env.NODE_ENV is defined
  DEBUG: false,
});

示例

让我们在测试文件 entry.js 上运行之前的 EnvironmentPlugin 配置，并查看结果。

if (process.env.NODE_ENV === 'production') {
  console.log('Welcome to production');
}
if (process.env.DEBUG) {
  console.log('Debugging output');
}

在终端中执行 NODE_ENV=production webpack 进行构建时，entry.js 会变成这样：

if ('production' === 'production') {
  // <-- 'production' from NODE_ENV is taken
  console.log('Welcome to production');
}
if (false) {
  // <-- default value is taken
  console.log('Debugging output');
}

运行 DEBUG=false webpack 会得到：

if ('development' === 'production') {
  // <-- default value is taken
  console.log('Welcome to production');
}
if ('false') {
  // <-- 'false' from DEBUG is taken
  console.log('Debugging output');
}

用例：Git 版本

以下 EnvironmentPlugin 配置提供了对应于仓库最后一次 Git 提交的 process.env.GIT_VERSION（例如 "v5.4.0-2-g25139f57f"）和 process.env.GIT_AUTHOR_DATE（例如 "2020-11-04T12:25:16+01:00"）。

const child_process = require('child_process');
function git(command) {
  return child_process.execSync(`git ${command}`, { encoding: 'utf8' }).trim();
}

new webpack.EnvironmentPlugin({
  GIT_VERSION: git('describe --always'),
  GIT_AUTHOR_DATE: git('log -1 --format=%aI'),
});

DotenvPlugin

第三方 DotenvPlugin (dotenv-webpack) 允许你暴露（部分）dotenv 变量

// .env
DB_HOST=127.0.0.1
DB_PASS=foobar
S3_API=mysecretkey

new Dotenv({
  path: './.env', // Path to .env file (this is the default)
  safe: true, // load .env.example (defaults to "false" which does not use dotenv-safe)
});