| <!DOCTYPE html><html><head> |
| <meta charset="utf-8"> |
| <title>npm-explain</title> |
| <style> |
| body { |
| background-color: #ffffff; |
| color: #24292e; |
| |
| margin: 0; |
| |
| line-height: 1.5; |
| |
| font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; |
| } |
| #rainbar { |
| height: 10px; |
| background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff); |
| } |
| |
| a { |
| text-decoration: none; |
| color: #0366d6; |
| } |
| a:hover { |
| text-decoration: underline; |
| } |
| |
| pre { |
| margin: 1em 0px; |
| padding: 1em; |
| border: solid 1px #e1e4e8; |
| border-radius: 6px; |
| |
| display: block; |
| overflow: auto; |
| |
| white-space: pre; |
| |
| background-color: #f6f8fa; |
| color: #393a34; |
| } |
| code { |
| font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace; |
| font-size: 85%; |
| padding: 0.2em 0.4em; |
| background-color: #f6f8fa; |
| color: #393a34; |
| } |
| pre > code { |
| padding: 0; |
| background-color: inherit; |
| color: inherit; |
| } |
| h1, h2, h3 { |
| font-weight: 600; |
| } |
| |
| #logobar { |
| background-color: #333333; |
| margin: 0 auto; |
| padding: 1em 4em; |
| } |
| #logobar .logo { |
| float: left; |
| } |
| #logobar .title { |
| font-weight: 600; |
| color: #dddddd; |
| float: left; |
| margin: 5px 0 0 1em; |
| } |
| #logobar:after { |
| content: ""; |
| display: block; |
| clear: both; |
| } |
| |
| #content { |
| margin: 0 auto; |
| padding: 0 4em; |
| } |
| |
| #table_of_contents > h2 { |
| font-size: 1.17em; |
| } |
| #table_of_contents ul:first-child { |
| border: solid 1px #e1e4e8; |
| border-radius: 6px; |
| padding: 1em; |
| background-color: #f6f8fa; |
| color: #393a34; |
| } |
| #table_of_contents ul { |
| list-style-type: none; |
| padding-left: 1.5em; |
| } |
| #table_of_contents li { |
| font-size: 0.9em; |
| } |
| #table_of_contents li a { |
| color: #000000; |
| } |
| |
| header.title { |
| border-bottom: solid 1px #e1e4e8; |
| } |
| header.title > h1 { |
| margin-bottom: 0.25em; |
| } |
| header.title > .description { |
| display: block; |
| margin-bottom: 0.5em; |
| line-height: 1; |
| } |
| |
| footer#edit { |
| border-top: solid 1px #e1e4e8; |
| margin: 3em 0 4em 0; |
| padding-top: 2em; |
| } |
| </style> |
| </head> |
| <body> |
| <div id="banner"> |
| <div id="rainbar"></div> |
| <div id="logobar"> |
| <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700"> |
| <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> |
| <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> |
| </svg> |
| <div class="title"> |
| npm command-line interface |
| </div> |
| </div> |
| </div> |
|
|
| <section id="content"> |
| <header class="title"> |
| <h1 id="npm-explain">npm-explain</h1> |
| <span class="description">Explain installed packages</span> |
| </header> |
|
|
| <section id="table_of_contents"> |
| <h2 id="table-of-contents">Table of contents</h2> |
| <div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#json"><code>json</code></a></li><li><a href="#workspace"><code>workspace</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div> |
| </section> |
|
|
| <div id="_content"><h3 id="synopsis">Synopsis</h3> |
| <pre><code class="language-bash">npm explain <package-spec> |
|
|
| alias: why |
| </code></pre> |
| <h3 id="description">Description</h3> |
| <p>This command will print the chain of dependencies causing a given package |
| to be installed in the current project.</p> |
| <p>If one or more package specs are provided, then only packages matching |
| one of the specifiers will have their relationships explained.</p> |
| <p>The package spec can also refer to a folder within <code>./node_modules</code></p> |
| <p>For example, running <code>npm explain glob</code> within npm's source tree will show:</p> |
| <pre><code class="language-bash">glob@7.1.6 |
| node_modules/glob |
| glob@"^7.1.4" from the root project |
|
|
| glob@7.1.1 dev |
| node_modules/tacks/node_modules/glob |
| glob@"^7.0.5" from rimraf@2.6.2 |
| node_modules/tacks/node_modules/rimraf |
| rimraf@"^2.6.2" from tacks@1.3.0 |
| node_modules/tacks |
| dev tacks@"^1.3.0" from the root project |
| </code></pre> |
| <p>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.</p> |
| <pre><code class="language-bash">$ npm explain node_modules/nyc/node_modules/find-up |
| find-up@3.0.0 dev |
| node_modules/nyc/node_modules/find-up |
| find-up@"^3.0.0" from nyc@14.1.1 |
| node_modules/nyc |
| nyc@"^14.1.1" from tap@14.10.8 |
| node_modules/tap |
| dev tap@"^14.10.8" from the root project |
| </code></pre> |
| <h3 id="configuration">Configuration</h3> |
| <h4 id="json"><code>json</code></h4> |
| <ul> |
| <li>Default: false</li> |
| <li>Type: Boolean</li> |
| </ul> |
| <p>Whether or not to output JSON data, rather than the normal output.</p> |
| <ul> |
| <li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before |
| saving them to your <code>package.json</code>.</li> |
| </ul> |
| <p>Not supported by all npm commands.</p> |
| <h4 id="workspace"><code>workspace</code></h4> |
| <ul> |
| <li>Default:</li> |
| <li>Type: String (can be set multiple times)</li> |
| </ul> |
| <p>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.</p> |
| <p>Valid values for the <code>workspace</code> config are either:</p> |
| <ul> |
| <li>Workspace names</li> |
| <li>Path to a workspace directory</li> |
| <li>Path to a parent workspace directory (will result in selecting all |
| workspaces within that folder)</li> |
| </ul> |
| <p>When set for the <code>npm init</code> 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.</p> |
| <p>This value is not exported to the environment for child processes.</p> |
| <h3 id="see-also">See Also</h3> |
| <ul> |
| <li><a href="../using-npm/package-spec.html">package spec</a></li> |
| <li><a href="../commands/npm-config.html">npm config</a></li> |
| <li><a href="../configuring-npm/npmrc.html">npmrc</a></li> |
| <li><a href="../configuring-npm/folders.html">npm folders</a></li> |
| <li><a href="../commands/npm-ls.html">npm ls</a></li> |
| <li><a href="../commands/npm-install.html">npm install</a></li> |
| <li><a href="../commands/npm-link.html">npm link</a></li> |
| <li><a href="../commands/npm-prune.html">npm prune</a></li> |
| <li><a href="../commands/npm-outdated.html">npm outdated</a></li> |
| <li><a href="../commands/npm-update.html">npm update</a></li> |
| </ul></div> |
|
|
| <footer id="edit"> |
| <a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-explain.md"> |
| <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> |
| <path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path> |
| </svg> |
| Edit this page on GitHub |
| </a> |
| </footer> |
| </section> |
|
|
|
|
|
|
| </body></html> |
