webpack umd library only for root, replace exports

广告位招租
扫码页面底部二维码联系

webpack 导出的 umd 模块在传入了 output.library 的情况下,会输出四个条件语句,大概如下:

if(typeof exports === 'object' && typeof module === 'object')
  module.exports = factory(require("a"), require("b"));
else if(typeof define === 'function' && define.amd)
  define(["a", "b"], factory);
else if(typeof exports === 'object')
  exports["o"] = factory(require("a"), require("b"));
else
  root["o"] = factory(root["a"], root["b"]);

这样的 umd 模式。其中,关于依赖、导出接口名都可以定制,其中依赖部分通过 externals 配置来定制,导出接口名通过 library 来定制。

但是,现在的一个情况是,在第三个条件句,即红色部分,这个部分会在标准的 commonjs 中被引用。所谓标准的 commonjs 是由 commonjs 官方定义的,只有 exports 和 require 两个关键字的模块方案。而 nodejs 虽然遵循 commonjs,但是在其基础上实现了 module 关键字,将 exports 作为 module.exports 的引用,因此被成为 commonjs2。

我们现在去看这个部分,倘若一个模块在遵循标准 commonjs 的情况下,导出如下:

// a.js
exports.a = function a() {}
// b.js
exports.b = function b() {}
// main.js
export.a = require('./a.js')
export.b = require('./b.js')

外部使用这个包,实际上应该是:

const { a, b } = require('./main.js')

但是在 webpack 的 umd 模块下使用时变成了:

// bundle.js
exports.o = factory()

那么在外面的其他程序去用这个包时就需要变成下面这种方式才可以:

const { o } = require('./bundle.js')
const { a, b } = o

这显然不符合我们的期望,我们希望即使 webpack 打包之后,仍然保持原有的使用方式。所以,我写了一个方法来修改这个部分的输出,经过处理之后,webpack 这个部分的输出将会是:

else if(typeof exports === 'object')
	{ var a = factory(require("a"), require("b")); for (var i in a) exports[i] = a[i]; }

即替换掉原来的输出形式,将原本的输出接口直接赋值到 exports 上,这样就保持了原本的逻辑。

具体做法如下:

// webpack.config.js
const { bufferify } = require('webpack-bufferify')
const plugins = [
  bufferify(function(content, file, assets, compilation, compiler) {
    if (file.split('.').pop() !== 'js') {
      return
    }
    const { optimization } = compiler.options
    content = content.toString()
    content = optimization.minimize === true
      ? content.replace(/exports\[.*?\]=(.*?):/, `function(e,a){for(var i in a)e[i]=a[i]}(exports,$1):`)
      : content.replace(/exports\[.*?\](.*?);/, `{ var a$1; for (var i in a) exports[i] = a[i]; }`)
    return content
  }),
]

module.exports = {
  ...,
  plugins,
}

webpack-bufferify 是我写的一个组件,用以替换 webpack 输出的结果内容。通过上面的处理,就可以实现我们的目的。