Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
JoshuaKGoldberg opened this issue Feb 1, 2025 · 1 comment
Open
Labels
good first issue Issues for newcomers help wanted learn Issues/pr concerning the learn section

Comments

@JoshuaKGoldberg
Copy link
Contributor

JoshuaKGoldberg commented Feb 1, 2025

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
  4. Quick FAQs such as TLA being unsupported
  5. Links to learn more on the official Node.js website

Sibling issue to #7440, intentionally with as similar an issue body as possible.

@joyeecheung
Copy link
Member

joyeecheung commented Feb 1, 2025

Thanks for opening the issue! I think this is what part of the package-examples aim to solve (e.g. in the Making ESM require-able chapter, the goal is to have some actual working examples there living side by side with the document), though this is still a WIP and I have not gotten to filling in the skeletons already laid out in there. Feel free to take a look at https://github.com/nodejs/package-examples/blob/main/CONTRIBUTING.md if anyone is interested ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Issues for newcomers help wanted learn Issues/pr concerning the learn section
Projects
Status: 📋 Backlog
Development

No branches or pull requests

3 participants