codekingpro/portable-devtools
114k
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-prune</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-prune----11130">
190 <span>npm-prune</span>
191 <span class="version">@11.13.0</span>
192</h1>
193<span class="description">Remove extraneous 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="#omit"><code>omit</code></a></li><li><a href="#include"><code>include</code></a></li><li><a href="#dry-run"><code>dry-run</code></a></li><li><a href="#json"><code>json</code></a></li><li><a href="#foreground-scripts"><code>foreground-scripts</code></a></li><li><a href="#ignore-scripts"><code>ignore-scripts</code></a></li><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li><li><a href="#include-workspace-root"><code>include-workspace-root</code></a></li><li><a href="#install-links"><code>install-links</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 prune [[<@scope>/]<pkg>...]
203</code></pre>
204<h3 id="description">Description</h3>
205<p>This command removes "extraneous" packages.
206If a package name is provided, then only packages matching one of the supplied names are removed.</p>
207<p>Extraneous packages are those present in the <code>node_modules</code> folder that are not listed as any package's dependency list.</p>
208<p>If the <code>--omit=dev</code> flag is specified or the <code>NODE_ENV</code> environment variable is set to <code>production</code>, this command will remove the packages specified in your <code>devDependencies</code>.</p>
209<p>If the <code>--dry-run</code> flag is used then no changes will actually be made.</p>
210<p>If the <code>--json</code> flag is used, then the changes <code>npm prune</code> made (or would have made with <code>--dry-run</code>) are printed as a JSON object.</p>
211<p>In normal operation, extraneous modules are pruned automatically, so you'll only need this command with the <code>--production</code> flag.
212However, in the real world, operation is not always "normal". When crashes or mistakes happen, this command can help clean up any resulting garbage.</p>
213<h3 id="configuration">Configuration</h3>
214<h4 id="omit"><code>omit</code></h4>
215<ul>
216<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
217'production'; otherwise, empty.</li>
218<li>Type: "dev", "optional", or "peer" (can be set multiple times)</li>
219</ul>
220<p>Dependency types to omit from the installation tree on disk.</p>
221<p>Note that these dependencies <em>are</em> still resolved and added to the
222<code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not
223physically installed on disk.</p>
224<p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then
225it will be included.</p>
226<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
227variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
228<h4 id="include"><code>include</code></h4>
229<ul>
230<li>Default:</li>
231<li>Type: "prod", "dev", "optional", or "peer" (can be set multiple times)</li>
232</ul>
233<p>Option that allows for defining which types of dependencies to install.</p>
234<p>This is the inverse of <code>--omit=<type></code>.</p>
235<p>Dependency types specified in <code>--include</code> will not be omitted, regardless of
236the order in which omit/include are specified on the command-line.</p>
237<h4 id="dry-run"><code>dry-run</code></h4>
238<ul>
239<li>Default: false</li>
240<li>Type: Boolean</li>
241</ul>
242<p>Indicates that you don't want npm to make any changes and that it should
243only report what it would have done. This can be passed into any of the
244commands that modify your local installation, eg, <code>install</code>, <code>update</code>,
245<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
246<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
247<code>owner</code>, etc.</p>
248<h4 id="json"><code>json</code></h4>
249<ul>
250<li>Default: false</li>
251<li>Type: Boolean</li>
252</ul>
253<p>Whether or not to output JSON data, rather than the normal output.</p>
254<ul>
255<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
256saving them to your <code>package.json</code>.</li>
257</ul>
258<p>Not supported by all npm commands.</p>
259<h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
260<ul>
261<li>Default: <code>false</code> unless when using <code>npm pack</code> or <code>npm publish</code> where it
262defaults to <code>true</code></li>
263<li>Type: Boolean</li>
264</ul>
265<p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>)
266scripts for installed packages in the foreground process, sharing standard
267input, output, and error with the main npm process.</p>
268<p>Note that this will generally make installs run slower, and be much noisier,
269but can be useful for debugging.</p>
270<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
271<ul>
272<li>Default: false</li>
273<li>Type: Boolean</li>
274</ul>
275<p>If true, npm does not run scripts specified in package.json files.</p>
276<p>Note that commands explicitly intended to run a particular script, such as
277<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run</code> will still
278run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em>
279run any pre- or post-scripts.</p>
280<h4 id="workspace"><code>workspace</code></h4>
281<ul>
282<li>Default:</li>
283<li>Type: String (can be set multiple times)</li>
284</ul>
285<p>Enable running a command in the context of the configured workspaces of the
286current project while filtering by running only the workspaces defined by
287this configuration option.</p>
288<p>Valid values for the <code>workspace</code> config are either:</p>
289<ul>
290<li>Workspace names</li>
291<li>Path to a workspace directory</li>
292<li>Path to a parent workspace directory (will result in selecting all
293workspaces within that folder)</li>
294</ul>
295<p>When set for the <code>npm init</code> command, this may be set to the folder of a
296workspace which does not yet exist, to create the folder and set it up as a
297brand new workspace within the project.</p>
298<p>This value is not exported to the environment for child processes.</p>
299<h4 id="workspaces"><code>workspaces</code></h4>
300<ul>
301<li>Default: null</li>
302<li>Type: null or Boolean</li>
303</ul>
304<p>Set to true to run the command in the context of <strong>all</strong> configured
305workspaces.</p>
306<p>Explicitly setting this to false will cause commands like <code>install</code> to
307ignore workspaces altogether. When not set explicitly:</p>
308<ul>
309<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
310will link workspaces into the <code>node_modules</code> folder. - Commands that do
311other things (test, exec, publish, etc.) will operate on the root project,
312<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
313</ul>
314<p>This value is not exported to the environment for child processes.</p>
315<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
316<ul>
317<li>Default: false</li>
318<li>Type: Boolean</li>
319</ul>
320<p>Include the workspace root when workspaces are enabled for a command.</p>
321<p>When false, specifying individual workspaces via the <code>workspace</code> config, or
322all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
323the specified workspaces, and not on the root project.</p>
324<p>This value is not exported to the environment for child processes.</p>
325<h4 id="install-links"><code>install-links</code></h4>
326<ul>
327<li>Default: false</li>
328<li>Type: Boolean</li>
329</ul>
330<p>When set file: protocol dependencies will be packed and installed as regular
331dependencies instead of creating a symlink. This option has no effect on
332workspaces.</p>
333<h3 id="see-also">See Also</h3>
334<ul>
335<li><a href="../commands/npm-uninstall.html">npm uninstall</a></li>
336<li><a href="../configuring-npm/folders.html">npm folders</a></li>
337<li><a href="../commands/npm-ls.html">npm ls</a></li>
338</ul></div>
339
340<footer id="edit">
341<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-prune.md">
342<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
343<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>
344</svg>
345Edit this page on GitHub
346</a>
347</footer>
348</section>
349
350
351
352</body></html>