npm-find-dupes.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393
  1. <!DOCTYPE html><html><head>
  2. <meta charset="utf-8">
  3. <title>npm-find-dupes</title>
  4. <style>
  5. body {
  6. background-color: #ffffff;
  7. color: #24292e;
  8. margin: 0;
  9. line-height: 1.5;
  10. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
  11. }
  12. #rainbar {
  13. height: 10px;
  14. background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
  15. }
  16. a {
  17. text-decoration: none;
  18. color: #0366d6;
  19. }
  20. a:hover {
  21. text-decoration: underline;
  22. }
  23. pre {
  24. margin: 1em 0px;
  25. padding: 1em;
  26. border: solid 1px #e1e4e8;
  27. border-radius: 6px;
  28. display: block;
  29. overflow: auto;
  30. white-space: pre;
  31. background-color: #f6f8fa;
  32. color: #393a34;
  33. }
  34. code {
  35. font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  36. font-size: 85%;
  37. padding: 0.2em 0.4em;
  38. background-color: #f6f8fa;
  39. color: #393a34;
  40. }
  41. pre > code {
  42. padding: 0;
  43. background-color: inherit;
  44. color: inherit;
  45. }
  46. h1, h2, h3 {
  47. font-weight: 600;
  48. }
  49. #logobar {
  50. background-color: #333333;
  51. margin: 0 auto;
  52. padding: 1em 4em;
  53. }
  54. #logobar .logo {
  55. float: left;
  56. }
  57. #logobar .title {
  58. font-weight: 600;
  59. color: #dddddd;
  60. float: left;
  61. margin: 5px 0 0 1em;
  62. }
  63. #logobar:after {
  64. content: "";
  65. display: block;
  66. clear: both;
  67. }
  68. #content {
  69. margin: 0 auto;
  70. padding: 0 4em;
  71. }
  72. #table_of_contents > h2 {
  73. font-size: 1.17em;
  74. }
  75. #table_of_contents ul:first-child {
  76. border: solid 1px #e1e4e8;
  77. border-radius: 6px;
  78. padding: 1em;
  79. background-color: #f6f8fa;
  80. color: #393a34;
  81. }
  82. #table_of_contents ul {
  83. list-style-type: none;
  84. padding-left: 1.5em;
  85. }
  86. #table_of_contents li {
  87. font-size: 0.9em;
  88. }
  89. #table_of_contents li a {
  90. color: #000000;
  91. }
  92. header.title {
  93. border-bottom: solid 1px #e1e4e8;
  94. }
  95. header.title > h1 {
  96. margin-bottom: 0.25em;
  97. }
  98. header.title > .description {
  99. display: block;
  100. margin-bottom: 0.5em;
  101. line-height: 1;
  102. }
  103. header.title .version {
  104. font-size: 0.8em;
  105. color: #666666;
  106. }
  107. footer#edit {
  108. border-top: solid 1px #e1e4e8;
  109. margin: 3em 0 4em 0;
  110. padding-top: 2em;
  111. }
  112. table {
  113. width: 100%;
  114. margin: 1em 0;
  115. border-radius: 6px;
  116. border: 1px solid #e1e4e8;
  117. overflow: hidden;
  118. border-collapse: separate;
  119. border-spacing: 0;
  120. }
  121. table thead {
  122. background-color: #f6f8fa;
  123. }
  124. table tbody {
  125. background-color: #ffffff;
  126. }
  127. table th,
  128. table td {
  129. padding: 0.75em;
  130. text-align: left;
  131. border-right: 1px solid #e1e4e8;
  132. border-bottom: 1px solid #e1e4e8;
  133. }
  134. table th:last-child,
  135. table td:last-child {
  136. border-right: none;
  137. }
  138. table tbody tr:last-child td {
  139. border-bottom: none;
  140. }
  141. table th {
  142. font-weight: 600;
  143. background-color: #f6f8fa;
  144. }
  145. table code {
  146. white-space: nowrap;
  147. }
  148. </style>
  149. </head>
  150. <body>
  151. <div id="banner">
  152. <div id="rainbar"></div>
  153. <div id="logobar">
  154. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
  155. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
  156. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
  157. </svg>
  158. <div class="title">
  159. npm command-line interface
  160. </div>
  161. </div>
  162. </div>
  163. <section id="content">
  164. <header class="title">
  165. <h1 id="----npm-find-dupes----11120">
  166. <span>npm-find-dupes</span>
  167. <span class="version">@11.12.0</span>
  168. </h1>
  169. <span class="description">Find duplication in the package tree</span>
  170. </header>
  171. <section id="table_of_contents">
  172. <h2 id="table-of-contents">Table of contents</h2>
  173. <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="#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="#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>
  174. </section>
  175. <div id="_content"><h3 id="synopsis">Synopsis</h3>
  176. <pre><code class="language-bash">npm find-dupes
  177. </code></pre>
  178. <h3 id="description">Description</h3>
  179. <p>Runs <code>npm dedupe</code> in <code>--dry-run</code> mode, making npm only output the duplications, without actually changing the package tree.</p>
  180. <h3 id="configuration">Configuration</h3>
  181. <h4 id="install-strategy"><code>install-strategy</code></h4>
  182. <ul>
  183. <li>Default: "hoisted"</li>
  184. <li>Type: "hoisted", "nested", "shallow", or "linked"</li>
  185. </ul>
  186. <p>Sets the strategy for installing packages in node_modules. hoisted
  187. (default): Install non-duplicated in top-level, and duplicated as necessary
  188. within directory structure. nested: (formerly --legacy-bundling) install in
  189. place, no hoisting. shallow (formerly --global-style) only install direct
  190. deps at top-level. linked: (experimental) install in node_modules/.store,
  191. link in place, unhoisted.</p>
  192. <h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
  193. <ul>
  194. <li>Default: false</li>
  195. <li>Type: Boolean</li>
  196. <li>DEPRECATED: This option has been deprecated in favor of
  197. <code>--install-strategy=nested</code></li>
  198. </ul>
  199. <p>Instead of hoisting package installs in <code>node_modules</code>, install packages in
  200. the same manner that they are depended on. This may cause very deep
  201. directory structures and duplicate package installs as there is no
  202. de-duplicating. Sets <code>--install-strategy=nested</code>.</p>
  203. <h4 id="global-style"><code>global-style</code></h4>
  204. <ul>
  205. <li>Default: false</li>
  206. <li>Type: Boolean</li>
  207. <li>DEPRECATED: This option has been deprecated in favor of
  208. <code>--install-strategy=shallow</code></li>
  209. </ul>
  210. <p>Only install direct dependencies in the top level <code>node_modules</code>, but hoist
  211. on deeper dependencies. Sets <code>--install-strategy=shallow</code>.</p>
  212. <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
  213. <ul>
  214. <li>Default: false</li>
  215. <li>Type: Boolean</li>
  216. </ul>
  217. <p>If set to <code>true</code>, and <code>--legacy-peer-deps</code> is not set, then <em>any</em>
  218. conflicting <code>peerDependencies</code> will be treated as an install failure, even
  219. if npm could reasonably guess the appropriate resolution based on non-peer
  220. dependency relationships.</p>
  221. <p>By default, conflicting <code>peerDependencies</code> deep in the dependency graph will
  222. be resolved using the nearest non-peer dependency specification, even if
  223. doing so will result in some packages receiving a peer dependency outside
  224. the range set in their package's <code>peerDependencies</code> object.</p>
  225. <p>When such an override is performed, a warning is printed, explaining the
  226. conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
  227. this warning is treated as a failure.</p>
  228. <h4 id="package-lock"><code>package-lock</code></h4>
  229. <ul>
  230. <li>Default: true</li>
  231. <li>Type: Boolean</li>
  232. </ul>
  233. <p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
  234. will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
  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. <h4 id="include"><code>include</code></h4>
  250. <ul>
  251. <li>Default:</li>
  252. <li>Type: "prod", "dev", "optional", or "peer" (can be set multiple times)</li>
  253. </ul>
  254. <p>Option that allows for defining which types of dependencies to install.</p>
  255. <p>This is the inverse of <code>--omit=&lt;type&gt;</code>.</p>
  256. <p>Dependency types specified in <code>--include</code> will not be omitted, regardless of
  257. the order in which omit/include are specified on the command-line.</p>
  258. <h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
  259. <ul>
  260. <li>Default: false</li>
  261. <li>Type: Boolean</li>
  262. </ul>
  263. <p>If true, npm does not run scripts specified in package.json files.</p>
  264. <p>Note that commands explicitly intended to run a particular script, such as
  265. <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run</code> will still
  266. run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em>
  267. run any pre- or post-scripts.</p>
  268. <h4 id="audit"><code>audit</code></h4>
  269. <ul>
  270. <li>Default: true</li>
  271. <li>Type: Boolean</li>
  272. </ul>
  273. <p>When "true" submit audit reports alongside the current npm command to the
  274. default registry and all registries configured for scopes. See the
  275. documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
  276. submitted.</p>
  277. <h4 id="bin-links"><code>bin-links</code></h4>
  278. <ul>
  279. <li>Default: true</li>
  280. <li>Type: Boolean</li>
  281. </ul>
  282. <p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
  283. executables.</p>
  284. <p>Set to false to have it not do this. This can be used to work around the
  285. fact that some file systems don't support symlinks, even on ostensibly Unix
  286. systems.</p>
  287. <h4 id="fund"><code>fund</code></h4>
  288. <ul>
  289. <li>Default: true</li>
  290. <li>Type: Boolean</li>
  291. </ul>
  292. <p>When "true" displays the message at the end of each <code>npm install</code>
  293. acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
  294. <h4 id="workspace"><code>workspace</code></h4>
  295. <ul>
  296. <li>Default:</li>
  297. <li>Type: String (can be set multiple times)</li>
  298. </ul>
  299. <p>Enable running a command in the context of the configured workspaces of the
  300. current project while filtering by running only the workspaces defined by
  301. this configuration option.</p>
  302. <p>Valid values for the <code>workspace</code> config are either:</p>
  303. <ul>
  304. <li>Workspace names</li>
  305. <li>Path to a workspace directory</li>
  306. <li>Path to a parent workspace directory (will result in selecting all
  307. workspaces within that folder)</li>
  308. </ul>
  309. <p>When set for the <code>npm init</code> command, this may be set to the folder of a
  310. workspace which does not yet exist, to create the folder and set it up as a
  311. brand new workspace within the project.</p>
  312. <p>This value is not exported to the environment for child processes.</p>
  313. <h4 id="workspaces"><code>workspaces</code></h4>
  314. <ul>
  315. <li>Default: null</li>
  316. <li>Type: null or Boolean</li>
  317. </ul>
  318. <p>Set to true to run the command in the context of <strong>all</strong> configured
  319. workspaces.</p>
  320. <p>Explicitly setting this to false will cause commands like <code>install</code> to
  321. ignore workspaces altogether. When not set explicitly:</p>
  322. <ul>
  323. <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
  324. will link workspaces into the <code>node_modules</code> folder. - Commands that do
  325. other things (test, exec, publish, etc.) will operate on the root project,
  326. <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
  327. </ul>
  328. <p>This value is not exported to the environment for child processes.</p>
  329. <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
  330. <ul>
  331. <li>Default: false</li>
  332. <li>Type: Boolean</li>
  333. </ul>
  334. <p>Include the workspace root when workspaces are enabled for a command.</p>
  335. <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
  336. all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
  337. the specified workspaces, and not on the root project.</p>
  338. <p>This value is not exported to the environment for child processes.</p>
  339. <h4 id="install-links"><code>install-links</code></h4>
  340. <ul>
  341. <li>Default: false</li>
  342. <li>Type: Boolean</li>
  343. </ul>
  344. <p>When set file: protocol dependencies will be packed and installed as regular
  345. dependencies instead of creating a symlink. This option has no effect on
  346. workspaces.</p>
  347. <h3 id="see-also">See Also</h3>
  348. <ul>
  349. <li><a href="../commands/npm-dedupe.html">npm dedupe</a></li>
  350. <li><a href="../commands/npm-ls.html">npm ls</a></li>
  351. <li><a href="../commands/npm-update.html">npm update</a></li>
  352. <li><a href="../commands/npm-install.html">npm install</a></li>
  353. </ul></div>
  354. <footer id="edit">
  355. <a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-find-dupes.md">
  356. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  357. <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>
  358. </svg>
  359. Edit this page on GitHub
  360. </a>
  361. </footer>
  362. </section>
  363. </body></html>