javascript - 发布 npm 包时，我应该使用 dist 的 src

Question

当将一些 javascript 作为库发布到 npm 时，我应该将 pacakge.json 中的“main”设置为“dist/index.js”还是我的“src/index.js”？

假设该库是用webpack构建的，并且可以与webpack中的项目一起使用。

两个选项之间的区别是什么。 webpack 是否能够在这两个选项中进行 tree shaking？

谢谢!

Answer 1

如果您的库是为在浏览器中使用而设计的，那么请务必记住并不是每个人都在使用模块 bundler 。

最好将 main 属性设置为捆绑文件(在您的情况下为 dist/index.js)并确保您有一个 prepublish 在发布之前执行构建步骤的脚本。

为了支持像 Rollup 这样的打包器进行 tree-shaking，you can use the module property并确保它指向使用 ES2015 导入的模块。

例如:

{
  "main": "dist/index.js",
  "module": "src/index.js"
}

Rollup 会尊重这一点，但让 Webpack 对您的代码进行 tree-shaking 是一个 little more involved .