kamiyo / multi-progress-bars

A multi progress bar library for CLI, with support for indefinite task spinners
MIT License
27 stars 4 forks source link

Import as ES Module fails #18

Open DrMurx opened 2 years ago

DrMurx commented 2 years ago

Right now with version 4.2.0, importing multi-progress-bars into a project using ES modules fails like this:

file:///....../node_modules/multi-progress-bars/dist/multi-progress-bars.mjs:1
import { green } from 'chalk';
         ^^^^^
SyntaxError: Named export 'green' not found. The requested module 'chalk' is a CommonJS module, which may not support all module.exports as named exports.
CommonJS modules can always be imported via the default export, for example using:

import pkg from 'chalk';
const { green } = pkg;

It's caused by how the TypeScript transpiler optimize import statements if it compiles to an ES module, and how NodeJS treats CJS imports in said ES modules. The error message suggests a potential solution to the problem, but I'm not sure if the TypeScript transpiler could be configured to achieve these statements.

Related (yet not similar) issues are discussed here and here.

As a side note, the issue doesn't appear if dist/multi-progress-bars.cjs is imported instead. However, this workaround can't be used with the current multi-progress-bars release, as it defines an exports section in its package.json which masks direct access to the files in the dist/ folder. The workaround would require the exports to be modified.

kamiyo commented 2 years ago

Since I really don't know how all this importing stuff works (or I don't grok it at a low level), I can only go by following writeups I find online on how to dual publish commonjs and ESM. However, it appears I forgot a root ".": for my exports section... which maybe that will fix it? I also did the import pkg from 'chalk'; const { green } = pkg; bit suggested by node. You can test it out with prerelease version 4.2.2-0. Let me know if it happens to work.

DrMurx commented 2 years ago

Hey @kamiyo, thank you, this solved the issue. I confirm that 4.2.2-0 works properly in mjs environments.

kamiyo commented 2 years ago

Awesome. I'll make an actual release tonight that isn't a prerelease.