[pull] latest from npm:latest #112
Merged
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
## Description This PR adds documentation for the `type` field in package.json, which controls whether Node.js treats .js files as ES modules or CommonJS modules. ## Changes - Added a new section documenting the `type` field - Explained the two possible values: `module` and `commonjs` - Provided examples for both module types - Added a note about .mjs and .cjs file extensions - Linked to Node.js official documentation ## Fixes Closes #8376 ## Context The `type` field is a crucial part of package.json for modern Node.js projects, especially with the widespread adoption of ES modules. As reported in issue #8376, this field was not documented in npm's package.json reference, which caused confusion for developers trying to understand how to configure their packages for ESM or CommonJS. This documentation clarifies: 1. How to enable ES modules in a package (`"type": "module"`) 2. How to explicitly use CommonJS (`"type": "commonjs"`) 3. The default behavior when `type` is omitted (CommonJS) 4. That file extensions (.mjs/.cjs) override the type field ## Type of Change - [x] Documentation update Co-authored-by: Max Black <husivm@google.com>
Owner
|
| Status | Scanner |  Critical |
 High |
 Medium |
 Low |
Total (0) |
|---|---|---|---|---|---|---|
| Open Source Security | 0 | 0 | 0 | 0 | See details |
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 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.
See Commits and Changes for more details.
Created by
pull[bot] (v2.0.0-alpha.4)
Can you help keep this open source service alive? 💖 Please sponsor : )