Webpack 5 release版 官方文档全文翻译

Webpack 5 发行版 (2020-10-10)

webpack 4在2018年二月份发行。在那以后我们封装了一些列特性,但是并没有引入破坏性的变化。我们知道大家不喜欢有破环新变化(breaking changes)的变更。特别是针对webpack这类工具,人们一年只会接触这种应用的机会很有限,其余时候把它丢在一边,只要它能正常工作。但是不引入破换新变化的同时风向新特性是有代价的:我们不能进行核心api或者架构层面的升级。
随着时间的推移,总会到这么一个时间点,面临的问题堆积到了一定程度使得我们必须去通过引入破换性的变化来进行修复,而不是让代码朝着更加不可维护的方向发展。现在是时候发布新版本了,webpack 5包含了架构升级和新特性,我们在实现它们的同时不引入破坏性变更。
与此同时,大版本的发布也是一个修正一些错误、与业界提案和规范保持一致的机会。
所以在今天(202-10-10)webpack 5正式发布,但这并不意味着这个版本已经完成,没有bug,完成了所有的特性开发。与此同时,我们会继续维护webpack 4,修复bug并且增加新特性。接下来的日子里我们主要会进行bug修复,特性的追加会稍后。

常见问题

发行版意味着什么?

这意味着我们完成了破坏性变更的开发。许多顶层的重构已经完成,未来特性(包括当前的特性)的开发打下了很好的基础。

什么时候适合升级?

这个看情况。升级很有可能不会一次成功,你可能需要尝试两次甚至三次。如果你对这个过程并不敏感,那么欢迎你立即升级并且向webpack,插件,loader等提供反馈。我们非常渴望修复其中的问题。它们中的一些已经被修复,你可能就是从他人的反馈中受益的一份子。

赞助更新

webpack完全是靠赞助来维持运转的。它跟一些大公司,比如一些开源项目并无瓜葛。99%的赞助都用来根据贡献的大小支付给webpack代码的贡献者和维护者。我们坚信这样的投资会让webpack发展得更好。
由于疫情的缘故,很多公司对于开源项目的赞助变少了,webpack正处于疫情的不利影响下(正如很多公司和人正经历的那样)。
我们没有能力向贡献者们支付他们本该获得的酬劳,但是现在我们只有一半的资金可用,我们不得不进行开支的削减。直到情况有所好转,我们只会给每月前10天提交代码的贡献者或者维护者支付酬劳。剩下的日子他们都是志愿工作,由他们原本的雇主支付薪水,或者通过做其他的一些事来赚钱。这意味着我们支付的头10天的酬劳将远远大于开发者们付出的时间。
最诚挚的感谢送给trivago,他们在过去的三年中给webpack提供了大量的赞助。遗憾的是他们无力在今年继续进行赞助,因为他们本身也受到了新冠病毒的影响。我希望其他的公司能够像他们那样慷慨解囊。
感谢所有的赞助者!

总体的方向

这次的发行版改动点集中在以下几个方向:

  • 通过持久化缓存提审构建性能
  • 通过更好算法和默认设置来提升长期缓存的效果
  • 通过web平台来提升兼容性
  • 清理掉内部的一些遗留的结构,在v4版本中,为了实现一些特性而引入了一些古怪的状态,这里没有引入破坏性变更
  • 为了未来的一些特性,这里使用引用了一些破坏性的变更,这使得我们在v5版本能够停留足够长的时间

迁移指南

详情点击migration guide

主要变更之移除

移除废弃的配置项目

v4中所有的废弃项目被删除。
迁移:确保你的webpack 4打包过程中不会打印任何的有关废弃api的告警。
这里有一些项目被移除了,但是在v4版本中并不会发出废弃api的告警:

  • IgnorePlugin和BannerPlugin现在必出传入一个参数,该参数可以是对象,字符串或者函数。

移除代码

新的弃用包括一个弃用代码,因此它们更易于引用。

废弃的语法

require.include被废弃,使用的时候会有warning。
告警的行为可以在Rule.parser.requireInclude设置为允许,废弃或禁止。

自动的node.js polyfill被移除

在早些时候,webpack致力于让Node.jsd的模块能够运行在浏览器中,但是情况发生了变化,很多模块仅仅是为了前端的使用而编写。小于等于4版本的webpack为很多Node.js模块封装了polyfills,一旦有某个模块使用了node.js的核心模块这些polifills将会生效(例如crypto模块)。
这样的兼容使得使用那些为node.js编写的模块非常方便,但是这也导致打包文件中引入了很多的polyfills代码,在很多时候这些polifills都是不必要的。
webpack 5停止自动去兼容这些node核心模块,将开发重心聚焦于前端模块的兼容性。我们的目标是提审web平台的兼容性,很多时候Node.js核心模块都是不必要的。
迁移:

  • 尽可能使用具有浏览器兼容性的模块
  • 请尽可能手动加入针对Node.js模块的polyfill,将会有报错信息来指导你这样做
  • 包作者:请在package.json中使用borwser域,确保包能够在浏览器环境下运行。为浏览器环境提供其他实现或者依赖来解决兼容性问题。

主要变更之长期缓存

确定性的chunk,模块id和导出命名

长期缓存中引入了新的算法,这在生产模式中被自动引入。也就是类似这样的配置:

chunkIds: "deterministic" moduleIds: "deterministic" mangleExports: "deterministic"

算法以确定的方式指定3到5位数字id给模块和chunks,2位字符作为输出的名字。这是在打包体积和长期缓存之间做出的妥协。
moduleIds/chunkIds/mangleExports: false将会禁止默认行为,你可以通过引入插件来使用常规算法。注意在webpack 4中,设置moduleId/chunkIds:false却引入插件是可以运行的,但是在wepack 5中必须提供一个插件。
迁移:
最好在chunkIds,moduleIds,mangleExports使用默认值设置。你也可以在配置中使用以前的默认值chunkIds: "size", moduleIds: "size", mangleExports: "size".这样打包体积会更小,但是会让打包过程中的缓存更加频繁地失效。(换句话来说,打包速度变慢了,译者注)
注意:在webpack 4中哈希过后的模块id降低了gzip的性能,这跟模块顺序的变更有关,现已被修复。
注意:在webpack 5中,deterministicid(持久化id)在开发环境下默认启用

真实的内容hash

webpack 5在配置[contenthash]将会使用文件内容的hash。先前仅仅使用文件内部结构的hash。在仅仅是注释和变量重命名时,将会对长期缓存产生正面影响。这些变化在代码压缩之后是不可见的。

主要变化之开发支持

具名Chunk id

在开发模式中,将会默认启用新的chunk id命名算法,这会给chunk和文件名赋予具有可读性的名字。一个模块(module)的ID取决于它的路径,同上下文有关.一个chunk的ID取决于chunk的内容。
所以你不用再使用类似import(/* webpackChunkName: "name" */ "module")来debugging,但是如果你想控制生产环境下的文件名时,这样做依然有意义。
在生产环境中很有可能使用chunkIds: "named"这样的写法,但是请确保这样不会暴露一些敏感的模块名。
迁移:
在开发模式下,如果你不喜欢文件名的随意改变,你可以传入chunkId: "natural"来使用老的数字命名的形式。

模块联合(module federation)

webpack 5添加了一个新的特性叫做"模块联合",这使得开发者可以使用多个webpack的构建结果来共同工作。从运行时的角度来看,来自不同构建的模块能够被连接在一起成为一个巨大的模块图结构。从开发者的角度来看,模块能能够在最小的限制下从不同的远端构建引入。更对细节请查看这篇单独的指引

主要变动之新的web平台特性

JSON 模块

JSON模块现在遵从协议的规定,如果使用非默认的输出是将会有告警。当从一个严格模式的ECMAScript模块中引入时,JSON模块将不再有具名导出。
迁移:
使用默认导出。
尽管使用了默认导出方式,设置optimization.usedExports会使得没有使用到的属性被丢弃。设置optimization.mangleExport绘制的属性名被破坏性优化(译者注:属性名会被修改,减少字符数).
可以通过在rule.parser.parse中指定JSON的解析器来引入类似JSON结构的文件,比如toml,yaml,json5等等

import.meta

  • import.meta.webpackHotmodule.hot的别名,这个在严格模式下的ESM中也是生效的
  • import.meta.webpack是webpack的主版本号
  • import.meta.url是当前文件的文件url(类似于__filename,但是作为文件的url)

asset模块

webpack 5对表示assets的模块有原生支持。这些模块要么将一个文件放入输出文件夹,要么将一个DataURI放入javascript打包文件中。这两种方式都提供了一个URL。
可以通过多种方式引用:

  • 老方法:import url from "./image.png"并且在module.rules中设置type: "asset"(当improt的方式匹配的时候)
  • 新方法:new URL("./image.png", import.meta.url)
    这里的新方法预发允许代码在未打包的情况下运行,这个语法在原生ECMAScript模块中可以在浏览器中执行。

原生worker支持

new URLnew Worker / new ShareWorker / navigator.serviceWorker.register等一起使用的时候,webpack将会为web worker生成一个单独的入口。
new Worker(new URL("./worker.js", import.meta.url))
这个语法也允许在未打包的情况下使用。在原生ECMAScript模块这样使用在浏览器中也是支持的。

URIs

webpack 5支持控制接口请求中的协议。

  • data: 支持。Base64或者原始的编码内容都支持。Mimetype能够被映射到module.rules中的各个loader。例如:import x from "data:text/javascript,export default 42"
  • file: 支持
  • http(s):支持。但是需要配置new webpack.experiments.schemesHttp(s)UriPlugin()
    ***默认情况下目标是web,这些URIs用来获取外部资源(都属于externals)
    请求中的分块也是支持的,例如:./file.js#fragment

异步模块

webpack 5支持所谓的异步模块。这些模块并不会同步执行,他们被异步的promise来替代了。
通过import引入的模块会被自动处理,并不需要额外的操作,这其中的差别几乎无法识别。
通过require()引入的模块,将会返回一个promise,这个promise的resolve返回原先的exports.
在webpack中,有多个方法引入异步模块:

  • 异步externals(async externals)
  • 新规范中的WebAssembly 模块
  • 使用顶层await 的ECMAScritp模块

Externals

webpack 5中引入了额外的外部文件(external)类型来应对更多的应用场景:
promise:一个返回Promise的表达式。外部的模块是异步的,并且promise resolve的值就是模块的exports.
import:原生的import()是用来加在特定请求的。外部的模块是异步模块。
module:暂时没有实现,但是打算通过import x from "..."来实现加载模块的功能
script:通过<script标签来加载url,通过一个全局变量来获取其输出(包括他的属性,如果存在的话),这里external的模块是一个异步模块

主要变化之新的node.js生态系统特性

resolving

在package.json中支持使用exportsimports
Yarn PnP现在原生支持。
更多细节请查看包导出

主要变化之开发体验

构建目标优化

webpack 5允许传入一个构建目标列表,可以精细化控制构建目标的版本。
例如:target: "node14" target: ["web", "es2020"]
这是一个给webpack提供所构建目标信息的方法,告诉构建需要什么,比如:

  • chunk的下载机制
  • 支持的语法

stats

stats的测试格式提升了可读性,降低了配置的繁琐性。默认配置变的更加简洁并对也适用于大型项目的构建。

  • Chunk之间的关系现在被默认隐藏了。可以通过stats.chunkRelations来开启。
  • stats现在会区分fileauxiliaryFiles
  • stats现在回默认隐藏module和chunk的id,可以通过stats.ids开启
  • modules的列表心在会按照其距离入口文件的距离来排序。这个可以通过stats.modulesSort来调整
  • chunk列表现在的顺序是通过module的名字来排序。这个可以通过stats.chunkModulesSort来调整
  • 串联模块(concatenated module)中的嵌套模块列表将根据拓扑顺序进行排序。可以通过stats.nestedModulesSort来调整
  • Chunks和Assets现在会展示id提示
  • Assets和module将会进行树形展示,以前是表格形式展示
  • 通用信息的总结会在构建流程的最后展示,它展示webpack的版本,配置的名字和报错、告警的数量
  • hash现在会被默认隐藏,可以在stats.hash中进行配置
  • 构建的时间戳现在不会默认展示。可以在stats.builtAt中进行设置。在最后构建最后的的总结输出中将会展示时间戳
  • 子编译过程现在默认不会展示。可以通过stats.children进行配置。

过程

ProgressPlugin进行了一定的优化,通过--progress可以在CLI中进行优化,同时也可以作为一个插件手动添加。
它过去只会记录已完成的模块数。现在可以对入口数,依赖数等进行计数,他们都会被默认展示。
过去它只会展示当前正在进行的模块。这会导致过多的错误输出,在有一些console的情况下甚至会导致性能问题。这个特性现在被默认关闭(activeModules属性控制)。同时也减少了无谓的console.log输出。现在在构建过程中的stderr输出将会有500ms的截流。profiling模式现在也有升级,将会展示嵌套进程消息的时间。这将有助于分析由于插件所引入的性能问题。
一个新增的percentBy属性会告知ProgressPlugin如何计算进程的百分比。

new webpack.ProgressPlugin({ percentBy: 'entries' });

为了使得进程计算的百分比足够精确,ProgressPlugin将会缓存已知的总模块数并且在下一次构建中重用。第一次启动的时候会热启动缓存,后续的构建中会使用并且更新这份缓存。

自主区别命名

在webpack 4中,多个webpack在同一个html中运行时会产生冲突,因为他们使用同样的全局变量来做chunk的加载。为了修复,需要在output.jsonpFunction配置项中提供一个通用的名字。
webpack 5现在自动从package.json引入了一个独一无二的名字,并且使用它来作为output.uniqueName的内容。
这个值将会用来给所有潜在会冲突的全局变量独一无二。
迁移:为了实现独一无二的命名,可以移除package.json中的output.jsonFunction

自动的公共路径

webpack 5将会尽可能地自动配置output.publicPath

typescript 类型

webpack 5源码支持typescript,并且通过npm包进行了引入。
迁移:移除@types/webpack,请在名称不同时更新引用。

主要改动之优化(Optimization)

嵌套的树摇(tree-shaking)

webpack现在可以追踪输出内容的嵌套属性。这将在再次导出(reexporting)命名空间对象的时候提审tree shaking(移除没有使用的属性)的性能。

// inner.js
export const a = 1;
export const b = 2;

// module.js
export * as inner from './inner';
// or import * as inner from './inner'; export { inner };

// user.js
import * as module from './module';
console.log(module.inner.a);

在上述的例子中,变量b(没有引用)将会在生产环境中被移除

内部模块树摇

webpack 4中不会分析模块输入和输入之间的依赖。webpack 5有一个新的配置项optimization.innerGraph,在生产环境中默认开启。这个配置会进行对模块中的符号进行分析,找出从输入到输出的依赖。来看看下面这个例子:

import { something } from './something';

function usingSomething() {
  return something;
}

export function test() {
  return usingSomething();
}

内部图算法将会发现something只有在test被导出的时候才会使用。这会将很多没有使用过的内容打上标志位,以便在打包文件中移除。
"sideEffects": false这样设置的时候,这将会移除更多的模块。在这个例子中./something将会被移除,如果test没有被使用。
为了获得更多的关于没有使用的导出的信息,optimization.unusedExports需要被设置。为了移除没有副作用的模块,需要设置optimization.sideEffects
下面的语法符号在打包过程中将会被分析:

  • 函数声明
  • 类声明
  • 包含以下内容的export default和变量声明
    • 函数表达式
    • 类表达式
    • 序列表达式
    • /*#__PURE__*/表达式
    • 本地变量
    • imported 绑定
    • 内容
      反馈:在这个过程中如果你发现遗漏了什么没有列举出来,请给我们提issue,我们将会考虑加上。
      在模块中使用eval()将会使得这个优化失效,因为eval执行的代码内部可能引用域内的所有变量。
      这个优化也叫作深度作用域分析(Deep Scope Analysis)。

commonJs 树摇

webpack过去在针对Commonjs导出的资源,或者使用require()导出的资源不尽兴然和的特殊处理。
webpack 5增加了对Commonjs结构的支持,使得可以移除未使用的Commonjs输出并且从require()调用中追踪被引用的导出内容的名字。
这个新特性支持下面的结构:

  • exports|this|module.exports.xxx = ...
  • exports|this|module.exports = require("...") (reexport)
  • exports|this|module.exports.xxx = require("...").xxx (reexport)
  • Object.defineProperty(exports|this|module.exports, "xxx", ...)
  • require("abc").xxx
  • require("abc").xxx
  • 来自ESM的导入
  • 通过require()引用一个 ESM
  • 标记输出类型(特别处理非严格模式的ESM导入)
    • Object.defineProperty(exports|this|module.exports, "__esModule", { value: true|!0 })
    • exports|this|module.exports.__esModule = true|!0
  • 未来有可能支持更多的结构
    如果探测到无法分析的代码,webpack将会放弃追踪所有导出的信息(出于性能考虑)

副作用分析

package.json中的sideEffect标记将会允许手动标记没有副作用的模块,在没有使用的时候将会在构建中移除。
webpack 5将会根据源码静态分析的结果自动给模块标记是否有副作用。

每次运行时的优化

webpack 5现在能够在每次运行的时候去分析和优化模块(默认行为),每次运行等效于一个入口。这个机制保证只会到处真正被使用的入口文件。入口文件彼此之间不会互相影响。

模块聚合(module concatenation)

在每个运行时(runtime)都会进行模块聚合,这使得每个运行时都会有不同的聚合模块。
模块聚合成为了一等公民,任意的模块和依赖现在都可以实现。最初webpack 5已经对ExternalModules和json modules进行支持。在未来将会支持更多类型的模块。

常规树摇优化

export *现在会捕获更多的的信息,并且不会把default输出标记为被使用的内容。
export *webpack在发现冲突的导出时会抛出警告。
import()允许手动树摇模块,即通过类似/* webpackExports: ["abc", "default"] */这样的注释来指定。

开发与生产环境的相似性

我们通过提升开发模式和生产模式的相似性,来尽量在开发环境的构建性能和避免生产环境独有的问题之间找平衡。
webpack 5在开发和生产模式中都开启了sideEffects优化。在webpack 4中,由于sideEffects标记的错误,这个优化会导致一些只在生产环境才会出现的问题。在开发环境中页开启这个优化使得潜在的问题能够更早地暴露。
在很多时候,开发环境和生产环境是在文件系统大小写名感性不同的操作系统中运行的。webpack 5针对一些不合常理的大小写增加了新的错误和告警。

代码生成过程的提升

webpack会探测ASI(auto semicolon insertion,简称ASI, 译者注),同时没有分号插入的时候会产生更短的代码Object(...) -> (0, ...)
webpack会把对个输出的getter合并到一个运行时的函数调用中:r.d(x, "a", () => a); r.d(x, "b", () => b); -> r.d(x, {a: () => a, b: () => b});
现在webpack有一个新的配置项output.environment。这个配置会告诉webpack在运行时代码中可以使用哪些ECMAScript的特性。通常情况下不会直接指定这个配置项,而是在target中进行配置。
webpack 4过去只会生成ES5的代码。webpack 5现在可以生成ES5和ES6/ES2015的代码。
如果只考虑支持现代浏览器的话,可以使用箭头函数将会让生成的代码将会更短。使用带TDZ(暂时性死区 temporal dead zone,译者注)const声明会生成更多符合规范的代码。

优化target配置

在webpack 4中,target是一个很粗略的介于webnode之间的配置项(或者其他的目标)。webpack 5现在开放了更多的选项。
现在的target配置会比以往影响更多的生成代码。

  • chunk加载的方法
  • chunk的格式
  • wasm加载的方法
  • 在worker中chunk和wasm加载的方法
  • 全局对象的使用
  • publicPath是否应该被自动指定
  • ECMAScript 特性和预发在生成代码中的使用
  • externals默认开启
  • 部分Node.js兼容层的行为(global, __filename, __dirname
  • 解析modules(browser域,exportsimports条件)
  • 部分loader可能会改变上面的行为
    因为以上列举的原因,webnode之间的选择太粗略了,我们需要更多的信息.因而我们允许指定一个最小版本,比如node10.13并且推断更多的目标环境的属性。
    现在还可以将多个目标与数组组合,webpack将会找出所有目标的最小兼容属性。当使用没有提供完整信息(如“web”或“node”(没有版本号)的目标时,使用数组也很有用。例如['web','es2020']将会整合这两个部分的目标。
    这里有一个目标browserslist,将会使用浏览器列表属性去决定环境的属性。当这里有一个可用的browserslist配置可用的时候,这就是webpack的默认target。如果没有,web将会成为默认的target。
    一些组合和特性在当前版本中并没有实现,并且会抛出错误。他们是为未来的特性准备的,例如:
  • ["web","node"]将会让输出使用通用的chunk加载方法,但是这个目前没有实现。
  • ["web","node"] + output.module: true将会让输出使用module chunk加载方法,目前没有实现。
  • "web"将会使用http(s):来引入那些被认为是模块的external,目前并没有实现(折中方法:externalsPresets: {web: false, webAsync: true},这样将会使用import()来加载模块)

chunk分割和module的大小

modules现在并不单单使用数字来标识大小。现在有不同的的size类型。
splitChunksPlugin现在知道如何使用这些不同的大小,并将他们应用于minSizemaxSize。在默认情况下,只有javascript的大小会被计算,你可以传入多个值来控制计算的范围:

module.exports = {
  optimization: {
    splitChunks: {
      minSize: {
        javascript: 30000,
        webassembly: 50000,
      }
    }
  }
};

你依然可以只使用数字来标记大小。在这种情况下,webpack将会自动使用默认的size类型。
mini-css-extract-plugin使用css/mini-extra作为size类型,并且将这个size类型叫到了默认的types中。

主要变动之性能

持久化缓存

webpack现在将使用文件系统缓存。这个是可配置的,能够通过下面的配置开启:

module.exports = {
  cache: {
    // 1. Set cache type to filesystem
    type: 'filesystem',

    buildDependencies: {
      // 2. Add your config as buildDependency to get cache invalidation on config change
      config: [__filename]

      // 3. If you have other things the build depends on you can add them here
      // Note that webpack, loaders and all modules referenced from your config are automatically added
    }
  }
};

重点注意:
默认情况下,webpack会假设node_modules的文件路径只会被package manager改动。针对node_modules的hash和时间戳机制被抛弃了了。现在只有包的名字和版本会被考虑进来。系统全局的链接是可用的,只要resolve.symlink: false没有被设置(尽量避免这样做)。请不要直接修改node_modules下的内容,除非你决定通过snapshot.managedPaths: []来关闭对应的优化。当使用yarn Pnp时,webapck会假定yarn缓存是不可变的(通常情况下是这样)。你可以通过设置snapshot.immutablePaths: []来关闭这个优化。
缓存内容将会被放在node_modules/.cache/webpack目录下(但使用node_modules时).默认情况(使用yarn PnP)下缓存放在.yarn/.cache/webpack,通常情况下你不用手动删除过这些缓存,前提是所有的插件都有正确处理缓存。
许多内部插件也会使用持久化缓存。例如:SourceMapDevToolPlugin(混窜生成的sourceMap),ProgressPlugin(缓存模块数)。
持久化缓存将会自动根据用途创建多个缓存文件,以便优化读写过程。
默认情况下,时间戳将会在开发环境下被用来做快照,在生产环境下将会使用文件hash.文件hash同样支持在CI上使用持久化缓存。

编译器闲置和关闭

编译器在使用之后需要关闭。编译器现在会进入或者离开空闲状态,现在有钩子来控制这些状态。插件现在回通过这些钩子来做一些不重要的工作。(例如持久化缓存将会缓慢地存放在硬盘上)。在编译器关闭的时候,所有剩余的工作都需要尽快完成。将会有一个回调来告知编译器关闭。
插件和他们的作者应该预设部分的使用者可能忘记关闭编译器。在闲置模式中,所有的工作最终都应该完成。在工作完成的时候不应该还有运行的进程。
webpack()传入回调函数的时候,将会自动调用close;
迁移:尽管使用了Node.js API,请确保在完成的时候有调用Compier.close;

文件输出

webpack过去在第一次构建的时候将会输出所有的文件,在增量构建(watch)的时候会跳过对没有改动的文件的写操作。这里将会家丁在webpack运行的时候不会有其他的东西改动输出文件。
添加了持久缓存后,即使在重新启动webpack进程时也应该获得类似watch的体验,但如果认为即使webpack没有运行,也没有其他任何东西会更改输出目录,这种想法有点一厢情愿了。
所以webpack现在会去检查输出路径中存在的文件并且同内存中的输出文件内容进行比较。只有在内容有变动的时候才会去写文件。这个过程只会在第一次构建的时候发生。如果在webpack的运行进程中有新的内容生成,增量编译将会去写这些文件。
我们假定webpack和插件只会在内容改动的时候生成新的文件。缓存被用来确保在输入相等的时候不会有新的内容被生成。如果不遵从这个建议的话将会拖慢性能。
那些被标记为immutable的文件(包括内容hash),只要已经存在一个同名文件,将永远不会被写入。我们假设文件hash将会同文件内容一起改变。这个假设绝大多数时候是成立的。但是在webpack或者插件的开发过程中是可能不是这样。

主要变化之一些长期存在的突出问题

单文件目标的代码分割

以前那些只能通过单文件来启动的项目(比如node,webworker,electron主程序),现在支持在运行时初始化的过程中加载所需要的依赖。
这使得在chunks: "all"时可以用opimization.splitChunksoptimization.runtimeChunk来针对这些目标文件。
注意这些目标文件的chunk加载是异步的。这使得初始的评估过程也是异步的。在output.library时可能会产生问题,因为现在导出的值是promise。

更新resolver

webpack 5现在支持enhanced-resolve。现在做了如下优化:

  • 会追踪更多的依赖,比如一些小事的文件
  • aliasing现在可能有多个可选项
  • aliasing现在可以是false
  • 支持类似exportsimports这样的特性
  • 性能提升

非js的chunk

不含js代码的chunks将不再生成js文件。现在允许chunk只含有css.

主要改动之未来特性

实验

在开始的时候不是所有的特性都是稳定的。在webpack 4中我们增加了测试特性并且在changelog中进行了标注,但是在配置中这些特性是否是实验性的并不直观。
在webpack 5中,有一个新的experiments配置项能够用来开启实验中的特性。这可以直观地看到哪些特性被开启。
虽然webpack遵循语义版本控制,但它将为实验性功能提供一个例外。
实验特性在小版本中有可能会含有破坏性的变更。当这种情况发生的时候,我们将会在changelog中新增清晰的记录。这会使我们在维护实验特性的时候更快,同时也允许我们在主要版本上停留更长时间以获得稳定的功能。
下面的这些实验特性将会封装在webpack 5中:

  • webpack 4中对于老webassembly的支持(experiments.syncWebAssembly)
  • 根据更新的特性,对新webassembly的支持(experiments.asyncWebAssembly)
    • 这使得一个webassembly模块成为一个异步模块
  • 顶层await提案的支持(experiments.topLevelAwait
    • 在顶层模块shiyongawait使得这个模块成为异步模块。
  • 将输出打包文件作为模块(experiments.outputModule
    • 现在从打包文件中移除了IIFE( Immediately Invoked Function Expression 立即执行函数表达式)包裹器,增强了严格模式,通过<script type="module">来懒加载内容,模块模式中的最小化。
      这也意味着现在默认支持webassembly.

最小node版本支持

现在支持的最小node版本从6迁移到10.13.0.
迁移: 升级node到最新的可用版本。

配置的修改

架构变化

  • entry: {} 现在允许传入一个空对象(可以使用插件来添加入口)
  • target 支持数组、版本和浏览器列表
  • cach: Object 移除: 不能设置内容缓存对象
  • cache.type 新增:有两个可选项:memoryfilesystem
  • 针对cache.type = "filesystem"有新的配置项:
    • cache.cacheDirectory
    • cache.name
    • cache.store
    • cche.hashAlgorighm
    • cache.idleTimeout
    • cache.idleTimeoutForInitialSotre
    • cache.buildDependencies
  • 新增snapshot.resolveBuildDependencies
  • 新增snapshot.resolve
  • 新增snapshot.module
  • 新增snapshot.managedPaths
  • 新增snapshot.immutablePaths
  • 新增resolve.cache,允许开启或者关闭resolve缓存
  • 移除resolve.concord
  • resolve.alias的值能够为数组或者false
  • 新增resolve.restrictions 允许限制潜在的resolve结果
  • 新增resolve.fallback 允许对无法解析的请求进行别名
  • 新增resolve.preferRelative 允许将模块的解析请求也看做相对请求
  • 对于Node.js的的自动适配被移除
    • node.Buffer被移除
    • node.console被移除
    • node.process被移除
    • node.*(Node.js原生模块)被移除
    • 迁移:使用resolve.aliasProviderPlugin。有报错时将会有提示(请参阅node-libs-browser了解v4中的polyfill和mock是怎样做的)
  • output.filename 现在支持传入函数
  • 新增output.assetModuleFilename
  • output.jsonpScriptType重命名为output.scriptType
  • devtool现在更加严格
    • 格式:false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map
  • optimization.chunkIds,新增"deterministic"配置
  • optimization.moduleIds新增"deterministic"配置
  • optimization.moduleIds新增"hashed"配置
  • optimization.moduleIds移除"total-size"
  • 多个关于模块和chuank的标志位被移除
    • 移除optimization.hashedModuleIds
    • 移除optimization.namedChunks,NamedChunksPlugin也被移除
    • 移除optimization.namedModulesNamedModulesPlugin也被移除
    • 移除optimization.occurrenceOrder
    • 迁移:使用chunkIdsmoduleIds
  • optimization.splitChunks test不在匹配chunk的名字
    • 迁移:使用一个test函数(module, { chunkGraph }) => chunkGraph.getModuleChunks(module).some(chunk => chunk.name === “name”)
  • 新增optimization.splitChunks minRemainingSize
  • optimization.splitChunks filename现在可以为函数
  • optimization.splitChunks size现在能够为一个包含每个来源类型和size的映射对象
    • minSize
    • minRemainingSize
    • maxSize
    • maxAsyncSize
    • maxInitialSize
  • optimization.splitChunks maxAsyncSizemaxInitialSize新增了maxSize:允许定义不同的初始化chunk和异步chunk的最大size
  • optimization.splitChunks name:true被移除:现在不支持自动命名
    • 迁移: 使用默认配置。chunkIds: "named"将会为你的构建文件提供有意义的名字,方便debug
  • optimization.splitChunks.cacheGroups[].idHint新增:提供一个提示,说明如何选择命名chunk id
  • optimization.splitChunks automaticNamePrefix被移除
    • 迁移: 使用idHint来替代
  • optimization.splitChunks filename 不再局限于初始chunk
  • optimization.splitChunks usedExports在比较模块的时候将会包括已使用的导出
  • optimization.splitChunks.defaultSizeTypes新增:当使用具体数字来标识size时的大小类型
  • 新增optimization.mangleExports
  • optimization.minimizer "..."能够被用来引用默认内容
  • optimization.usedExports 新增"global"配置,允许能能够关闭每次运行时的分析改在全局做(出于性能考虑)
  • optimization.noEmitOnErrors重命名为optimization.emitOnErrors,相关逻辑也进行了翻转
  • 新增optimization.realContentHash
  • 移除output.devtoolLineToLine
    • 迁移:没有兼容方案
  • output.chunkFilename 现在允许传入函数
  • output.hotUpdateChunkFilename,现在不允许传入函数,传入也不会生效
  • output.hotUpdateMainFilename 现在不允许传入函数,传入也不会生效
  • output.importFunctionName 字符串可以指定用来替换import()的方法名,以便用来兼容不支持的环境
  • 新增output.charset 将这个设置为false可以移除script标签上的charset属性
  • output.hotUpdateFunction改名为output.hotUpdateGlobal
  • output.jsonpFunction改名为output.chunkLoadingGlobal
  • output.chunkCallbackFunction改名为output.chunkLoadingGlobal
  • 新增output.chunkLoading
  • 新增output.enabledChunkLoadingTypes
  • 新增output.chunkFormat
  • module.rules内部的resolveparser将会使用另外一种方式合并配置(对象将会深度merge,数组将会通过...来引用上一个值)
  • module.rules parser.worker新增,允许配置对worker的支持
  • module.rules下移除queryloaders
  • module.rules options不再支持传入字符串
    • 迁移:传入一个对象,如果不支持的话可以提issue
  • module.rules 新增mimetype,允许匹配DataURI的mimetype
  • module.rules 新增descriptionData,允许匹配package.json中的数据
  • module.defaultRules 可以使用"..."来引用默认配置
  • 新增stats.chunkRootModules展示chunk的根模块
  • 新增stats.orphanModules 显示未发出的模块
  • 新增stats.runtime,展示运行时的模块
  • 新增stats.chunkRelations 展示父、子、兄弟模块
  • 新增stats.errorStack 展示webpack内部对于错误堆栈的追踪
  • 新增stats.preset 选择一个预设值(preset)
  • 新增stats.relatedAssets 展示与其他assets相关的assets(比如sourceMap)
  • 为支持ignoreWarnings,现废弃stats.warningsFilter
  • BannerPlugin.banner签名修改
    • 移除data.basename
    • 移除data.query
    • 迁移:从filename中抽出
  • SourceMapDevToolPlugin 移除lineToLine
    • 迁移:没有替代
  • [hash] 完整编译过程中不再支持hash
    • 迁移:使用[fullhash]来替换其他的hash选项
  • [modulehash]被移除
    • 迁移 使用[hash]来替代
  • [moduleid]被废弃
    • 迁移:使用[id]来替代
  • [filebase] 被移除
    • 迁移:使用[base]来替换
  • 基于文件的模板使用新的占位内容(例如 SourceMapDevToolPlugin)
    • [name]
    • [base]
    • [path]
    • [ext]
  • externals 当传入函数的时候,现在有不同的信号签名({ context, request }, callback)
    • 迁移:改变签名
  • 新增externalsPresets
  • 新增experiments (请参见前文的Experiments部分)
  • 新增watchOptions.followSymlinks
  • watchOptions.ignored 现在可以为正则表达式
  • webpack.util.serialization 现在被暴露出来

默认配置的修改

  • target现在默认值为browserslist(当浏览器列表配置有效的时候)
  • module.unsafeCache现在默认只对node_modules有效
  • optimization.moduleIds在生产环境下默认值为deterministic,而不是size
  • optimization.chunkIds在生产环境下默认值为deterministic,而不是total-size
  • optimization.nodeEnvnone模式下默认为false
  • optimization.splitChunks.minSize在生产环境下默认为20k
  • optimization.splitChunks.enforceSizeThreshold在生产环境下默认为50k
  • optimization.splitChunks minRemainingSize默认为minSize
    • 这会使得剩余的部分非常小的时候,分割的chunk数目会更少
  • optimization.splitChunks maxAsyncRequestsmaxInitialRequests默认增加到30
  • optimization.splitChunks.cacheGroups.vendors被重命名为optimization.splitChunks.cacheGroups.defaultVendors
  • optimization.splitChunks.cacheGroups.defaultVendors.reuseExistingChunk默认设置为true
  • optimization.minimizer 在简洁状态时目标默认使用compress.passes: 2
  • 当使用缓存时,resolve(Loader).cache默认为true
  • resolve(Loader).cacheWithContext defaults默认为false
  • resolveLoader.extensions移除.json
  • node.global node.__filenamenode.__dirname在node-target时默认为false
  • stats.errorStack 默认为false

Loader相关改变

this.getOptions

这个新的api将会简化loader的配置。允许传入一个JSON来校验,查看详情

this.exec

这个方法在loader的上下文中被移除
迁移:现在可以由loader本身去实现

this.getResolve

在loader API总,getResolve(options)将会合并各个不同的配置,请见module.rules resolve.
因为webpack5在不同的发布依赖项之间存在差异,所以建议传入dependencyType来作为配置(例如"esm","commonjs")

主要的内部改变

以下的内容需要进一步调整
接下来的内容主要跟插件作者相关:

新的插件顺序

webpack 5的插件会在默认配置项生效之前生效。这使得插件能够使用他们自己的默认值,或者使用传入的配置值。
这是一个破坏性变更,因为插件不能依赖配置的值来生效了。
迁移:只能在插件钩子中访问配置。或者最好完全避免访问配置,并通过构造函数进行配置。

运行时模块

大量的运行时代码现在被移动到所谓的运行时模块中。这些特殊的模块负责添加运行时代码。他们将会被加入任何chunk中,并且总是会被加入到运行时chunk中。控制运行时模块的"运行时的需求"被添加到打包文件中。这将确保只有运行时代码会被添加到打包文件中。在未来,运行时模块将会被添加到一个需要被加载的chunk中,以便在需要的时候加载运行时代码。
在绝大多数情况下,核心的运行时逻辑允许在入口模块中插入行内内容,而不是调用__webpack_require__.如果在打包文件中没有其他的模块了,根本就不需要__webpack_require__。这很好地结合了模块连接(多个模块合并到一个模块)。
在理想状态下,是根本不需要运行时代码的。
迁移:如果你通过wepack插件在运行时中注入代码,可以考虑通过运行时模块来替换。

序列化

现在新增了序列化的机制,以便webpack中的能够对复杂对象进行序列化。语义化是可选的,所以需要被序列化的class需要被明确标记(他们的序列化已经实现)所有的模块,依赖和部分错误都已经完成了序列化。
迁移:当使用通过模块或者一来的时候,这里推荐使用序列化以便应用持久化缓存

缓存插件

添加了一个带有插件接口的缓存类。这个雷能够被用来对缓存进行读写。根据配置,不同的插件将会给缓存添加不同的功能。插件MemoryCachePlugin添加了内存缓存。FileCachePlugin将会添加持久化(文件系统)缓存。
FileCachePlugin使用序列化机制来从磁盘整持久化和存储缓存对象

Object Frozen添加钩子

带有钩子的类冻结了它们的hooks对象,因此不再能用这种方式添加自定义钩子
迁移:现在推荐使用WeakMap和一个静态的getXXXHooks(XXX)(比如:getCompilationHook(compilation))方法来添加通用钩子。内部的类使用同样的机制来处理通用的钩子。

tapable升级

为了webpack 3设置的兼容层被删除了。在webpack 4中也被废弃。部分不太常使用tapable api的被删除或废弃。
迁移:使用新的tabpable API

分阶段的钩子

在封装过程的几个阶段,有各个不同的钩子来处理这些不同的阶段,例如optimizeDependenciesBasic optimizeDependenciesoptimizeDependenciesAdvanced。为了使单个钩子能够使用stage选项,这些钩子已经被移除了。请查找OptimizationStages来获取更多的可选stage值。
迁移:请使用剩下的hook来替代,你可以添加stage选项。

Main/Chunk/ModuleTemplate 被废弃

构建模板被重构了。MainTemplate/ChunkTemplate/ModuleTemplate已经被废弃,JavascriptModulesPlugin 现在负责js的模板化。
在重构之前,JS的输出被Main/ChunkTemplate控制,其他输出(比如WASM,CSS)被插件控制。看起来JS像是第一等公民,其他的输出是第二等公民。重构带来的变化是所有的输出都被他们各自的插件控制。
现在一人可以介入到模板生成的过程中。这些钩子现在在JavascriptModulesPlugin中,而不是Main/ChunkTemplate(现在插件也支持hooks了,我称其为附加钩子)
现在有一个兼容层,所以Main/Chunk/ModuleTemplate依然存在,但只能将tap调用委托给新的钩子位置。
迁移:遵循弃用消息中的建议。主要指向不同位置的钩子。

入口描述符

如果一个对象作为入口的值被传入,那么他可能是字符串,数组裹着一个描述符:

module.exports = {
  entry: {
    catalog: {
      import: './catalog.js',
    }
  }
}

描述符语法将会传入额外的选项。

入口输出文件名

在默认情况下,入口chunk的输出文件名是从output.filename中提取的,但是你可以对某个特殊的入口指定一个输出文件名。

module.exports = {
  entry: {
    about: { import: './about.js', filename: 'pages/[name][ext]' }
  }
};

入口依赖

默认情况下,每一个入口chunk保存了它用到的所有模块,通过dependOn 选项,你可以在多个入口chunk键分享模块:

module.exports = {
  entry: {
    app: { import: './app.js', dependOn: 'react-vendors' },
    'react-vendors': ['react', 'react-dom', 'prop-types']
  }
};

app的chunk将不会包括react-vendors包含的模块

入口库

入口描述符允许针对每个入口传入不同的library选项

module.exports = {
  entry: {
    commonjs: {
      import: './lib.js',
      library: {
        type: 'commonjs-module'
      }
    },
    amd: {
      import: './lib.js',
      library: {
        type: 'amd'
      }
    }
  }
};

入口运行时

入口描述符允许针对每个入口指定runtime。指定时,将创建一个具有此名称的块,该块仅包含项的运行时代码。当多个入口指定了同样的runtime,这些入口的chunk都会包含同样的运行时。这意味着他们能够使用同一个html页面。

module.exports = {
  entry: {
    app: {
      import: './app.js',
      runtime: 'app-runtime'
    }
  }
};

入口chunk加载

入口描述符允许对每一个入口指定chunkLoading.运行时的入口将会指定的方法使用这个来加载chunk.

module.exports = {
  entry: {
    app: {
      import: './app.js'
    },
    worker: {
      import: './worker.js',
      chunkLoading: 'importScripts'
    }
  }
};

顺序和ID

webpack过去在编译过程中会对modules和chunk进行排序,具体来说,指定一个增序的id。现在这个机制被废弃了。顺序将不会被用来作为id生成的机制,id的控制逻辑将全部交给插件。
优化模块module和chunk排序的hooks被移除了。
迁移:你在也不能在编译阶段依赖module和chunk的顺序了。

数组到集合

  • Compilation.modules现在是一个集合(Set)
  • Compilation.chunks现在是一个集合
  • Chunk.files现在是一个集合
    这里有兼容设计,目前会打印即将废弃warngin.
    迁移:请使用集合的相关方法来替换数组相关方法

Compilation.fileSystemInfo

这个新的类能用来以缓存的方式获取文件系统相关的信息。现在,他能够请求文件和目录的时间戳。如果可能的话,时间戳的相关信息是从watcher中得来的,否则的话讲过从文件系统中获取。
在未来,请求文件hash将会被添加,模块将能够通过文件内容而不是文件hash去检查文件的可用性。
迁移:请使用file/contextTimestamps来替换compilation.fileSystemInfo.
现在支持文件目录的时间戳,这使得上下文模块的序列化成为可能。
现在引入了Compiler.modifiedFiles,使得能够获得改变文件的引用,(下一步会实现Compiler.removedFiles

文件系统

compiler.inputFileSystemcompiler.outputFileSystem之后,这里有一个新的compiler.intermediateFileSystem能够针对所有不被看做是输入或输出文件系统操作,比如写记录,缓存或者分析输出。
文件系统现在有fs实例了,并且不再需要额外的方法,比如join或者mkdirp.但如果他们有类似于joindirname的方法,则去使用。

热更新模块替换

HMR 运行时现在已经被重构为运行时modules.HotUpdateChunkTemplate已经被合并到ChunkTemplate中。ChunkTemplates和插件现在需要控制HotUpdateChunk了。
javascript部分的HMR运行时已经从核心的HMR运行时中分离开。其他的模块类型也能够以他们各自的方式来控制HMR.在未来,为了mini-css-extract-plugin和WASM的HMR将成为可能。
迁移:因为这个一个新引入的特性,这里不需要迁移。
import.meta.webpackHotmodule.hot暴露了一样的API.这对严格模式下的ESM modules(.mjs,package.json中的’module’,他们无法访问module)也是适用的.

工作队列

webpack过去通过函数调用函数来控制模块进程,这里还有一个semaphore来控制进程并行数。Compilation.semaphore现在被移除,现在通过一个异步的丢了来控制工作队列和进程,每一步都有一个分开的队列:

  • Compilation.factorizeQueue调用模块工厂函数来处理一组依赖
  • Compilation.addModuleQueue 调价模块到编译队列(可能会从缓存中复原存储模块)
  • Compilation.buildQueue 在需要的时候构建模块(可能会从缓存中复原模块)
  • Compilation.rebuildQueue 如果手动出发的话,会再次构建模块
  • Compilation.processDependenciesQueue 处理模块的依赖项
    这些队列都是有一些钩子来观察或者监听任务的进度。
    在未来,多个编译器可能会同时工作,任务的协同可能通过监听这些队列来实现。
    迁移:因为这是一个新引入的功能,目前不需要迁移

日志上报

webpack内部现在有一些日志上报。stats.logginginfrastructureLogging选项能够用来开启日志信息。

模块和chunk图

webpack过去会存储依赖中已经解析的模块,存储已经包含在chunk中的模块。现在不会这样了,所有关于模块是如何被连接到模块图中的信息现在存储在ModuleGraph类中。还有关于模块是如何连接到chunks中的信息现在被存储在ChunkGraph类中。以来的相关信息(例如chunk图)也被存储在相关的类中。
这意味着下面这些关于模块的信息可以被移除:

  • Module connections -> ModuleGraph
  • Module issuer -> ModuleGraph
  • Module optimization bailout -> ModuleGraph(todo: 检查是否需要用ChunkGraph来替换)
  • Module usedExports -> ModuleGraph
  • Module providedExports -> ModuleGraph
  • Module pre order index -> ModuleGraph
  • Module post order index -> ModuleGraph
  • Module depth -> ModuleGraph
  • Module profile -> ModuleGraph
  • Module id -> ChunkGraph
  • Module hash -> ChunkGraph
  • Module runtime requirements -> ChunkGraph
  • Module is in chunk -> ChunkGraph
  • Module is runtime module in chunk -> ChunkGraph
  • Chunk runtime requirement -> ChunkGraph
    wepack过去会在从缓存中恢复modules的时候断掉模块和graph的链接。现在不再必要了。模块不存储有关图的信息,因为技术上可以在多个图中使用复用相关信息。这更加方便缓存。
    对于绝大多数的改动,这里有兼容层,在使用的时候会打印api废弃的信息。
    迁移:使用ModuleGraph和ChunkGraph中的新api

初始碎片化

DependenciesBlockVariables已被移除,取而代之的是initFragments.
DependencyTemplates现在可以通过添加initFragments将代码注入到模块源的顶层,InitFragments允许复写。
迁移:使用InitFragments,而不是在源码中插入负索引。

模块的源类型

模块现在必须通过Module.getSourceTypes()定义是什么类型的源是支持的.根据这个机制,不同的插件通过不同的类型来调用source()。例如,对于源类型javascript,JavascriptModulesPlugin将源码嵌入到打包文件中。源码类型webassembly将会使得WebAssemblyModulesPlugin输出一个wasm文件。常见的源码类型都是支持的,例如mini-css-extract-plugin将会用来支持stylesheet,将源码插入到css文件中。
模块类型和源码类型之间没有必然联系。例如模块类型json可以使用javascritp类型,模块类型webassembly/experimental可以使用源码类型javascriptwebassembly.
迁移:常用的模块需要去实现这些新的接口方法。

Stats相关插件

Statspreset,default,jsontoString现在刚出现在在插件系统中(译者注:此处翻译不大确定)。将当前的Stats转换为插件。
迁移:并不需要完全替换状态函数,你可以兼容它。额外的信息能够添加到stats json中,而不是写一个单独的文件。

新的watching

webpack的观察者被重构了。先前使用chokidar和原生的fsevents依赖(只在macOS).现在只依赖原生的Node.jsfs。这意味着在webpack没有原生依赖了。
在watching的时候还会捕获文件系统的信息。webpack现在也会捕获mtimes,同时监视事件的次数。由此,WatchFileSystemAPI有些许调整。因为我们把Array转换为集合,把对象转换为Map。

在emit之后SizeOnlySource

webpack现在会将Compilation.assets中的源替换为SizeOnlySource的变体,以便减少内存的使用。

多次发送assets

警告Multiple assets emit different content to the same filename现在会成为一个error.

导出信息

模块导出信息的存储方式在新版本中进行了重构。ModuleGrap现在在module中都有一个ExportsInfo,每一个输出都会储存对应的信息。如果模块在使用过程中有副作用,webpack会存储位置导出的信息。
针对每一个导出,如下的信息会被储存:

  • 这个导出是否被使用?是,否,不是静态值,不确定(请参考optimization.usedExports
  • 导出被提供了吗?是,否,不是静态值,不确定(请参考optimization.providedExports
  • 导出可以被命名或者重命名吗?是,否,或者不确定。
  • 新的名字,导出的名字是否被重命名(详见optimization.mangleExports)
  • 嵌套的导出信息,如果导出是一个包含自身信息的对象
    • 用来再次导出命名对象:import * as X from "..."; export { X }
    • 用来表现JSON modules中的结构。

代码生成阶段

现在编译过程将代码生成看做分来的编译阶段。这部分不再在Module.source()Module.getRuntimeRequirements()背后执行了。
这样使得整个工作流更加清晰。现在在编译过程中上报进度成为可能,代码生成的过程在分析时更加可视化。
迁移:Module.source()Module.getRuntimeRequirements()被废弃。请使用Module.codeGeneration()来替换。

依赖引用

webpack过去使用单一方法和类型来表现依赖的应用(Compilation.getDependecyReference)。此类型过去用于包含有关此引用的所有信息,例如已导入导出的引用模块(如果它是弱引用)以及一些与排序相关的信息。
将所有的信息打包在一起使得引用依赖代价昂贵,这个也会被经常调用(每次调用可能有人会需要其中的部分信息)
在webpack 5中,这一部分的代码被重构了,部分方法被分离出来。

  • Compilation.factorizeQueue为一系列的依赖调用模块工厂函数
  • Compilation.addModuleQueue将一个模块添加到编译队列中(有可能从缓存中恢复)
  • Compilation.buildQueue在必要的时候构建模块(可能将模块存储到缓存)
  • Compilation.rebuildQueue如果手动触发的话会再次构建的模块
  • Compilation.processDependenciesQueue 处理模块的依赖
    这些队列都有钩子来实现观察和监视进程。
    在未来,多个编译器可能会一起工作,这些多进程的协作能够通过队列的拦截来实现。
    迁移:因为这是一个新引入的功能,没有什么需要迁移。

logging

webpack内部包括了多个logg逻辑。stats.logginginfrastructureLogging选项能够控制这些log的开启。

module和chunk图

webpack过去会存储已经解析的模块在依赖中,存储已经包含的模块都chunk中。现在不会这样了。所有关于模块的信息都被连接到模块图中。所以他们永远不用引用模块或者影响输入输出。
这些依赖处理起来更方便,webpack会尽可能的使用他们。

废弃的loaders

  • null-loader
    这个将会被废弃,使用
    module.exports = {
      resolve: {
        alias: {
          xyz$: false
        }
      }
    };
    
    或者使用绝对路径
    module.exports = {
      resolve: {
        alias: {
          [path.resolve(__dirname, '....')]: false
        }
      }
    };
    

小改动

  • Compiler.name:当用绝对庐江来产生一个编译器名字的时候,确保使用|或者!来分隔名字
    • 使用空格来作为分隔符的方法被废弃了(路径可以包含空格了)
    • Hint: 在Stats字符串输出中,|被空格替换
  • SystemPlugin 现在默认关闭
    • 迁移:避免使用它,因为规范已经被移除,你可以通过设置Rule.parser.system:true重新启用
  • ModuleConcatenationPlugin:由于DependencyVariables已被删除,因此不再阻止连接
    • 这意味着现在可以在module,global,process或者其他提供的插件中进行联结(concatenate)
  • Stats.presetToOptions被移除
    • 迁移:使用compilation.createStatsOptions来进行替代
  • SingleEntryPluginSingleEntryDependency被移除
    • 迁移:使用EntryPluginEntryDependency
  • Chunk现在可以有多个入口modules
  • ExtendedAPIPlugin被移除
    • 迁移:不在需要了,__webpack_hash____webpack_chunkname__能够保证运行时代码在需要的地方被注入
  • ProgressPlugin 不再使用tapable上下文来reportProgress
    • 迁移:使用ProgressPlugin.getReporter(compiler)来替代
  • ProvidePlugin 因为.mjs文件,现在重新可用了
  • Statsjsonerrorswarnings不再包括字符串但是带有信息的对象将会被分裂成多个属性。
    • 迁移:通过属性来获取信息,比如message
  • Compilation.hooks.normalModuleLoader被废弃
    • 迁移:使用NormalModule.getCompilationHooks(compilation).loader来替代
  • NormalModuleFactory中的钩子有调整,从waterfall改到bailing,改变和重命名钩子将返回waterfall函数
  • 移除compilationParams.compilationDependencies
    • 插件将通过compilation.file/context/missingDependencies在编译过程中添加依赖。
    • 兼容层将会把compilationDependencies.add代理到fileDependencies.add
  • stats.assetsByChunkName[x]现在总是一个数组
  • 新增__webpack_get_script_filename__以便获得脚本文件的名字
  • package.json中的sideEffects将会被glob-to-regex来控制,而不是micromatch
    • 这样有可能会改变一些边缘情况下的语义
  • checkContext被从IgnorePlugin中移除
  • 新的__webpack_exports_info__api允许对导出的使用情况进行自省(introspection)
  • SourceMapDevToolPlugin现在也作用于非chunk的asset了
  • 从schema中移除了serve属性

其他小改动

  • 移除内建目录,使用运行时模块来替换
  • 移除掉废弃的特性
    • BannerPlugin现在只支持一个参数,这个参数可以为对象,字符串或者函数
  • 移除CachePlugin
  • ChunkentryModule被废弃,使用ChunkGraph来替代
  • Chunk.hasEntryModule被废弃了
  • Chunk.addModule被废弃了
  • Chunk.removeModule被废弃
  • Chunk.getNumberOfModules被废弃
  • Chunk.modulesIterable被废弃
  • Chunk.compareTo被废弃
  • Chunk.containsModule被废弃
  • Chunk.getModules被废弃
  • Chunk.remove被废弃
  • Chunk.moveModule被废弃
  • Chunk.integrate被废弃
  • Chunk.canBeIntegrated被废弃
  • Chunk.isEmpty被废弃
  • Chunk.modulesSize被废弃
  • Chunk.size被废弃
  • Chunk.integratedSize被废弃
  • Chunk.getChunkModuleMaps被废弃
  • Chunk.hasMduleInGraph被废弃
  • Chunk.updateHash信号变更
  • Chunk.getChildIdsByOrders信号变更(TODO:考虑迁移到ChunkGraph
  • Chunk.getChildIdsByOrdersMap信号变更(TODO:考虑迁移到ChunkGraph
  • Chunk.getChunkModuleMaps被移除
  • Chunk.setModules被移除
  • 过去被废弃的chunk方法被移除
  • 新增ChunkGraph
  • ChunkGroup.setParents被移除
  • ChunkGroup.containsModule被移除
  • ChunkGroup.remove不再断开与块中的group的链接
  • ChunkGroup.compareTo信号变更
  • ChunkGroup.getChildrenByOrders信号变更
  • ChunkGroupindex 和index(怀疑是笔误,译者注)被重命名为前序或者后序
    • 老的getter被废弃
  • ChunkTemplate.hooks.modules信号改变
  • ChunkTemplate.hooks.render信号改变
  • ChunkTemplate.updateHashForChunk信号改变
  • Compilation.hooks.optimizeChunkOrder已移除
  • Compilation.hooks.optimizeModuleOrder已移除
  • Compilation.hooks.advancedOptimizeModuleOrder已移除
  • Compilation.hooks.optimizeDependenciesBasic已移除
  • Compilation.hooks.optimizeDependenciesAdvanced已移除
  • Compilation.hooks.optimizeModulesBasic已移除
  • Compilation.hooks.optimizeModulesAdvanced已移除
  • Compilation.hooks.optimizeChunksBasic已移除
  • Compilation.hooks.optimizeChunksAdvanced已移除
  • Compilation.hooks.optimizeChunkModulesBasic已移除
  • Compilation.hooks.optimizeChunkModulesAdvanced已移除
  • Compilation.hooks.optimizeExtractedChunksBasic已移除
  • Compilation.hooks.optimizeExtractedChunks已移除
  • Compilation.hooks.optimizeExtractedChunksAdvanced已移除
  • Compilation.hooks.afterOptimizeExtractedChunks已移除
  • 新增Compilation.hooks.stillValidModule
  • 新增Compilation.hooks.statsPreset
  • 新增Compilation.hooks.statsNormalize
  • 新增Compilation.hooks.statsFactory
  • 新增Compilation.hooks.statsPrinter
  • Compilation.fileDependencies,Compilation.contextDependenciesCompilation.missingDependencies现在是懒设置的
  • Compilation.entries被移除
    • 迁移:使用Compilation.entryDependencies来替换
  • Compilation._preparedEntrypoints被移除
  • dependencyTemplates现在是一个DependencyTemplates的类,而不是一个简单的Map
  • Compilation.fileTimestampscontextTimestamps被移除
    • 迁移:使用Compilation.fileSystemInfo来替代
  • Compilation.waitForBuildingFinished被移除
    • 迁移:使用新的队列
  • Compilation.addModuleDependencies被移除
  • Compilation.prefetch被移除
  • Compilation.hooks.beforeHash现在在模块的hash被创建之后将会调用
    • 迁移:使用Compiliation.hooks.beforeModuleHash来替代
  • Compilation.applyModuleIds被移除
  • Compilation.applyChunkIds被移除
  • 新增Compiler.root,它会指向跟编译器
    • 它将会被用来在webpackMaps中缓存数据,而不是静态限定范围
  • 新增Compiler.hooks.afterDone
  • Source.emitted不在通过编译器设置
    • 迁移:请查看Compilation.emittedAssets
  • 新增Compiler/Compilation.compilerPath,这是编译器在编译器树中的独一无二的名字(与根编译器的域不同)
  • Module.needRebuild被废弃
    • 迁移: 使用Module.needBuild来替代
  • Dependency.getReference签名变化
  • Dependency.getExports签名变化
  • Dependency.getWarnings签名变化
  • Dependency.getErrors签名变化
  • Dependency.updateHash签名变化
  • Dependency.module被移除
  • 现在DependencyTemplate有一个基类
  • MultiEntryDependency被移除
  • 新增EntryDependency
  • EntryModuleNotFoundError被移除
  • SingleEntryPlugin被移除
  • 新增EntryPlugin
  • 新增Generator.getTypes
  • 新增Generator.getSize
  • Generator.generate签名变更
  • 新增HotModuleReplacementPlugin.getParserHooks
  • Parser被移动到JavascriptParser
  • ParserHelpers被移动到JavascriptParserHelpers
  • MainTemplate.hooks.moduleObj被移除
  • MainTemplate.hooks.currentHash被移除
  • MainTemplate.hooks.addModule被移除
  • MainTemplate.hooks.requireEnsure被移除
  • MainTemplate.hooks.globalHashPaths被移除
  • MainTemplate.hooks.globalHash被移除
  • MainTemplate.hooks.hotBootstrap被移除
  • MainTemplate.hooks部分签名变更
  • Module.hash被废弃
  • Module.renderedHash被废弃
  • Module.reasons被移除
  • Module.id被废弃
  • Module.index被废弃
  • Module.index2被废弃
  • Module.depth被废弃
  • Module.issuer被废弃
  • Module.profile被移除
  • Module.prefetched被移除
  • Module.built被移除
  • Module.used被移除
    • 迁移:使用Module.getUsedExports来替代
  • Module.optimizationBailout被废弃
  • Module.exportsArgument被移除
  • Module.optional被废弃
  • Module.disconnect被移除
  • Module.unseal被移除
  • Module.setChunks被移除
  • Module.addChunk被废弃
  • Module.removeChunk被废弃
  • Module.isInChunk被废弃
  • Module.isEntryModule被废弃
  • Module.getChunks被废弃
  • Module.getNumberOfChunks被废弃
  • Module.chunksIterable被废弃
  • Module.hasEqualsChunks被移除
  • Module.useSourceMap被移动到NormalModule
  • Module.addReason被移除
  • Module.removeReason被移除
  • Module.rewriteChunkInReasons被移除
  • Module.isUsed被移除
    • 迁移:使用isModuleUsed,isExportUsedgetUsedName来替代
  • Module.updateHash签名变更
  • Module.sortItems被移除
  • Module.unbuild被移除
    • 迁移:使用invalidateBuild来替代
  • 新增Module.getSourceTypes
  • 新增Module.getRuntimeRequirements
  • Module.size签名变更
  • ModuleFilenameHelpers.createFilename签名变更
  • ModuleProfile类新增更多数据
  • ModuleReason被移除
  • ModuleTemplate.hooks签名变更
  • ModuleTemplate.render签名变更
  • Compiler.dependencies被移除
    • 迁移:使用MultiCompiler.setDependencies来替代
  • MultiModule被移除
  • MultiModuleFactory被移除
  • NormalModuleFactory.fileDependencies,NormalModuleFactory.contextDependenciesNormalModuleFactory.missingDependencies现在是懒设置的
  • RuntimeTemplate方法现在获取runtimeRequirements的参数
  • serve这个属性被移除
  • Stats.jsonToString被移除
  • Stats.filterWarnings被移除
  • Stats.getChildOptions被移除
  • Statshelper方法被移除
  • Stats.toJson签名改变(第二个参数被移除)
  • ExternalModule.external被移除
  • HarmonyInitDependency被移除
  • Dependency.getInitFragments被废弃
    • 迁移:使用apply,initFragements来替代
  • 依赖引用现在将一个函数传给module而不是一个Module
  • HarmonyImportSpecifierDependency.redirectedId被移除
    • 迁移:使用setId来替代
  • acorn从 5 升级到 8
  • 测试
    • 热测试用例现在会作用于多个对象async-node,node,web,webworker
    • 测试用例现在会对标记为store: "instant"store: "pack"文件系统缓存运行
    • 测试用例现在会作用于确定的模块id
  • 新添加工具以便给imports排序(请在CI中查阅)
  • 当chunk名等于chunk id的时候,运行时的Chunk名字映射将不会包含入口
  • stats的原因新增resolvedModuleId,resolvedModuleIdentifierresolvedModule属性来指向优化前(比如作用域提升)的module
  • 在Stats的toString输出中展示resolvedModule
  • loader-runner升级https://github.com/webpack/loader-runner/releases/tag/v3.0.0
  • 出于性能考虑,Compilation中的file/context/missingDependencies将不再排序
    • 不要依赖顺序
  • webpack-sources升级到v2版本https://github.com/webpack/webpack-sources/releases/tag/v2.0.1
  • 对webpack-command的支持被移除
  • 使用schema-utils@2对schema进行验证
  • Compiler.assetEmitted的第二个参数可以携带更新信息
  • BannerPlugin会删除掉多余的空格
  • 移除掉LimitChunkCountPlugin中的minChunkSize
  • 将javascript相关文件重新组织到子目录中
    • webpack.JavascriptModulesPlugin -> webpack.javascript.JavascriptModulesPlugin
  • 新增Logger.getChildLogger
  • DllPlugin中的entryOnly默认设置为true
  • 删除特殊请求缩短逻辑,并为可读的模块名称使用单个相对路径
  • 允许SourceMap中的webpack://urls,以便给webpack的根上下文提供相对路径
  • 添加API以生成和处理针对Web包配置的CLI参数
  • 当使用System.js作为libaryTarget的时候,新增__system_context__来作为System.js的上下文
  • 新增对DefinePlugin的bigint支持
  • 新增对基础功能(比如Math)的bigint支持
  • 删除创建哈希后修改编译哈希的能力
  • 移除HotModuleReplacementPlugin中的multiStep模式
  • 当潜逃的对象和数字被使用的时候,emitAsset中的assetInfo将会合并
  • 当基于filename的路径(比如saaets)时,[query]现在是一个可用的占位符
  • 新增Compilation.deleteAsset来正确地删除一个assets和没有共享的相关assets
  • require("webpack-sources")暴露为require("webpack").sources
  • 使用terser 5压缩代码
  • Webpack用在句首的时候,首字母可以大写为W

参考文档

webpack 5 发布官方文档

上一篇:2016-2017 CT S03E07: Codeforces Trainings Season 3 Episode 7 - HackerEarth Problems Compilation 解题报告


下一篇:electron-vue报错:Webpack ReferenceError: process is not defined