npm-find-dupes.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. <html><head>
  2. <title>npm-find-dupes</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-find-dupes">npm-find-dupes</h1>
  125. <span class="description">Find 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="#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 find-dupes
  133. </code></pre>
  134. <h3 id="description">Description</h3>
  135. <p>Runs <code>npm dedupe</code> in <code>--dry-run</code> mode, making npm only output the
  136. duplications, without actually changing the package tree.</p>
  137. <h3 id="configuration">Configuration</h3>
  138. <!-- raw HTML omitted -->
  139. <!-- raw HTML omitted -->
  140. <!-- raw HTML omitted -->
  141. <h4 id="global-style"><code>global-style</code></h4>
  142. <ul>
  143. <li>Default: false</li>
  144. <li>Type: Boolean</li>
  145. </ul>
  146. <p>Causes npm to install the package into your local <code>node_modules</code> folder with
  147. the same layout it uses with the global <code>node_modules</code> folder. Only your
  148. direct dependencies will show in <code>node_modules</code> and everything they depend
  149. on will be flattened in their <code>node_modules</code> folders. This obviously will
  150. eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code>
  151. will be preferred.</p>
  152. <!-- raw HTML omitted -->
  153. <!-- raw HTML omitted -->
  154. <h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
  155. <ul>
  156. <li>Default: false</li>
  157. <li>Type: Boolean</li>
  158. </ul>
  159. <p>Causes npm to install the package such that versions of npm prior to 1.4,
  160. such as the one included with node 0.8, can install the package. This
  161. eliminates all automatic deduping. If used with <code>global-style</code> this option
  162. will be preferred.</p>
  163. <!-- raw HTML omitted -->
  164. <!-- raw HTML omitted -->
  165. <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
  166. <ul>
  167. <li>Default: false</li>
  168. <li>Type: Boolean</li>
  169. </ul>
  170. <p>If set to <code>true</code>, and <code>--legacy-peer-deps</code> is not set, then <em>any</em>
  171. conflicting <code>peerDependencies</code> will be treated as an install failure, even
  172. if npm could reasonably guess the appropriate resolution based on non-peer
  173. dependency relationships.</p>
  174. <p>By default, conflicting <code>peerDependencies</code> deep in the dependency graph will
  175. be resolved using the nearest non-peer dependency specification, even if
  176. doing so will result in some packages receiving a peer dependency outside
  177. the range set in their package’s <code>peerDependencies</code> object.</p>
  178. <p>When such and override is performed, a warning is printed, explaining the
  179. conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
  180. this warning is treated as a failure.</p>
  181. <!-- raw HTML omitted -->
  182. <!-- raw HTML omitted -->
  183. <h4 id="package-lock"><code>package-lock</code></h4>
  184. <ul>
  185. <li>Default: true</li>
  186. <li>Type: Boolean</li>
  187. </ul>
  188. <p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
  189. will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
  190. <p>When package package-locks are disabled, automatic pruning of extraneous
  191. modules will also be disabled. To remove extraneous modules with
  192. package-locks disabled use <code>npm prune</code>.</p>
  193. <!-- raw HTML omitted -->
  194. <!-- raw HTML omitted -->
  195. <h4 id="omit"><code>omit</code></h4>
  196. <ul>
  197. <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to
  198. ‘production’, otherwise empty.</li>
  199. <li>Type: “dev”, “optional”, or “peer” (can be set multiple times)</li>
  200. </ul>
  201. <p>Dependency types to omit from the installation tree on disk.</p>
  202. <p>Note that these dependencies <em>are</em> still resolved and added to the
  203. <code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not
  204. physically installed on disk.</p>
  205. <p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then
  206. it will be included.</p>
  207. <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
  208. variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
  209. <!-- raw HTML omitted -->
  210. <!-- raw HTML omitted -->
  211. <h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
  212. <ul>
  213. <li>Default: false</li>
  214. <li>Type: Boolean</li>
  215. </ul>
  216. <p>If true, npm does not run scripts specified in package.json files.</p>
  217. <p>Note that commands explicitly intended to run a particular script, such as
  218. <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code>
  219. will still run their intended script if <code>ignore-scripts</code> is set, but they
  220. will <em>not</em> run any pre- or post-scripts.</p>
  221. <!-- raw HTML omitted -->
  222. <!-- raw HTML omitted -->
  223. <h4 id="audit"><code>audit</code></h4>
  224. <ul>
  225. <li>Default: true</li>
  226. <li>Type: Boolean</li>
  227. </ul>
  228. <p>When “true” submit audit reports alongside the current npm command to the
  229. default registry and all registries configured for scopes. See the
  230. documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
  231. submitted.</p>
  232. <!-- raw HTML omitted -->
  233. <!-- raw HTML omitted -->
  234. <h4 id="bin-links"><code>bin-links</code></h4>
  235. <ul>
  236. <li>Default: true</li>
  237. <li>Type: Boolean</li>
  238. </ul>
  239. <p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
  240. executables.</p>
  241. <p>Set to false to have it not do this. This can be used to work around the
  242. fact that some file systems don’t support symlinks, even on ostensibly Unix
  243. systems.</p>
  244. <!-- raw HTML omitted -->
  245. <!-- raw HTML omitted -->
  246. <h4 id="fund"><code>fund</code></h4>
  247. <ul>
  248. <li>Default: true</li>
  249. <li>Type: Boolean</li>
  250. </ul>
  251. <p>When “true” displays the message at the end of each <code>npm install</code>
  252. acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
  253. <!-- raw HTML omitted -->
  254. <!-- raw HTML omitted -->
  255. <h4 id="workspace"><code>workspace</code></h4>
  256. <ul>
  257. <li>Default:</li>
  258. <li>Type: String (can be set multiple times)</li>
  259. </ul>
  260. <p>Enable running a command in the context of the configured workspaces of the
  261. current project while filtering by running only the workspaces defined by
  262. this configuration option.</p>
  263. <p>Valid values for the <code>workspace</code> config are either:</p>
  264. <ul>
  265. <li>Workspace names</li>
  266. <li>Path to a workspace directory</li>
  267. <li>Path to a parent workspace directory (will result in selecting all
  268. workspaces within that folder)</li>
  269. </ul>
  270. <p>When set for the <code>npm init</code> command, this may be set to the folder of a
  271. workspace which does not yet exist, to create the folder and set it up as a
  272. brand new workspace within the project.</p>
  273. <p>This value is not exported to the environment for child processes.</p>
  274. <!-- raw HTML omitted -->
  275. <!-- raw HTML omitted -->
  276. <h4 id="workspaces"><code>workspaces</code></h4>
  277. <ul>
  278. <li>Default: null</li>
  279. <li>Type: null or Boolean</li>
  280. </ul>
  281. <p>Set to true to run the command in the context of <strong>all</strong> configured
  282. workspaces.</p>
  283. <p>Explicitly setting this to false will cause commands like <code>install</code> to
  284. ignore workspaces altogether. When not set explicitly:</p>
  285. <ul>
  286. <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
  287. will link workspaces into the <code>node_modules</code> folder. - Commands that do
  288. other things (test, exec, publish, etc.) will operate on the root project,
  289. <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
  290. </ul>
  291. <p>This value is not exported to the environment for child processes.</p>
  292. <!-- raw HTML omitted -->
  293. <!-- raw HTML omitted -->
  294. <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
  295. <ul>
  296. <li>Default: false</li>
  297. <li>Type: Boolean</li>
  298. </ul>
  299. <p>Include the workspace root when workspaces are enabled for a command.</p>
  300. <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
  301. all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
  302. the specified workspaces, and not on the root project.</p>
  303. <!-- raw HTML omitted -->
  304. <!-- raw HTML omitted -->
  305. <!-- raw HTML omitted -->
  306. <h3 id="see-also">See Also</h3>
  307. <ul>
  308. <li><a href="../commands/npm-dedupe.html">npm dedupe</a></li>
  309. <li><a href="../commands/npm-ls.html">npm ls</a></li>
  310. <li><a href="../commands/npm-update.html">npm update</a></li>
  311. <li><a href="../commands/npm-install.html">npm install</a></li>
  312. </ul>
  313. </div>
  314. <footer id="edit">
  315. <a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-find-dupes.md">
  316. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  317. <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>
  318. </svg>
  319. Edit this page on GitHub
  320. </a>
  321. </footer>
  322. </section>
  323. </body></html>