docs: added type field in the documentation of package.json #1653
+33
−0
Conversation
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
ljharb
reviewed
Jul 1, 2025
| @@ -305,6 +305,39 @@ These can not be included. | |||
|
|
|||
| The "exports" provides a modern alternative to "main" allowing multiple entry points to be defined, conditional entry resolution support between environments, and preventing any other entry points besides those defined in "exports". This encapsulation allows module authors to clearly define the public interface for their package. For more details see the [node.js documentation on package entry points](https://nodejs.org/api/packages.html#package-entry-points) | |||
|
|
|||
| ### type | |||
|
|
|||
| The `type` field defines the module format that Node.js should use for `.js` files in the package. When set to `"module"`, Node.js will treat `.js` files as ES modules. When set to `"commonjs"` (or when the field is omitted), Node.js will treat `.js` files as CommonJS modules. | |||
There was a problem hiding this comment.
i think rather than all of this content, it should be nothing more than a link to https://nodejs.org/api/packages.html#type, so that there's not two sources of truth to keep up to date.
There was a problem hiding this comment.
This is generally the position we have also taken in other places in the docs. "nothing more" is a little extreme, some helpful copy explaining that the source of truth is found elsewhere would be appropriate.
There was a problem hiding this comment.
oh sure, that works fine :-) just, nothing technical, ie that would need to be updated in the future.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add documentation for package.json
typefieldWhat / Why
This PR adds comprehensive documentation for the
typefield in package.json, which was previously undocumented in the npm CLI documentation. Thetypefield is an important Node.js feature that determines how.jsfiles are interpreted (as ES modules or CommonJS modules) and was missing from the official npm package.json documentation.Changes made:
typefield between theexportsandmainsections"module"and"commonjs"values.js,.mjs,.cjs)This addition helps developers understand how to properly configure their packages for ES modules or CommonJS, which is crucial for modern Node.js development.
References
Fixes npm/cli#[8376] - Documents the missing
typefield in package.json