Skip to content
【v0.2 no longer maintained】 Fix babel/babel#2212 - Follow the babel@5 behavior for babel@6
JavaScript
Branch: master
Clone or download

Latest commit

Latest commit e8e5be0 Sep 28, 2018

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src upgrade for babel 7 Sep 4, 2018
test upgrade for babel 7 Sep 4, 2018
.babelrc feat: use preset-env instead preset-2015 Jun 24, 2018
.eslintrc chore: use standard instead of airbnb-standard(reverted) Jul 9, 2018
.gitignore Change 5 to 6 syntax Apr 24, 2016
.travis.yml docs: remove `@next` tag Sep 11, 2018
README.md docs: tweaks [ci skip] Sep 28, 2018
package.json chore: tweak `postversion` script [ci skip] Sep 11, 2018
yarn.lock upgrade for babel 7 Sep 4, 2018

README.md

babel-plugin-add-module-exports

Why?

Babel@6 doesn't export default module.exports any more - T2212 Kill CommonJS default export behavior.

Babel@6 transforms the following file

export default 'foo'

into

'use strict';
Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = 'foo';

Therefore, it is a need to use the ugly .default in node.js.

require('./bundle.js') // { default: 'foo' }
require('./bundle.js').default // 'foo'

This plugin follows the babel@5 behavior - add the module.exports if only the export default declaration exists.

'use strict';
Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = 'foo';
module.exports = exports['default'];

Therefore, our old codes still work fine - the .default goes away. 😉

require('./bundle.js') // foo

Usage

Install this plugin from npm:

npm install babel-plugin-add-module-exports --save-dev
# or
yarn add -D babel-plugin-add-module-exports

Write the name to babelrc. It works with preset-env to output CommonJS code:

{
  "presets": ["@babel/env"],
  "plugins": ["add-module-exports"]
}

modules: false

However, the plugin doesn't change the pure-esmodule. this plugin makes changes only when exists exports.default (in other words, using commonjs).

{
  "presets": [["@babel/env", { "modules": false }]],
  "plugins": ["add-module-exports"]
}

into

export default 'foo'

1.0.0 Currently support is commonjs and umd. Doesn't support amd, systemjs modules(don't use. there are no plans to support at the moment).

with Webpack

Likewise, webpack doesn't perform commonjs transformation for codesplitting. Need to set commonjs conversion.

{
  "presets": [["@babel/env", { "modules": "commonjs" }]],
  "plugins": ["add-module-exports"]
}

Options

addDefaultProperty

If you're exporting an object and wish to maintain compatibility with code using the require('./bundle.js').default syntax, you can optionally enable the addDefaultProperty option as follows:

{
  "presets": ["env"],
  "plugins": [
    [
      "add-module-exports",
      {
        "addDefaultProperty": true
      }
    ]
  ]
}

This will cause a second line of code to be added which aliases the default name to the exported object like so:

module.exports = exports['default'];
module.exports.default = exports['default']

See also

License

MIT

You can’t perform that action at this time.