使用 Webpack 基于环境的条件构建

Question

我有一些需要开发的东西 - 例如，我不想让我的分布式构建文件膨胀的模拟。

在 RequireJS 中，您可以在插件文件中传递一个配置，并在此基础上要求一些东西。

对于 webpack，似乎没有办法做到这一点。首先为环境创建运行时配置，我使用resolve.alias 根据环境重新指向要求，例如：

// All settings.
var all = {
    fish: 'salmon'
};

// `envsettings` is an alias resolved at build time.
module.exports = Object.assign(all, require('envsettings'));

然后在创建 webpack 配置时，我可以动态分配 envsettings 指向的文件（即 webpackConfig.resolve.alias.envsettings = './' + env）。

但是我想做这样的事情：

if (settings.mock) {
    // Short-circuit ajax calls.
    // Require in all the mock modules.
}

但如果环境不是模拟的，我显然不想在那些模拟文件中构建。

我可以再次使用 resolve.alias 手动将所有这些要求重新指向存根文件 - 但有没有一种方法可以让你感觉不那么老套？

有什么想法可以做到吗？谢谢。

Answer 1

您可以使用define plugin。

我通过在你的 webpack 构建文件中做一些简单的事情来使用它，其中env 是导出设置对象的文件的路径：

// Webpack build config
plugins: [
    new webpack.DefinePlugin({
        ENV: require(path.join(__dirname, './path-to-env-files/', env))
    })
]

// Settings file located at `path-to-env-files/dev.js`
module.exports = { debug: true };

然后在你的代码中

if (ENV.debug) {
    console.log('Yo!');
}

如果条件为假，它将从您的构建文件中删除此代码。你可以看到一个有效的Webpack build example here。

Answer 2

不确定为什么“webpack.DefinePlugin”答案是定义基于环境的导入/要求的首选答案。

这种方法的问题是您仍在将所有这些模块交付给客户端 -> 例如检查webpack-bundle-analyezer。而且根本不会减少 bundle.js 的大小:)

所以真正运作良好且更合乎逻辑的是：NormalModuleReplacementPlugin

因此，与其做一个 on_client 条件要求 -> 只是不首先将不需要的文件包含到包中

希望有帮助

Answer 3

使用ifdef-loader。在您的源文件中，您可以执行以下操作：

/// #if ENV === 'production'
console.log('production!');
/// #endif

相关的webpack配置是

const preprocessor = {
  ENV: process.env.NODE_ENV || 'development',
};

const ifdef_query = require('querystring').encode({ json: JSON.stringify(preprocessor) });

const config = {
  // ...
  module: {
    rules: [
      // ...
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: `ifdef-loader?${ifdef_query}`,
        },
      },
    ],
  },
  // ...
};

Answer 4

我最终使用了类似于Matt Derrick' Answer的东西，但担心两点：

1. 每次我使用ENV 时都会注入完整的配置（这对大型配置不利）。
2. 我必须定义多个入口点，因为require(env) 指向不同的文件。

---

我想出的是一个简单的作曲家，它构建一个配置对象并将其注入配置模块。
这是我正在使用的文件结构：

config/
 └── main.js
 └── dev.js
 └── production.js
src/
 └── app.js
 └── config.js
 └── ...
webpack.config.js

main.js 包含所有默认配置内容：

// main.js
const mainConfig = {
  apiEndPoint: 'https://api.example.com',
  ...
}

module.exports = mainConfig;

dev.js 和 production.js 仅包含覆盖主配置的配置内容：

// dev.js
const devConfig = {
  apiEndPoint: 'http://localhost:4000'
}

module.exports = devConfig;

重要的部分是webpack.config.js，它构成了配置，并使用DefinePlugin 生成了一个环境变量__APP_CONFIG__，它保存了组合的配置对象：

const argv = require('yargs').argv;
const _ = require('lodash');
const webpack = require('webpack');

// Import all app configs
const appConfig = require('./config/main');
const appConfigDev = require('./config/dev');
const appConfigProduction = require('./config/production');

const ENV = argv.env || 'dev';

function composeConfig(env) {
  if (env === 'dev') {
    return _.merge({}, appConfig, appConfigDev);
  }

  if (env === 'production') {
    return _.merge({}, appConfig, appConfigProduction);
  }
}

// Webpack config object
module.exports = {
  entry: './src/app.js',
  ...
  plugins: [
    new webpack.DefinePlugin({
      __APP_CONFIG__: JSON.stringify(composeConfig(ENV))
    })
  ]
};

最后一步现在是config.js，看起来像这样（这里使用es6 import export语法，因为它在webpack下）：

const config = __APP_CONFIG__;

export default config;

在您的app.js 中，您现在可以使用import config from './config'; 来获取配置对象。

Answer 5

另一种方法是使用一个JS文件作为proxy，并让该文件加载commonjs中感兴趣的模块，并将其导出为es2015 module，如下所示：

// file: myModule.dev.js
module.exports = "this is in dev"

// file: myModule.prod.js
module.exports = "this is in prod"

// file: myModule.js
let loadedModule
if(WEBPACK_IS_DEVELOPMENT){
    loadedModule = require('./myModule.dev.js')
}else{
    loadedModule = require('./myModule.prod.js')
}

export const myString = loadedModule

那么你就可以在你的应用中正常使用ES2015模块了：

// myApp.js
import { myString } from './store/myModule.js'
myString // <- "this is in dev"

Answer 6

面对与 OP 相同的问题并要求，由于许可，在某些版本中不包含某些代码，我采用了 webpack-conditional-loader 如下：

在我的构建命令中，我为我的构建设置了一个适当的环境变量。例如 package.json 中的“演示”：

...
  "scripts": {
    ...
    "buildDemo": "./node_modules/.bin/webpack --config webpack.config/demo.js --env.demo --progress --colors",
...

我阅读的文档中缺少的令人困惑的一点是，我必须通过确保我的 env 变量被注入到全局进程中，从而在我的 webpack.config 中使其在整个构建过程中可见 /demo.js:

/* The demo includes project/reports action to access placeholder graphs.
This is achieved by using the webpack-conditional-loader process.env.demo === true
 */

const config = require('./production.js');
config.optimization = {...(config.optimization || {}), minimize: false};

module.exports = env => {
  process.env = {...(process.env || {}), ...env};
  return config};

有了这个，我可以有条件地排除任何东西，确保任何相关代码都被正确地从生成的 JavaScript 中删除。例如，在我的 routes.js 中，演示内容被排除在其他构建之外：

...
// #if process.env.demo
import Reports from 'components/model/project/reports';
// #endif
...
const routeMap = [
  ...
  // #if process.env.demo
  {path: "/project/reports/:id", component: Reports},
  // #endif
...

这适用于 webpack 4.29.6。

Answer 7

我一直在努力在我的 webpack 配置中设置 env。我通常想要的是设置 env 以便可以在webpack.config.js、postcss.config.js 和入口点应用程序本身内部（通常是index.js）访问它。我希望我的发现可以帮助别人。

我想出的解决方案是传入--env production 或--env development，然后在webpack.config.js 中设置模式。 但是，这并不能帮助我在我想要的地方访问env（见上文），所以我还需要明确设置process.env.NODE_ENV，正如推荐的here。 我在webpack.config.js 中最相关的部分如下。

...
module.exports = mode => {
  process.env.NODE_ENV = mode;

  if (mode === "production") {
    return merge(commonConfig, productionConfig, { mode });
  }
  return merge(commonConfig, developmentConfig, { mode });
};

Answer 8

使用环境变量创建开发和产品部署：

https://webpack.js.org/guides/environment-variables/

Answer 9

虽然这不是最佳解决方案，但它可能会满足您的某些需求。如果你想在节点和浏览器中运行不同的代码，这对我有用：

if (typeof window !== 'undefined') 
    return
}
//run node only code now