ContextReplacementPlugin

上下文(context) 与一个 含有表达式的 require 语句 相关,例如 require('./locale/' + name + '.json')。遇见此类表达式时,webpack 查找目录 ('./locale/') 下符合正则表达式 (/^.*\.json$/)的文件。由于 name 在编译时(compile time)还是未知的,webpack 会将每个文件都作为模块引入到 bundle 中。

上下文替换插件(ContextReplacementPlugin) 允许你覆盖查找规则,该插件有许多配置方式:

用法

  1. new webpack.ContextReplacementPlugin(
  2. resourceRegExp: RegExp,
  3. newContentResource?: string,
  4. newContentRecursive?: boolean,
  5. newContentRegExp?: RegExp
  6. )

如果资源(或目录)符合 resourceRegExp 正则表达式,插件会替换默认资源为 newContentResource,布尔值 newContentRecursive 表明是否使用递归查找,newContextRegExp 用于筛选新上下文里的资源。如果 newContentResource 为相对路径,会相对于前一匹配资源路径去解析。

这是一个限制模块使用的小例子:

  1. new webpack.ContextReplacementPlugin(
  2. /moment[/\\]locale$/,
  3. /de|fr|hu/
  4. );

限定查找 moment/locale 上下文里符合 /de|fr|hu/ 表达式的文件,因此也只会打包这几种本地化内容(更多详细信息,请查看这个 issue)。

内容回调函数

  1. new webpack.ContextReplacementPlugin(
  2. resourceRegExp: RegExp,
  3. newContentCallback: (data) => void
  4. );

newContentCallback 函数的第一形参为上下文模块工厂(ContextModuleFactory)data 对象,你需要覆写该对象的 request 属性。

使用这个回调函数,我们可以动态地将请求重定向到一个新的位置:

  1. new webpack.ContextReplacementPlugin(/^\.\/locale$/, (context) => {
  2. if ( !/\/moment\//.test(context.context) ) return;
  3. Object.assign(context, {
  4. regExp: /^\.\/\w+/,
  5. request: '../../locale' // 相对路径解析
  6. });
  7. });

其他选项

newContentResourcenewContentCreateContextMap 参数也可用:

  1. new webpack.ContextReplacementPlugin(
  2. resourceRegExp: RegExp,
  3. newContentResource: string,
  4. newContentCreateContextMap: object // 将运行时请求(runtime-request)映射到编译时请求(compile-time request)
  5. );

这两个参数可以一起使用,来更加有针对性的重定向请求。 newContentCreateContextMap 允许你将运行时的请求,映射为形式为对象的编译请求:

  1. new ContextReplacementPlugin(/selector/, './folder', {
  2. './request': './request',
  3. './other-request': './new-request'
  4. });

进一步阅读


贡献人员

byzyk byzyk masives masives simon04 simon04