123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469 |
- [](http://travis-ci.org/survivejs/webpack-merge) [](https://codecov.io/gh/survivejs/webpack-merge)
- # webpack-merge - Merge designed for Webpack
- **webpack-merge** provides a `merge` function that concatenates arrays and merges objects creating a new object. If functions are encountered, it will execute them, run the results through the algorithm, and then wrap the returned values within a function again.
- This behavior is particularly useful in configuring webpack although it has uses beyond it. Whenever you need to merge configuration objects, **webpack-merge** can come in handy.
- There's also a webpack specific merge variant known as `merge.smart` that's able to take webpack specifics into account (i.e., it can flatten loader definitions).
- ## Standard Merging
- ### **`merge(...configuration | [...configuration])`**
- `merge` is the core, and the most important idea, of the API. Often this is all you need unless you want further customization.
- ```javascript
- // Default API
- var output = merge(object1, object2, object3, ...);
- // You can pass an array of objects directly.
- // This works with all available functions.
- var output = merge([object1, object2, object3]);
- // Please note that where keys match,
- // the objects to the right take precedence:
- var output = merge(
- { fruit: "apple", color: "red" },
- { fruit: "strawberries" }
- );
- console.log(output);
- // { color: "red", fruit: "strawberries"}
- ```
- ### **`merge({ customizeArray, customizeObject })(...configuration | [...configuration])`**
- `merge` behavior can be customized per field through a curried customization API.
- ```javascript
- // Customizing array/object behavior
- var output = merge(
- {
- customizeArray(a, b, key) {
- if (key === 'extensions') {
- return _.uniq([...a, ...b]);
- }
- // Fall back to default merging
- return undefined;
- },
- customizeObject(a, b, key) {
- if (key === 'module') {
- // Custom merging
- return _.merge({}, a, b);
- }
- // Fall back to default merging
- return undefined;
- }
- }
- )(object1, object2, object3, ...);
- ```
- For example, if the previous code was invoked with only `object1` and `object2`
- with `object1` as:
- ```
- {
- foo1: ['object1'],
- foo2: ['object1'],
- bar1: { object1: {} },
- bar2: { object1: {} },
- }
- ```
- and `object2` as:
- ```
- {
- foo1: ['object2'],
- foo2: ['object2'],
- bar1: { object2: {} },
- bar2: { object2: {} },
- }
- ```
- then `customizeArray` will be invoked for each property of `Array` type, i.e:
- ```
- customizeArray(['object1'], ['object2'], 'foo1');
- customizeArray(['object1'], ['object2'], 'foo2');
- ```
- and `customizeObject` will be invoked for each property of `Object` type, i.e:
- ```
- customizeObject({ object1: {} }, { object2: {} }, bar1);
- customizeObject({ object1: {} }, { object2: {} }, bar2);
- ```
- ### **`merge.unique(<field>, <fields>, field => field)`**
- The first <field> is the config property to look through for duplicates.
- <fields> represents the values that should be unique when you run the field => field function on each duplicate.
- ```javascript
- const output = merge({
- customizeArray: merge.unique(
- 'plugins',
- ['HotModuleReplacementPlugin'],
- plugin => plugin.constructor && plugin.constructor.name
- )
- })({
- plugins: [
- new webpack.HotModuleReplacementPlugin()
- ]
- }, {
- plugins: [
- new webpack.HotModuleReplacementPlugin()
- ]
- });
- // Output contains only single HotModuleReplacementPlugin now.
- ```
- ## Merging with Strategies
- ### **`merge.strategy({ <field>: '<prepend|append|replace>''})(...configuration | [...configuration])`**
- Given you may want to configure merging behavior per field, there's a strategy variant:
- ```javascript
- // Merging with a specific merge strategy
- var output = merge.strategy(
- {
- entry: 'prepend', // or 'replace', defaults to 'append'
- 'module.rules': 'prepend'
- }
- )(object1, object2, object3, ...);
- ```
- ### **`merge.smartStrategy({ <key>: '<prepend|append|replace>''})(...configuration | [...configuration])`**
- The same idea works with smart merging too (described below in greater detail).
- ```javascript
- var output = merge.smartStrategy(
- {
- entry: 'prepend', // or 'replace'
- 'module.rules': 'prepend'
- }
- )(object1, object2, object3, ...);
- ```
- ## Smart Merging
- ### **`merge.smart(...configuration | [...configuration])`**
- *webpack-merge* tries to be smart about merging loaders when `merge.smart` is used. Loaders with matching tests will be merged into a single loader value.
- Note that the logic picks up webpack 2 `rules` kind of syntax as well. The examples below have been written in webpack 1 syntax.
- **package.json**
- ```json5
- {
- "scripts": {
- "start": "webpack-dev-server",
- "build": "webpack"
- },
- // ...
- }
- ```
- **webpack.config.js**
- ```javascript
- var path = require('path');
- var merge = require('webpack-merge');
- var TARGET = process.env.npm_lifecycle_event;
- var common = {
- entry: path.join(__dirname, 'app'),
- ...
- module: {
- loaders: [
- {
- test: /\.css$/,
- loaders: ['style', 'css'],
- },
- ],
- },
- };
- if(TARGET === 'start') {
- module.exports = merge(common, {
- module: {
- // loaders will get concatenated!
- loaders: [
- {
- test: /\.jsx?$/,
- loader: 'babel?stage=1',
- include: path.join(ROOT_PATH, 'app'),
- },
- ],
- },
- ...
- });
- }
- if(TARGET === 'build') {
- module.exports = merge(common, {
- ...
- });
- }
- ...
- ```
- **Loader string values `loader: 'babel'` override each other.**
- ```javascript
- merge.smart({
- loaders: [{
- test: /\.js$/,
- loader: 'babel'
- }]
- }, {
- loaders: [{
- test: /\.js$/,
- loader: 'coffee'
- }]
- });
- // will become
- {
- loaders: [{
- test: /\.js$/,
- loader: 'coffee'
- }]
- }
- ```
- **Loader array values `loaders: ['babel']` will be merged, without duplication.**
- ```javascript
- merge.smart({
- loaders: [{
- test: /\.js$/,
- loaders: ['babel']
- }]
- }, {
- loaders: [{
- test: /\.js$/,
- loaders: ['coffee']
- }]
- });
- // will become
- {
- loaders: [{
- test: /\.js$/,
- // appended because Webpack evaluated these from right to left
- // this way you can specialize behavior and build the loader chain
- loaders: ['babel', 'coffee']
- }]
- }
- ```
- **Loader array values `loaders: ['babel']` can be reordered by including
- original loaders.**
- ```javascript
- merge.smart({
- loaders: [{
- test: /\.js$/,
- loaders: ['babel']
- }]
- }, {
- loaders: [{
- test: /\.js$/,
- loaders: ['react-hot', 'babel']
- }]
- });
- // will become
- {
- loaders: [{
- test: /\.js$/,
- // order of second argument is respected
- loaders: ['react-hot', 'babel']
- }]
- }
- ```
- This also works in reverse - the existing order will be maintained if possible:
- ```javascript
- merge.smart({
- loaders: [{
- test: /\.css$/,
- use: [
- { loader: 'css-loader', options: { myOptions: true } },
- { loader: 'style-loader' }
- ]
- }]
- }, {
- loaders: [{
- test: /\.css$/,
- use: [
- { loader: 'style-loader', options: { someSetting: true } }
- ]
- }]
- });
- // will become
- {
- loaders: [{
- test: /\.css$/,
- use: [
- { loader: 'css-loader', options: { myOptions: true } },
- { loader: 'style-loader', options: { someSetting: true } }
- ]
- }]
- }
- ```
- In the case of an order conflict, the second order wins:
- ```javascript
- merge.smart({
- loaders: [{
- test: /\.css$/,
- use: [
- { loader: 'css-loader' },
- { loader: 'style-loader' }
- ]
- }]
- }, {
- loaders: [{
- test: /\.css$/,
- use: [
- { loader: 'style-loader' },
- { loader: 'css-loader' }
- ]
- }]
- });
- // will become
- {
- loaders: [{
- test: /\.css$/,
- use: [
- { loader: 'style-loader' }
- { loader: 'css-loader' },
- ]
- }]
- }
- ```
- **Loader query strings `loaders: ['babel?plugins[]=object-assign']` will be overridden.**
- ```javascript
- merge.smart({
- loaders: [{
- test: /\.js$/,
- loaders: ['babel?plugins[]=object-assign']
- }]
- }, {
- loaders: [{
- test: /\.js$/,
- loaders: ['babel', 'coffee']
- }]
- });
- // will become
- {
- loaders: [{
- test: /\.js$/,
- loaders: ['babel', 'coffee']
- }]
- }
- ```
- **Loader arrays in source values will have loader strings merged into them.**
- ```javascript
- merge.smart({
- loaders: [{
- test: /\.js$/,
- loader: 'babel'
- }]
- }, {
- loaders: [{
- test: /\.js$/,
- loaders: ['coffee']
- }]
- });
- // will become
- {
- loaders: [{
- test: /\.js$/,
- // appended because Webpack evaluated these from right to left!
- loaders: ['babel', 'coffee']
- }]
- }
- ```
- **Loader strings in source values will always override.**
- ```javascript
- merge.smart({
- loaders: [{
- test: /\.js$/,
- loaders: ['babel']
- }]
- }, {
- loaders: [{
- test: /\.js$/,
- loader: 'coffee'
- }]
- });
- // will become
- {
- loaders: [{
- test: /\.js$/,
- loader: 'coffee'
- }]
- }
- ```
- ## Multiple Merging
- ### **`merge.multiple(...configuration | [...configuration])`**
- Sometimes you may need to support multiple targets, *webpack-merge* will accept an object where each key represents the target configuration. The output becomes an *array* of configurations where matching keys are merged and non-matching keys are added.
- ```javascript
- var path = require('path');
- var baseConfig = {
- server: {
- target: 'node',
- output: {
- path: path.resolve(__dirname, 'dist'),
- filename: 'lib.node.js'
- }
- },
- client: {
- output: {
- path: path.resolve(__dirname, 'dist'),
- filename: 'lib.js'
- }
- }
- };
- // specialized configuration
- var production = {
- client: {
- output: {
- path: path.resolve(__dirname, 'dist'),
- filename: '[name].[hash].js'
- }
- }
- }
- module.exports = merge.multiple(baseConfig, production)
- ```
- > Check out [SurviveJS - Webpack and React](http://survivejs.com/) to dig deeper into the topic.
- ## Development
- 1. `npm i`
- 1. `npm run build`
- 1. `npm run watch`
- Before contributing, please open an issue where to discuss.
- ## License
- *webpack-merge* is available under MIT. See LICENSE for more details.
|