[TOC]

前言

在开发前端项目时，我们经常会使用 webpack 来进行打包。webpack 提供了很多配置项，但是当项目变得复杂时，我们需要将配置拆分成多个文件进行管理，于是就有了 webpack-merge。

webpack-merge 是一个合并配置的工具，它可以将多个配置文件合并成一个。这样就能让我们的配置文件变得更加灵活，易于管理。但是，该工具在使用过程中可能会出现一些问题，这篇文章就是为了帮助大家解决这些问题。

问题描述

在使用 webpack-merge 合并配置时，可能会出现以下问题：

合并出的配置不符合预期。
合并后的配置文件大小比预期要大很多。
无法使用 ES6 import/export 语法导入合并出的配置。

原因分析

问题一

webpack-merge 可能会将多个配置文件的同名属性进行合并，导致出现错误。比如我们在 webpack.base.config.js 文件中定义了一个 entry 属性：

module.exports = {
  entry: {
    main: './src/index.js'
  }
}

而在 webpack.dev.config.js 文件中也定义了一个 entry 属性：

module.exports = {
  entry: {
    app: './src/app.js'
  }
}

此时，我们使用 webpack-merge 合并这两个配置文件：

const { merge } = require('webpack-merge');
const baseConfig = require('./webpack.base.config');
const devConfig = require('./webpack.dev.config');
module.exports = merge(baseConfig, devConfig);

合并出的配置文件就会变成这样：

module.exports = {
  entry: {
    main: './src/index.js',
    app: './src/app.js'
  }
}

这显然不符合我们的预期。

问题二

webpack-merge 会将多个配置文件的内容完全合并在一起，使得生成的配置文件变得极其臃肿。

问题三

webpack-merge 合并出的配置文件无法使用 ES6 的 import/export 语法进行导入。

解决方案

解决问题一

为了避免合并时出现大面积错误，我们应该遵循一些规则。

首先，我们应该尽量避免在配置文件中定义同名属性。如果有同名属性，我们需要在进行合并时指定合并方式。webpack-merge 提供了以下几种合并方式：

数组合并：将多个数组合并为一个数组，如 plugins。
覆盖式合并：用后面的属性值覆盖前面的属性值，如 output。
深度合并：深度合并对象属性，如 module.rules。
合并对象中的数组属性：将对象中数组属性合并为一个数组，如 module.noParse。

接下来，我们看一下具体的实现方法。我们将配置文件按照如下方式编写：

webpack.common.config.js

module.exports = {
  entry: {
    main: './src/index.js'
  }
}

webpack.dev.config.js

-- -------------------- ---- -------
----- - ----- - - -------------------------
----- ------------ - -----------------------------------
-------------- - ------------------- -
  ------ -
    ---- --------------
  --
  -------- -
    --- -------------------
      --------- -------------------
      --------- ------------
    --
  -
---

webpack.prod.config.js

-- -------------------- ---- -------
----- - ----- - - -------------------------
----- ------------ - -----------------------------------
-------------- - ------------------- -
  ------- -
    --------- --------------------------
    ----- ----------------------- -------
  --
  -------- -
    --- ----------------------
      --------- ---------------------------
      -------------- ------------------------
    --
  -
---

我们可以看到，在编写配置文件时，我们将所有共用的配置项，如 entry，抽离到一个公共的配置文件中。在进行合并时，通过 merge 方法将各个配置文件合并。

这种方式可以避免同名属性被错误地合并掉。

解决问题二

webpack-merge 会将多个配置文件的内容完全合并在一起，导致生成的文件很臃肿。为了避免这个问题，我们可以使用 webpack-merge 的 smart 模式。

smart 模式只会合并对象和数组，类似于 Object.assign() 的效果。基本类型不会被合并，而是被后面的值所覆盖。

我们来看一下使用 smart 模式的示例：

webpack.common.config.js

module.exports = {
  entry: {
    main: './src/index.js'
  }
}

webpack.dev.config.js

-- -------------------- ---- -------
----- - ----- - - -------------------------
----- ------------ - -----------------------------------
-------------- - ------------------------- -
  ------- -
    --------- ------------------
  --
  -------- -
    --- -------------------
      --------- ------------------
    --
  --
  ---------- -
    ----- ----
  -
---

webpack.prod.config.js

-- -------------------- ---- -------
----- - ----- - - -------------------------
----- ------------ - -----------------------------------
-------------- - ------------------------- -
  ------- -
    --------- --------------------------
    ----- ----------------------- -------
  --
  -------- -
    --- ----------------------
      --------- ---------------------------
      -------------- ------------------------
    --
  -
---

我们可以看到，在使用 smart 模式后，合并出的配置文件变得简洁明了，不存在冗余的代码。

解决问题三

由于 merge 这个方法的返回值是一个普通的对象，因此无法使用 ES6 的 import/export 语法进行导入。但是，我们可以将合并后的对象导出，再在其他文件中导入这个对象。

我们来看一个示例：

webpack.common.config.js

const config = {
  entry: {
    main: './src/index.js'
  }
}
module.exports = config;

webpack.dev.config.js

const { merge } = require('webpack-merge');
const commonConfig = require('./webpack.common.config');
const devConfig = {
  output: {
    path: path.resolve(__dirname, 'dist')
  }
}
module.exports = merge(commonConfig, devConfig);

webpack.prod.config.js

const { merge } = require('webpack-merge');
const commonConfig = require('./webpack.common.config');
const prodConfig = {
  output: {
    path: path.resolve(__dirname, 'dist')
  }
}
module.exports = merge(commonConfig, prodConfig);

现在，我们可以在其他文件中使用如下方式导入合并后的配置：

import config from './webpack.config.js';

我们也可以使用 require 的方式导入合并后的配置：

const config = require('./webpack.config.js');

总结

本文主要介绍了如何解决使用 webpack-merge 合并配置时出现的问题。我们应该遵循一些规则，如避免同名属性等。同时，我们可以使用 smart 模式使合并后的配置文件变得更加清晰。另外，我们也可以将合并后的配置文件导出，然后在其他文件中进行导入。希望这篇文章能够帮助大家更好地使用 webpack-merge。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/64eab081f6b2d6eab3582dc9