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.

Sign up for GitHub

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

Jump to bottom

docs: document package.json's "exports" field #7323

Open
wants to merge 5 commits into
base: latest
Choose a base branch
from
Open

docs: document package.json's "exports" field #7323

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e17d3c1
docs: document `package.json`'s `"exports"` field
samualtnorman Mar 29, 2024
7a38e9f
docs: document `package.json`'s `"exports"` fields' conditional exports
samualtnorman Mar 30, 2024
7cb514a
docs: make comment about `package.json` `"exports"` field support mor…
samualtnorman Mar 30, 2024
5be8cc1
docs: add examples for `package.json` `"exports"` field fallbacks
samualtnorman Mar 30, 2024
d3acde9
docs: add link to official Node.js docs on `package.json` `"exports"`…
samualtnorman Mar 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/lib/content/configuring-npm/package-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,27 @@ not much else.

If `main` is not set, it defaults to `index.js` in the package's root folder.

### exports

The exports field is an object that maps entry points to modules. It supports wild cards (`*`) and explicit names.

For example, you could have:

```json
{
"exports": {
".": "./index.js",
"./*": "./*.js",
"./*.js": "./*.js",
"./foo": "./path/to/foo.js"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ideally an example would include "./package.json", so tools can access the package.json file, and would also show multiple examples including conditions, arrays, etc.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you for the feedback, I've now documented conditional exports.
I have also documented fallbacks although I have not yet added examples for fallbacks.
is the thing about conditional exports satisfactory (like the video game)?

}
}
```

If someone installed your package with this in your `package.json`, they could `require("my-package")` and it would be mapped to `./node_modules/my-package/index.js` because of `".": "./index.js"`.<br>
If they did `require("my-package/bar")` or `require("my-package/bar.js")`, it would be mapped to `./node_modules/my-package/bar.js` because of the wild cards (`*`).<br>
If they did `require("my-package/foo")` it would be mapped to `./node_modules/my-package/path/to/foo.js` because of the explicit mapping `"./foo": "./path/to/foo.js"`.<br>

### browser

If your module is meant to be used client-side the browser field should be
Expand Down