codekingpro/portable-devtools
114k
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-dedupe</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-dedupe----11121">
190 <span>npm-dedupe</span>
191 <span class="version">@11.12.1</span>
192</h1>
193<span class="description">Reduce duplication in the package tree</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="#install-strategy"><code>install-strategy</code></a></li><li><a href="#legacy-bundling"><code>legacy-bundling</code></a></li><li><a href="#global-style"><code>global-style</code></a></li><li><a href="#strict-peer-deps"><code>strict-peer-deps</code></a></li><li><a href="#package-lock"><code>package-lock</code></a></li><li><a href="#omit"><code>omit</code></a></li><li><a href="#include"><code>include</code></a></li><li><a href="#ignore-scripts"><code>ignore-scripts</code></a></li><li><a href="#allow-git"><code>allow-git</code></a></li><li><a href="#audit"><code>audit</code></a></li><li><a href="#bin-links"><code>bin-links</code></a></li><li><a href="#fund"><code>fund</code></a></li><li><a href="#dry-run"><code>dry-run</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 dedupe
203
204alias: ddp
205</code></pre>
206<h3 id="description">Description</h3>
207<p>Searches the local package tree and attempts to simplify the overall structure by moving dependencies further up the tree, where they can be more effectively shared by multiple dependent packages.</p>
208<p>For example, consider this dependency graph:</p>
209<pre><code>a
210+-- b <-- depends on c@1.0.x
211| `-- c@1.0.3
212`-- d <-- depends on c@~1.0.9
213 `-- c@1.0.10
214</code></pre>
215<p>In this case, <code>npm dedupe</code> will transform the tree to:</p>
216<pre><code class="language-bash">a
217+-- b
218+-- d
219`-- c@1.0.10
220</code></pre>
221<p>Because of the hierarchical nature of node's module lookup, b and d will both get their dependency met by the single c package at the root level of the tree.</p>
222<p>In some cases, you may have a dependency graph like this:</p>
223<pre><code>a
224+-- b <-- depends on c@1.0.x
225+-- c@1.0.3
226`-- d <-- depends on c@1.x
227 `-- c@1.9.9
228</code></pre>
229<p>During the installation process, the <code>c@1.0.3</code> dependency for <code>b</code> was placed in the root of the tree.
230Though <code>d</code>'s dependency on <code>c@1.x</code> could have been satisfied by <code>c@1.0.3</code>, the newer <code>c@1.9.9</code> dependency was used, because npm favors updates by default, even when doing so causes duplication.</p>
231<p>Running <code>npm dedupe</code> will cause npm to note the duplication and re-evaluate, deleting the nested <code>c</code> module, because the one in the root is sufficient.</p>
232<p>To prefer deduplication over novelty during the installation process, run <code>npm install --prefer-dedupe</code> or <code>npm config set prefer-dedupe true</code>.</p>
233<p>Arguments are ignored.
234Dedupe always acts on the entire tree.</p>
235<p>Note that this operation transforms the dependency tree, but will never result in new modules being installed.</p>
236<p>Using <code>npm find-dupes</code> will run the command in <code>--dry-run</code> mode.</p>
237<p>Note: <code>npm dedupe</code> will never update the semver values of direct dependencies in your project <code>package.json</code>, if you want to update values in <code>package.json</code> you can run: <code>npm update --save</code> instead.</p>
238<h3 id="configuration">Configuration</h3>
239<h4 id="install-strategy"><code>install-strategy</code></h4>
240<ul>
241<li>Default: "hoisted"</li>
242<li>Type: "hoisted", "nested", "shallow", or "linked"</li>
243</ul>
244<p>Sets the strategy for installing packages in node_modules. hoisted
245(default): Install non-duplicated in top-level, and duplicated as necessary
246within directory structure. nested: (formerly --legacy-bundling) install in
247place, no hoisting. shallow (formerly --global-style) only install direct
248deps at top-level. linked: (experimental) install in node_modules/.store,
249link in place, unhoisted.</p>
250<h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
251<ul>
252<li>Default: false</li>
253<li>Type: Boolean</li>
254<li>DEPRECATED: This option has been deprecated in favor of
255<code>--install-strategy=nested</code></li>
256</ul>
257<p>Instead of hoisting package installs in <code>node_modules</code>, install packages in
258the same manner that they are depended on. This may cause very deep
259directory structures and duplicate package installs as there is no
260de-duplicating. Sets <code>--install-strategy=nested</code>.</p>
261<h4 id="global-style"><code>global-style</code></h4>
262<ul>
263<li>Default: false</li>
264<li>Type: Boolean</li>
265<li>DEPRECATED: This option has been deprecated in favor of
266<code>--install-strategy=shallow</code></li>
267</ul>
268<p>Only install direct dependencies in the top level <code>node_modules</code>, but hoist
269on deeper dependencies. Sets <code>--install-strategy=shallow</code>.</p>
270<h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
271<ul>
272<li>Default: false</li>
273<li>Type: Boolean</li>
274</ul>
275<p>If set to <code>true</code>, and <code>--legacy-peer-deps</code> is not set, then <em>any</em>
276conflicting <code>peerDependencies</code> will be treated as an install failure, even
277if npm could reasonably guess the appropriate resolution based on non-peer
278dependency relationships.</p>
279<p>By default, conflicting <code>peerDependencies</code> deep in the dependency graph will
280be resolved using the nearest non-peer dependency specification, even if
281doing so will result in some packages receiving a peer dependency outside
282the range set in their package's <code>peerDependencies</code> object.</p>
283<p>When such an override is performed, a warning is printed, explaining the
284conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
285this warning is treated as a failure.</p>
286<h4 id="package-lock"><code>package-lock</code></h4>
287<ul>
288<li>Default: true</li>
289<li>Type: Boolean</li>
290</ul>
291<p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
292will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
293<h4 id="omit"><code>omit</code></h4>
294<ul>
295<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
296'production'; otherwise, empty.</li>
297<li>Type: "dev", "optional", or "peer" (can be set multiple times)</li>
298</ul>
299<p>Dependency types to omit from the installation tree on disk.</p>
300<p>Note that these dependencies <em>are</em> still resolved and added to the
301<code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not
302physically installed on disk.</p>
303<p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then
304it will be included.</p>
305<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
306variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
307<h4 id="include"><code>include</code></h4>
308<ul>
309<li>Default:</li>
310<li>Type: "prod", "dev", "optional", or "peer" (can be set multiple times)</li>
311</ul>
312<p>Option that allows for defining which types of dependencies to install.</p>
313<p>This is the inverse of <code>--omit=<type></code>.</p>
314<p>Dependency types specified in <code>--include</code> will not be omitted, regardless of
315the order in which omit/include are specified on the command-line.</p>
316<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
317<ul>
318<li>Default: false</li>
319<li>Type: Boolean</li>
320</ul>
321<p>If true, npm does not run scripts specified in package.json files.</p>
322<p>Note that commands explicitly intended to run a particular script, such as
323<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run</code> will still
324run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em>
325run any pre- or post-scripts.</p>
326<h4 id="allow-git"><code>allow-git</code></h4>
327<ul>
328<li>Default: "all"</li>
329<li>Type: "all", "none", or "root"</li>
330</ul>
331<p>Limits the ability for npm to fetch dependencies from git references. That
332is, dependencies that point to a git repo instead of a version or semver
333range. Please note that this could leave your tree incomplete and some
334packages may not function as intended or designed.</p>
335<p><code>all</code> allows any git dependencies to be fetched and installed. <code>none</code>
336prevents any git dependencies from being fetched and installed. <code>root</code> only
337allows git dependencies defined in your project's package.json to be fetched
338installed. Also allows git dependencies to be fetched for other commands
339like <code>npm view</code></p>
340<h4 id="audit"><code>audit</code></h4>
341<ul>
342<li>Default: true</li>
343<li>Type: Boolean</li>
344</ul>
345<p>When "true" submit audit reports alongside the current npm command to the
346default registry and all registries configured for scopes. See the
347documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
348submitted.</p>
349<h4 id="bin-links"><code>bin-links</code></h4>
350<ul>
351<li>Default: true</li>
352<li>Type: Boolean</li>
353</ul>
354<p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
355executables.</p>
356<p>Set to false to have it not do this. This can be used to work around the
357fact that some file systems don't support symlinks, even on ostensibly Unix
358systems.</p>
359<h4 id="fund"><code>fund</code></h4>
360<ul>
361<li>Default: true</li>
362<li>Type: Boolean</li>
363</ul>
364<p>When "true" displays the message at the end of each <code>npm install</code>
365acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
366<h4 id="dry-run"><code>dry-run</code></h4>
367<ul>
368<li>Default: false</li>
369<li>Type: Boolean</li>
370</ul>
371<p>Indicates that you don't want npm to make any changes and that it should
372only report what it would have done. This can be passed into any of the
373commands that modify your local installation, eg, <code>install</code>, <code>update</code>,
374<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
375<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
376<code>owner</code>, etc.</p>
377<h4 id="workspace"><code>workspace</code></h4>
378<ul>
379<li>Default:</li>
380<li>Type: String (can be set multiple times)</li>
381</ul>
382<p>Enable running a command in the context of the configured workspaces of the
383current project while filtering by running only the workspaces defined by
384this configuration option.</p>
385<p>Valid values for the <code>workspace</code> config are either:</p>
386<ul>
387<li>Workspace names</li>
388<li>Path to a workspace directory</li>
389<li>Path to a parent workspace directory (will result in selecting all
390workspaces within that folder)</li>
391</ul>
392<p>When set for the <code>npm init</code> command, this may be set to the folder of a
393workspace which does not yet exist, to create the folder and set it up as a
394brand new workspace within the project.</p>
395<p>This value is not exported to the environment for child processes.</p>
396<h4 id="workspaces"><code>workspaces</code></h4>
397<ul>
398<li>Default: null</li>
399<li>Type: null or Boolean</li>
400</ul>
401<p>Set to true to run the command in the context of <strong>all</strong> configured
402workspaces.</p>
403<p>Explicitly setting this to false will cause commands like <code>install</code> to
404ignore workspaces altogether. When not set explicitly:</p>
405<ul>
406<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
407will link workspaces into the <code>node_modules</code> folder. - Commands that do
408other things (test, exec, publish, etc.) will operate on the root project,
409<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
410</ul>
411<p>This value is not exported to the environment for child processes.</p>
412<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
413<ul>
414<li>Default: false</li>
415<li>Type: Boolean</li>
416</ul>
417<p>Include the workspace root when workspaces are enabled for a command.</p>
418<p>When false, specifying individual workspaces via the <code>workspace</code> config, or
419all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
420the specified workspaces, and not on the root project.</p>
421<p>This value is not exported to the environment for child processes.</p>
422<h4 id="install-links"><code>install-links</code></h4>
423<ul>
424<li>Default: false</li>
425<li>Type: Boolean</li>
426</ul>
427<p>When set file: protocol dependencies will be packed and installed as regular
428dependencies instead of creating a symlink. This option has no effect on
429workspaces.</p>
430<h3 id="see-also">See Also</h3>
431<ul>
432<li><a href="../commands/npm-find-dupes.html">npm find-dupes</a></li>
433<li><a href="../commands/npm-ls.html">npm ls</a></li>
434<li><a href="../commands/npm-update.html">npm update</a></li>
435<li><a href="../commands/npm-install.html">npm install</a></li>
436</ul></div>
437
438<footer id="edit">
439<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-dedupe.md">
440<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
441<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>
442</svg>
443Edit this page on GitHub
444</a>
445</footer>
446</section>
447
448
449
450</body></html>