W3cubDocs

/npm

npm-explain

Explain installed packages

Synopsis

npm explain <folder | specifier>

alias: why

Description

This command will print the chain of dependencies causing a given package to be installed in the current project.

Positional arguments can be either folders within node_modules, or [email protected] specifiers, which will select the dependency relationships to explain.

For example, running npm explain glob within npm's source tree will show:

[email protected]
node_modules/glob
  [email protected]"^7.1.4" from the root project

[email protected] dev
node_modules/tacks/node_modules/glob
  [email protected]"^7.0.5" from [email protected]
  node_modules/tacks/node_modules/rimraf
    [email protected]"^2.6.2" from [email protected]
    node_modules/tacks
      dev [email protected]"^1.3.0" from the root project

To explain just the package residing at a specific folder, pass that as the argument to the command. This can be useful when trying to figure out exactly why a given dependency is being duplicated to satisfy conflicting version requirements within the project.

$ npm explain node_modules/nyc/node_modules/find-up
[email protected] dev
node_modules/nyc/node_modules/find-up
  [email protected]"^3.0.0" from [email protected]
  node_modules/nyc
    [email protected]"^14.1.1" from [email protected]
    node_modules/tap
      dev [email protected]"^14.10.8" from the root project

Configuration

json

  • Default: false
  • Type: Boolean

Whether or not to output JSON data, rather than the normal output.

  • In npm pkg set it enables parsing set values with JSON.parse() before saving them to your package.json.

Not supported by all npm commands.

workspace

  • Default:
  • Type: String (can be set multiple times)

Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.

Valid values for the workspace config are either:

  • Workspace names
  • Path to a workspace directory
  • Path to a parent workspace directory (will result in selecting all workspaces within that folder)

When set for the npm init command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.

This value is not exported to the environment for child processes.

See Also

© npm, Inc. and Contributors
Licensed under the npm License.
npm is a trademark of npm, Inc.
https://docs.npmjs.com/cli/v8/commands/npm-explain