npm-dedupe.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  1. <html><head>
  2. <title>npm-dedupe</title>
  3. <style>
  4. body {
  5. background-color: #ffffff;
  6. color: #24292e;
  7. margin: 0;
  8. line-height: 1.5;
  9. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
  10. }
  11. #rainbar {
  12. height: 10px;
  13. background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
  14. }
  15. a {
  16. text-decoration: none;
  17. color: #0366d6;
  18. }
  19. a:hover {
  20. text-decoration: underline;
  21. }
  22. pre {
  23. margin: 1em 0px;
  24. padding: 1em;
  25. border: solid 1px #e1e4e8;
  26. border-radius: 6px;
  27. display: block;
  28. overflow: auto;
  29. white-space: pre;
  30. background-color: #f6f8fa;
  31. color: #393a34;
  32. }
  33. code {
  34. font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  35. font-size: 85%;
  36. padding: 0.2em 0.4em;
  37. background-color: #f6f8fa;
  38. color: #393a34;
  39. }
  40. pre > code {
  41. padding: 0;
  42. background-color: inherit;
  43. color: inherit;
  44. }
  45. h1, h2, h3 {
  46. font-weight: 600;
  47. }
  48. #logobar {
  49. background-color: #333333;
  50. margin: 0 auto;
  51. padding: 1em 4em;
  52. }
  53. #logobar .logo {
  54. float: left;
  55. }
  56. #logobar .title {
  57. font-weight: 600;
  58. color: #dddddd;
  59. float: left;
  60. margin: 5px 0 0 1em;
  61. }
  62. #logobar:after {
  63. content: "";
  64. display: block;
  65. clear: both;
  66. }
  67. #content {
  68. margin: 0 auto;
  69. padding: 0 4em;
  70. }
  71. #table_of_contents > h2 {
  72. font-size: 1.17em;
  73. }
  74. #table_of_contents ul:first-child {
  75. border: solid 1px #e1e4e8;
  76. border-radius: 6px;
  77. padding: 1em;
  78. background-color: #f6f8fa;
  79. color: #393a34;
  80. }
  81. #table_of_contents ul {
  82. list-style-type: none;
  83. padding-left: 1.5em;
  84. }
  85. #table_of_contents li {
  86. font-size: 0.9em;
  87. }
  88. #table_of_contents li a {
  89. color: #000000;
  90. }
  91. header.title {
  92. border-bottom: solid 1px #e1e4e8;
  93. }
  94. header.title > h1 {
  95. margin-bottom: 0.25em;
  96. }
  97. header.title > .description {
  98. display: block;
  99. margin-bottom: 0.5em;
  100. line-height: 1;
  101. }
  102. footer#edit {
  103. border-top: solid 1px #e1e4e8;
  104. margin: 3em 0 4em 0;
  105. padding-top: 2em;
  106. }
  107. </style>
  108. </head>
  109. <body>
  110. <div id="banner">
  111. <div id="rainbar"></div>
  112. <div id="logobar">
  113. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
  114. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
  115. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
  116. </svg>
  117. <div class="title">
  118. npm command-line interface
  119. </div>
  120. </div>
  121. </div>
  122. <section id="content">
  123. <header class="title">
  124. <h1 id="npm-dedupe">npm-dedupe</h1>
  125. <span class="description">Reduce duplication in the package tree</span>
  126. </header>
  127. <section id="table_of_contents">
  128. <h2 id="table-of-contents">Table of contents</h2>
  129. <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="#global-style"><code>global-style</code></a></li><li><a href="#legacy-bundling"><code>legacy-bundling</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="#ignore-scripts"><code>ignore-scripts</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></ul><li><a href="#see-also">See Also</a></li></ul></div>
  130. </section>
  131. <div id="_content"><h3 id="synopsis">Synopsis</h3>
  132. <pre lang="bash"><code>npm dedupe
  133. npm ddp
  134. aliases: ddp
  135. </code></pre>
  136. <h3 id="description">Description</h3>
  137. <p>Searches the local package tree and attempts to simplify the overall
  138. structure by moving dependencies further up the tree, where they can
  139. be more effectively shared by multiple dependent packages.</p>
  140. <p>For example, consider this dependency graph:</p>
  141. <pre><code>a
  142. +-- b &lt;-- depends on c@1.0.x
  143. | `-- c@1.0.3
  144. `-- d &lt;-- depends on c@~1.0.9
  145. `-- c@1.0.10
  146. </code></pre>
  147. <p>In this case, <code>npm dedupe</code> will transform the tree to:</p>
  148. <pre lang="bash"><code>a
  149. +-- b
  150. +-- d
  151. `-- c@1.0.10
  152. </code></pre>
  153. <p>Because of the hierarchical nature of node’s module lookup, b and d
  154. will both get their dependency met by the single c package at the root
  155. level of the tree.</p>
  156. <p>In some cases, you may have a dependency graph like this:</p>
  157. <pre><code>a
  158. +-- b &lt;-- depends on c@1.0.x
  159. +-- c@1.0.3
  160. `-- d &lt;-- depends on c@1.x
  161. `-- c@1.9.9
  162. </code></pre>
  163. <p>During the installation process, the <code>c@1.0.3</code> dependency for <code>b</code> was
  164. placed in the root of the tree. Though <code>d</code>’s dependency on <code>c@1.x</code> could
  165. have been satisfied by <code>c@1.0.3</code>, the newer <code>c@1.9.0</code> dependency was used,
  166. because npm favors updates by default, even when doing so causes
  167. duplication.</p>
  168. <p>Running <code>npm dedupe</code> will cause npm to note the duplication and
  169. re-evaluate, deleting the nested <code>c</code> module, because the one in the root is
  170. sufficient.</p>
  171. <p>To prefer deduplication over novelty during the installation process, run
  172. <code>npm install --prefer-dedupe</code> or <code>npm config set prefer-dedupe true</code>.</p>
  173. <p>Arguments are ignored. Dedupe always acts on the entire tree.</p>
  174. <p>Note that this operation transforms the dependency tree, but will never
  175. result in new modules being installed.</p>
  176. <p>Using <code>npm find-dupes</code> will run the command in <code>--dry-run</code> mode.</p>
  177. <h3 id="configuration">Configuration</h3>
  178. <!-- raw HTML omitted -->
  179. <!-- raw HTML omitted -->
  180. <!-- raw HTML omitted -->
  181. <h4 id="global-style"><code>global-style</code></h4>
  182. <ul>
  183. <li>Default: false</li>
  184. <li>Type: Boolean</li>
  185. </ul>
  186. <p>Causes npm to install the package into your local <code>node_modules</code> folder with
  187. the same layout it uses with the global <code>node_modules</code> folder. Only your
  188. direct dependencies will show in <code>node_modules</code> and everything they depend
  189. on will be flattened in their <code>node_modules</code> folders. This obviously will
  190. eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code>
  191. will be preferred.</p>
  192. <!-- raw HTML omitted -->
  193. <!-- raw HTML omitted -->
  194. <h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
  195. <ul>
  196. <li>Default: false</li>
  197. <li>Type: Boolean</li>
  198. </ul>
  199. <p>Causes npm to install the package such that versions of npm prior to 1.4,
  200. such as the one included with node 0.8, can install the package. This
  201. eliminates all automatic deduping. If used with <code>global-style</code> this option
  202. will be preferred.</p>
  203. <!-- raw HTML omitted -->
  204. <!-- raw HTML omitted -->
  205. <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
  206. <ul>
  207. <li>Default: false</li>
  208. <li>Type: Boolean</li>
  209. </ul>
  210. <p>If set to <code>true</code>, and <code>--legacy-peer-deps</code> is not set, then <em>any</em>
  211. conflicting <code>peerDependencies</code> will be treated as an install failure, even
  212. if npm could reasonably guess the appropriate resolution based on non-peer
  213. dependency relationships.</p>
  214. <p>By default, conflicting <code>peerDependencies</code> deep in the dependency graph will
  215. be resolved using the nearest non-peer dependency specification, even if
  216. doing so will result in some packages receiving a peer dependency outside
  217. the range set in their package’s <code>peerDependencies</code> object.</p>
  218. <p>When such and override is performed, a warning is printed, explaining the
  219. conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
  220. this warning is treated as a failure.</p>
  221. <!-- raw HTML omitted -->
  222. <!-- raw HTML omitted -->
  223. <h4 id="package-lock"><code>package-lock</code></h4>
  224. <ul>
  225. <li>Default: true</li>
  226. <li>Type: Boolean</li>
  227. </ul>
  228. <p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
  229. will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
  230. <p>When package package-locks are disabled, automatic pruning of extraneous
  231. modules will also be disabled. To remove extraneous modules with
  232. package-locks disabled use <code>npm prune</code>.</p>
  233. <!-- raw HTML omitted -->
  234. <!-- raw HTML omitted -->
  235. <h4 id="omit"><code>omit</code></h4>
  236. <ul>
  237. <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to
  238. ‘production’, otherwise empty.</li>
  239. <li>Type: “dev”, “optional”, or “peer” (can be set multiple times)</li>
  240. </ul>
  241. <p>Dependency types to omit from the installation tree on disk.</p>
  242. <p>Note that these dependencies <em>are</em> still resolved and added to the
  243. <code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not
  244. physically installed on disk.</p>
  245. <p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then
  246. it will be included.</p>
  247. <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
  248. variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
  249. <!-- raw HTML omitted -->
  250. <!-- raw HTML omitted -->
  251. <h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
  252. <ul>
  253. <li>Default: false</li>
  254. <li>Type: Boolean</li>
  255. </ul>
  256. <p>If true, npm does not run scripts specified in package.json files.</p>
  257. <p>Note that commands explicitly intended to run a particular script, such as
  258. <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
  259. will still run their intended script if <code>ignore-scripts</code> is set, but they
  260. will <em>not</em> run any pre- or post-scripts.</p>
  261. <!-- raw HTML omitted -->
  262. <!-- raw HTML omitted -->
  263. <h4 id="audit"><code>audit</code></h4>
  264. <ul>
  265. <li>Default: true</li>
  266. <li>Type: Boolean</li>
  267. </ul>
  268. <p>When “true” submit audit reports alongside the current npm command to the
  269. default registry and all registries configured for scopes. See the
  270. documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
  271. submitted.</p>
  272. <!-- raw HTML omitted -->
  273. <!-- raw HTML omitted -->
  274. <h4 id="bin-links"><code>bin-links</code></h4>
  275. <ul>
  276. <li>Default: true</li>
  277. <li>Type: Boolean</li>
  278. </ul>
  279. <p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
  280. executables.</p>
  281. <p>Set to false to have it not do this. This can be used to work around the
  282. fact that some file systems don’t support symlinks, even on ostensibly Unix
  283. systems.</p>
  284. <!-- raw HTML omitted -->
  285. <!-- raw HTML omitted -->
  286. <h4 id="fund"><code>fund</code></h4>
  287. <ul>
  288. <li>Default: true</li>
  289. <li>Type: Boolean</li>
  290. </ul>
  291. <p>When “true” displays the message at the end of each <code>npm install</code>
  292. acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
  293. <!-- raw HTML omitted -->
  294. <!-- raw HTML omitted -->
  295. <h4 id="dry-run"><code>dry-run</code></h4>
  296. <ul>
  297. <li>Default: false</li>
  298. <li>Type: Boolean</li>
  299. </ul>
  300. <p>Indicates that you don’t want npm to make any changes and that it should
  301. only report what it would have done. This can be passed into any of the
  302. commands that modify your local installation, eg, <code>install</code>, <code>update</code>,
  303. <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
  304. <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
  305. <code>owner</code>, etc.</p>
  306. <!-- raw HTML omitted -->
  307. <!-- raw HTML omitted -->
  308. <h4 id="workspace"><code>workspace</code></h4>
  309. <ul>
  310. <li>Default:</li>
  311. <li>Type: String (can be set multiple times)</li>
  312. </ul>
  313. <p>Enable running a command in the context of the configured workspaces of the
  314. current project while filtering by running only the workspaces defined by
  315. this configuration option.</p>
  316. <p>Valid values for the <code>workspace</code> config are either:</p>
  317. <ul>
  318. <li>Workspace names</li>
  319. <li>Path to a workspace directory</li>
  320. <li>Path to a parent workspace directory (will result in selecting all
  321. workspaces within that folder)</li>
  322. </ul>
  323. <p>When set for the <code>npm init</code> command, this may be set to the folder of a
  324. workspace which does not yet exist, to create the folder and set it up as a
  325. brand new workspace within the project.</p>
  326. <p>This value is not exported to the environment for child processes.</p>
  327. <!-- raw HTML omitted -->
  328. <!-- raw HTML omitted -->
  329. <h4 id="workspaces"><code>workspaces</code></h4>
  330. <ul>
  331. <li>Default: null</li>
  332. <li>Type: null or Boolean</li>
  333. </ul>
  334. <p>Set to true to run the command in the context of <strong>all</strong> configured
  335. workspaces.</p>
  336. <p>Explicitly setting this to false will cause commands like <code>install</code> to
  337. ignore workspaces altogether. When not set explicitly:</p>
  338. <ul>
  339. <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
  340. will link workspaces into the <code>node_modules</code> folder. - Commands that do
  341. other things (test, exec, publish, etc.) will operate on the root project,
  342. <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
  343. </ul>
  344. <p>This value is not exported to the environment for child processes.</p>
  345. <!-- raw HTML omitted -->
  346. <!-- raw HTML omitted -->
  347. <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
  348. <ul>
  349. <li>Default: false</li>
  350. <li>Type: Boolean</li>
  351. </ul>
  352. <p>Include the workspace root when workspaces are enabled for a command.</p>
  353. <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
  354. all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
  355. the specified workspaces, and not on the root project.</p>
  356. <!-- raw HTML omitted -->
  357. <!-- raw HTML omitted -->
  358. <!-- raw HTML omitted -->
  359. <h3 id="see-also">See Also</h3>
  360. <ul>
  361. <li><a href="../commands/npm-find-dupes.html">npm find-dupes</a></li>
  362. <li><a href="../commands/npm-ls.html">npm ls</a></li>
  363. <li><a href="../commands/npm-update.html">npm update</a></li>
  364. <li><a href="../commands/npm-install.html">npm install</a></li>
  365. </ul>
  366. </div>
  367. <footer id="edit">
  368. <a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-dedupe.md">
  369. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  370. <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>
  371. </svg>
  372. Edit this page on GitHub
  373. </a>
  374. </footer>
  375. </section>
  376. </body></html>