javascript - Webpack 4 对带有副作用的包有什么期望 : false

Question

Webpack 4 添加了一项新功能:它现在支持在其 bundle 的模块的 package.json 中使用 sideEffects 标志。

来自 Webpack 4: released today

Over the past 30 days we have worked closely with each of the frameworks to ensure that they are ready to support webpack 4 in their respective cli’s etc. Even popular library’s like lodash-es, RxJS are supporting the sideEffects flag, so by using their latest version you will see instant bundle size decreases out of the box.

来自 Webpack docs

The "sideEffects": false flag in big-module's package.json indicates that the package's modules have no side effects (on evaluation) and only expose exports. This allows tools like webpack to optimize re-exports.

虽然第二个链接显示了使用标志的结果，但没有清楚地解释什么是副作用。 ES6 包括概述的模块副作用的概念 here ，但这与 Webpack 认为的副作用有什么关系。

在 sideEffects 标志的上下文中，模块需要避免什么才能毫无问题地使用 sideEffects:false，或者相反，模块需要做什么为了使用 sideEffects:false 没有问题。

为了完整起见，尽管@SeanLarkin 在下面给出了可靠的回答，但我很乐意澄清以下内容:

1. 显然，副作用在 fp 中意味着一些特殊的东西，包括日志记录(控制台或其他地方)和错误的抛出。我假设在这种情况下这些是完全可以接受的？

2. 模块是否可以包含循环引用并仍然使用 sideEffects: false？

3. 是否有任何方法可以验证或模块是否能够验证模块是否可以 sideEffects: false 而不是试图追踪其误用导致的错误？

4. 是否有任何其他因素会阻止模块使用 sideEffects: false？

Answer 1

来自 webpack 团队的 Sean!我会尽我所能代替我们仍在进行中的文档来回答您的问题!

根据 ECMA 模块规范(我不会尝试找到链接，所以您必须在这里相信我，因为它已被隐藏)，

每当一个模块重新导出所有导出时，(无论是否使用)它们都需要被评估和执行，以防其中一个导出对另一个产生副作用。

例如，我用一张照片创建了一个小场景，以更好地形象化案例:

在这张照片中，我们看到三个模块被导入到一个文件中。然后从该模块重新导出导入的模块:

你可以在这里看到没有一个重新导出是相互影响的，因此(如果给 webpack 一个信号)，我们可以省略导出 b 和 c 甚至不被跟踪或使用(大小和构建时间性能优势)。

但是在这种情况下，我们看到 exports c 受到局部状态变化的“影响”，因为它被重新分配给 b 和 a< 的总和。因此，(这就是规范要求这样做的原因)，我们需要将 b 和 a 及其任何依赖项都包含到包中。

我们选择“sideEffects: false”作为节省编译时间和构建大小的方法，因为这允许我们立即(明确地) trim 开发人员/库作者知道没有副作用的导出(以牺牲package.json 中的属性，或多 2-3 行配置)。

虽然从技术上讲这个例子非常原始，但是当你开始处理将一堆模块重新导出到更高级别的开发人员体验(Three.js、Angular、lodash-es 等)的框架或库时，然后当您以这种方式标记它们时(如果它们是无副作用的模块导出)，性能提升是显着的。

补充说明:

1. Obviously side-effects means something particular in fp and would include logging (console or elsewhere) and the throwing of errors. I'm assuming in this context these are perfectly acceptable?

如果这是试图解决的问题，是的。只要针对模块导出创建的效果不受其他会导致 trim Not Acceptable 影响。

2. Can a module contain circular references and still use sideEffects: false?

理论上应该如此。

3. Is there any way to verify or that a module is able to use sideEffects: false beyond trying to track down errors caused by its misuse?

据我所知，这将是一个很棒的工具。

4. Are there any other factors that would prevent a module from being able to use sideEffects: false?

如果该属性不在 package.json 中或在 module.rules 中定义，或者 mode: production 未设置(利用优化)。