From c63a55f7ceeb764fe0275c28359ddbb358c26f6d Mon Sep 17 00:00:00 2001 From: Josh Duff Date: Wed, 24 Oct 2018 15:27:18 -0500 Subject: [PATCH 1/2] Remove ES module build As a workaround for all the Webpack users Fixes #123 Fixes #87 Fixes #97 --- changelog.md | 4 ++++ package.json | 1 - readme.md | 19 ++++--------------- rollup.config.js | 9 ++++----- 4 files changed, 12 insertions(+), 21 deletions(-) diff --git a/changelog.md b/changelog.md index 14582b8..dc4098c 100644 --- a/changelog.md +++ b/changelog.md @@ -1,3 +1,7 @@ +# [3.0.0](https://github.com/KyleAMathews/deepmerge/releases/tag/v3.0.0) + +- drop ES module build [#123](https://github.com/KyleAMathews/deepmerge/issues/123) + # [2.2.1](https://github.com/KyleAMathews/deepmerge/releases/tag/v2.2.1) - bug: typescript export type was wrong [#121](https://github.com/KyleAMathews/deepmerge/pull/121) diff --git a/package.json b/package.json index 0256856..64183f7 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,6 @@ "url": "git://github.com/KyleAMathews/deepmerge.git" }, "main": "dist/umd.js", - "module": "dist/es.js", "engines": { "node": ">=0.10.0" }, diff --git a/readme.md b/readme.md index eeec899..e2a0fa7 100644 --- a/readme.md +++ b/readme.md @@ -5,26 +5,13 @@ Merges the enumerable attributes of two or more objects deeply. > UMD bundle is 567B minified+gzipped -### Migration from 1.x to 2.0.0 +### Migration from 1.x to 2+ [***Check out the changes from version 1.x to 2.0.0***](https://github.com/KyleAMathews/deepmerge/blob/master/changelog.md#200) For the legacy array element-merging algorithm, see [the `arrayMerge` option below](#arraymerge). -### Webpack bug - -If you have `require('deepmerge')` (as opposed to `import merge from 'deepmerge'`) anywhere in your codebase, Webpack 3 and 4 have a bug that [breaks bundling](https://github.com/webpack/webpack/issues/6584). - -If you see `Error: merge is not a function`, add this alias to your Webpack config: - -``` -alias: { - deepmerge$: path.resolve(__dirname, 'node_modules/deepmerge/dist/umd.js'), -} -``` - - ## Getting Started ### Example Usage @@ -93,9 +80,11 @@ var merge = require('deepmerge') ES Modules: ``` -import merge from 'deepmerge' +import * from 'deepmerge' ``` +(support for `import merge from 'deepmerge'` was removed because of a [Webpack bug](https://github.com/webpack/webpack/issues/6584)). + # API diff --git a/rollup.config.js b/rollup.config.js index 6adb6c8..2e54080 100644 --- a/rollup.config.js +++ b/rollup.config.js @@ -1,17 +1,16 @@ import resolve from 'rollup-plugin-node-resolve' import commonjs from 'rollup-plugin-commonjs' -var pkg = require('./package.json') +const pkg = require(`./package.json`) export default { - input: 'index.js', - name: 'deepmerge', + input: `index.js`, + name: `deepmerge`, plugins: [ commonjs(), resolve(), ], output: [ - { file: pkg.main, format: 'umd' }, - { file: pkg.module, format: 'es' }, + { file: pkg.main, format: `umd` }, ], } From 33a7ee4927023ff09527620ec549737687bcd072 Mon Sep 17 00:00:00 2001 From: Josh Duff Date: Sat, 1 Dec 2018 12:44:11 -0600 Subject: [PATCH 2/2] Fix ESM example --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index e2a0fa7..02ed27f 100644 --- a/readme.md +++ b/readme.md @@ -80,7 +80,7 @@ var merge = require('deepmerge') ES Modules: ``` -import * from 'deepmerge' +import * as deepmerge from 'deepmerge' ``` (support for `import merge from 'deepmerge'` was removed because of a [Webpack bug](https://github.com/webpack/webpack/issues/6584)).