Skip to content

Commit

Permalink
docs: clarify what peerDependenciesMeta does (#7433)
Browse files Browse the repository at this point in the history
Co-authored-by: Gar <wraithgar@github.com>
  • Loading branch information
xuhdev and wraithgar committed May 1, 2024
1 parent 796971e commit f6fff32
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions docs/lib/content/configuring-npm/package-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -818,11 +818,12 @@ to express this. If you depend on features introduced in 1.5.2, use

### peerDependenciesMeta

When a user installs your package, npm will emit warnings if packages
specified in `peerDependencies` are not already installed. The
`peerDependenciesMeta` field serves to provide npm more information on how
The `peerDependenciesMeta` field serves to provide npm more information on how
your peer dependencies are to be used. Specifically, it allows peer
dependencies to be marked as optional.
dependencies to be marked as optional. Npm will not automatically install
optional peer dependencies. This allows you to
integrate and interact with a variety of host packages without requiring
all of them to be installed.

For example:

Expand All @@ -842,11 +843,6 @@ For example:
}
```

Marking a peer dependency as optional ensures npm will not emit a warning
if the `soy-milk` package is not installed on the host. This allows you to
integrate and interact with a variety of host packages without requiring
all of them to be installed.

### bundleDependencies

This defines an array of package names that will be bundled when publishing
Expand Down

0 comments on commit f6fff32

Please sign in to comment.