codekingpro/portable-devtools

1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-explain</title>
4<style>
5body {
6    background-color: #ffffff;
7    color: #24292e;
8
9    margin: 0;
10
11    line-height: 1.5;
12
13    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16    height: 10px;
17    background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21    text-decoration: none;
22    color: #0366d6;
23}
24a:hover {
25    text-decoration: underline;
26}
27
28pre {
29    margin: 1em 0px;
30    padding: 1em;
31    border: solid 1px #e1e4e8;
32    border-radius: 6px;
33
34    display: block;
35    overflow: auto;
36
37    white-space: pre;
38
39    background-color: #f6f8fa;
40    color: #393a34;
41}
42code {
43    font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44    font-size: 85%;
45    padding: 0.2em 0.4em;
46    background-color: #f6f8fa;
47    color: #393a34;
48}
49pre > code {
50    padding: 0;
51    background-color: inherit;
52    color: inherit;
53}
54h1, h2, h3 {
55    font-weight: 600;
56}
57
58#logobar {
59    background-color: #333333;
60    margin: 0 auto;
61    padding: 1em 4em;
62}
63#logobar .logo {
64    float: left;
65}
66#logobar .title {
67    font-weight: 600;
68    color: #dddddd;
69    float: left;
70    margin: 5px 0 0 1em;
71}
72#logobar:after {
73    content: "";
74    display: block;
75    clear: both;
76}
77
78#content {
79    margin: 0 auto;
80    padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84    font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87    border: solid 1px #e1e4e8;
88    border-radius: 6px;
89    padding: 1em;
90    background-color: #f6f8fa;
91    color: #393a34;
92}
93#table_of_contents ul {
94    list-style-type: none;
95    padding-left: 1.5em;
96}
97#table_of_contents li {
98    font-size: 0.9em;
99}
100#table_of_contents li a {
101    color: #000000;
102}
103
104header.title {
105    border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108    margin-bottom: 0.25em;
109}
110header.title > .description {
111    display: block;
112    margin-bottom: 0.5em;
113    line-height: 1;
114}
115
116header.title .version {
117    font-size: 0.8em;
118    color: #666666;
119}
120
121footer#edit {
122    border-top: solid 1px #e1e4e8;
123    margin: 3em 0 4em 0;
124    padding-top: 2em;
125}
126
127table {
128    width: 100%;
129    margin: 1em 0;
130    border-radius: 6px;
131    border: 1px solid #e1e4e8;
132    overflow: hidden;
133    border-collapse: separate;
134    border-spacing: 0;
135}
136
137table thead {
138    background-color: #f6f8fa;
139}
140
141table tbody {
142    background-color: #ffffff;
143}
144
145table th,
146table td {
147    padding: 0.75em;
148    text-align: left;
149    border-right: 1px solid #e1e4e8;
150    border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155    border-right: none;
156}
157
158table tbody tr:last-child td {
159    border-bottom: none;
160}
161
162table th {
163    font-weight: 600;
164    background-color: #f6f8fa;
165}
166
167table code {
168    white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----npm-explain----11130">
190    <span>npm-explain</span>
191    <span class="version">@11.13.0</span>
192</h1>
193<span class="description">Explain installed packages</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<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>
199</section>
200
201<div id="_content"><h3 id="synopsis">Synopsis</h3>
202<pre><code class="language-bash">npm explain &lt;package-spec&gt;
203
204alias: why
205</code></pre>
206<h3 id="description">Description</h3>
207<p>This command will print the chain of dependencies causing a given package to be installed in the current project.</p>
208<p>If one or more package specs are provided, then only packages matching one of the specifiers will have their relationships explained.</p>
209<p>The package spec can also refer to a folder within <code>./node_modules</code></p>
210<p>For example, running <code>npm explain glob</code> within npm's source tree will show:</p>
211<pre><code class="language-bash">glob@7.1.6
212node_modules/glob
213  glob@"^7.1.4" from the root project
214
215glob@7.1.1 dev
216node_modules/tacks/node_modules/glob
217  glob@"^7.0.5" from rimraf@2.6.2
218  node_modules/tacks/node_modules/rimraf
219    rimraf@"^2.6.2" from tacks@1.3.0
220    node_modules/tacks
221      dev tacks@"^1.3.0" from the root project
222</code></pre>
223<p>To explain just the package residing at a specific folder, pass that as the argument to the command.
224This 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>
225<pre><code class="language-bash">$ npm explain node_modules/nyc/node_modules/find-up
226find-up@3.0.0 dev
227node_modules/nyc/node_modules/find-up
228  find-up@"^3.0.0" from nyc@14.1.1
229  node_modules/nyc
230    nyc@"^14.1.1" from tap@14.10.8
231    node_modules/tap
232      dev tap@"^14.10.8" from the root project
233</code></pre>
234<h3 id="configuration">Configuration</h3>
235<h4 id="json"><code>json</code></h4>
236<ul>
237<li>Default: false</li>
238<li>Type: Boolean</li>
239</ul>
240<p>Whether or not to output JSON data, rather than the normal output.</p>
241<ul>
242<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
243saving them to your <code>package.json</code>.</li>
244</ul>
245<p>Not supported by all npm commands.</p>
246<h4 id="workspace"><code>workspace</code></h4>
247<ul>
248<li>Default:</li>
249<li>Type: String (can be set multiple times)</li>
250</ul>
251<p>Enable running a command in the context of the configured workspaces of the
252current project while filtering by running only the workspaces defined by
253this configuration option.</p>
254<p>Valid values for the <code>workspace</code> config are either:</p>
255<ul>
256<li>Workspace names</li>
257<li>Path to a workspace directory</li>
258<li>Path to a parent workspace directory (will result in selecting all
259workspaces within that folder)</li>
260</ul>
261<p>When set for the <code>npm init</code> command, this may be set to the folder of a
262workspace which does not yet exist, to create the folder and set it up as a
263brand new workspace within the project.</p>
264<p>This value is not exported to the environment for child processes.</p>
265<h3 id="see-also">See Also</h3>
266<ul>
267<li><a href="../using-npm/package-spec.html">package spec</a></li>
268<li><a href="../commands/npm-config.html">npm config</a></li>
269<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
270<li><a href="../configuring-npm/folders.html">npm folders</a></li>
271<li><a href="../commands/npm-ls.html">npm ls</a></li>
272<li><a href="../commands/npm-install.html">npm install</a></li>
273<li><a href="../commands/npm-link.html">npm link</a></li>
274<li><a href="../commands/npm-prune.html">npm prune</a></li>
275<li><a href="../commands/npm-outdated.html">npm outdated</a></li>
276<li><a href="../commands/npm-update.html">npm update</a></li>
277</ul></div>
278
279<footer id="edit">
280<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-explain.md">
281<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
282<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>
283</svg>
284Edit this page on GitHub
285</a>
286</footer>
287</section>
288
289
290
291</body></html>