doc: improve dual package hazard section with node/default pattern#60880
Open
ajeeth-asperand wants to merge 1 commit intonodejs:mainnodejs/node:mainfrom
ajeeth-asperand:docs-dual-package-hazardajeeth-asperand/node:docs-dual-package-hazardCopy head branch name to clipboard
Open
doc: improve dual package hazard section with node/default pattern#60880ajeeth-asperand wants to merge 1 commit intonodejs:mainnodejs/node:mainfrom ajeeth-asperand:docs-dual-package-hazardajeeth-asperand/node:docs-dual-package-hazardCopy head branch name to clipboard
ajeeth-asperand wants to merge 1 commit intonodejs:mainnodejs/node:mainfrom
ajeeth-asperand:docs-dual-package-hazardajeeth-asperand/node:docs-dual-package-hazardCopy head branch name to clipboard
Conversation
Collaborator
|
Review requested:
|
|
Where is |
Member
|
Thank you, but we already have that covered; it was formerly in the API docs but was moved to a Learn article: https://nodejs.org/en/learn/modules/publishing-a-package |
|
Also we should note that more and more packages in the wild have become ESM-only recently and all Node versions without support for module-sync (older than 20) are EOL today. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: #52174
What
Expands the "Dual CommonJS/ES module packages" section in
doc/api/packages.mdto describe the dual package hazard and recommend using
"node"/"default"conditions for dual packages, with a small
package.jsonexample.Why
The existing section only linked to the package examples repository without
describing the recommended pattern. Using
"node"/"default"conditionshelps avoid the dual package hazard in Node.js while still allowing other
environments (such as bundlers) to consume an ES module build.
How
"node"/"default"export conditions pattern.package.jsonsnippet.Testing
python tools/test.py doctool