caolan/async

async package should distribute both cjs and esm

Open

#1879 opened on Nov 15, 2022

View on GitHub
 (1 comment) (7 reactions) (0 assignees)JavaScript (28,067 stars) (2,398 forks)batch import
help wanted

Description

There is no real need for async-es package. It ends up complicating async usage downstream especially for projects which emit both cjs and esm. And to complicate things, async-es has a main entry which points to esm (without indicating type: 'module'), so it can't be used for cjs scenarios.

Recommended:

Update the async package.json with:

  1. main pointing to commonjs. (this is only for backwards compatibility.)
  2. module pointing to esm. (this is only for backwards compatibility.)
  3. exports map explicitly listing the valid imports and the cjs/esm/d.ts files to resolve to.

Contributor guide

Tech stack
javascript
Domain
backendfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.js package.jsonCommonJS and ES modules
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Update the async package's package.json to include a 'main' field pointing to the CommonJS entry, a 'module' field for the ESM entry, and an 'exports' map to define entry points for both CJS and ESM. Ensure backwards compatibility. The existing async package has separate 'async' and 'async es' packages; the goal is to consolidate them.