nodejs / nodejs/learn

Create an explainer / hub page for unflagged require(ESM) support

Open
#35 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
JavaScript
Stars
29
Forks
165
Avg merge
1d 18h
Merged PRs (30d)
2

Description

Enter your suggestions in details:

The new unflagged require(ESM) support in Node.js is very exciting. It's starting to let a lot of tools move to ESM without feat of leaving dependents behind. 🚀

But, there isn't one single high-level, official resource I can find that users can be pointed to to understand the unflagged support.

Proposal: can the Node.js site have a page added dedicated to the unflagged require(ESM) support? I'd imagine it could contain:

  1. What "require(ESM)" is
  2. Quick examples of requiring an ES module from a CJS file
  3. What versions of Node.js have it
    • Edit: ^20.19.0 || >=22.12.0 seems to be the common support target post-18.x
  4. Quick FAQs such as TLA being unsupported
  5. Links to learn more on the official Node.js website

Sibling issue to nodejs/learn#34, intentionally with as similar an issue body as possible.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Node.js modules documentation, especially the “Loading ECMAScript modules using require” section, and compare it with the proposed high-level scope. Done means adding an official explainer or hub page covering what require(ESM) is, quick CommonJS examples, supported Node.js versions, FAQs such as TLA limitations, and links to related official resources.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.