nodejs/modules

Feature: Dual-goal packages

GeoffreyBooth opened this issue · 4 comments

GeoffreyBooth commented
  • I want to publish a package that can be imported as native ESM or required as CommonJS.
  • I don’t want to need to transpile or have a build step in order to create such a package.
  • I want to be able to use either ESM or CommonJS within my package.
  • I want to be able to gradually convert my package from CommonJS to ESM.

Use cases 2, 10, 39, 41.

GeoffreyBooth commented

I had a idea about how to achieve this, for the use case where my package is already fully migrated into ESM syntax. So the easy way, that doesn’t fulfill all the goals of the feature request, would be to have my app include a build step that transpiles it into CommonJS. The CommonJS version is what I publish to NPM and have package.json tell other packages to import. That’s what people do today.

So how to achieve this without a build step? Well, what if we borrow some ideas from #81 and #101 and nodejs/node#18392 and https://github.com/rollup/rollup/wiki/pkg.module?

  • My package’s package.json would have a main key that points to a CommonJS entry point, and a module key that points to an ESM entry point (or other key names to be decided upon).
  • The main CommonJS entry point would have something like require('babel/register') and then would require the ESM entry point. This would allow my package to be imported by legacy versions of Node that lack ESM support, without the code being transpiled ahead of time.
  • The module ESM entry point would be used by modern, ESM-supporting Node, and would bypass the main entry point (which is essentially just an ESM polyfill).

The polyfill in the CommonJS entry point doesn’t need to be Babel, and it doesn’t (necessarily) need to transpile, if other solutions can be found. But let’s say that at least the above approach works. The downside of this is that for non-ESM-supporting runtimes, whatever the polyfill is (transpilation, etc.), it’ll surely be slower than if we had transpiled the package ahead of time and published it as native CommonJS. That’s the disadvantage of polyfills in general. But as ESM support becomes more common, this performance hit for legacy runtimes will become less important.

devsnek commented

you can just do main: 'src/index' and it will pick up src/index.mjs for esm and src/index.js for cjs

  • 👍1
GeoffreyBooth commented

I would prefer to have two keys and drop .mjs.

ljharb commented

@GeoffreyBooth two keys doesn’t address deep paths; mjs will be necessary for ensuring that all files can be consumed by all consumers.

  • 👍2