npm-find-dupes.1 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277
  1. .TH "NPM\-FIND\-DUPES" "1" "October 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-find-dupes\fR \- Find duplication in the package tree
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm find\-dupes
  9. .fi
  10. .RE
  11. .SS Description
  12. .P
  13. Runs \fBnpm dedupe\fP in \fB\-\-dry\-run\fP mode, making npm only output the
  14. duplications, without actually changing the package tree\.
  15. .SS Configuration
  16. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
  17. <!\-\- automatically generated, do not edit manually \-\->
  18. <!\-\- see lib/utils/config/definitions\.js \-\->
  19. .SS \fBglobal\-style\fP
  20. .RS 0
  21. .IP \(bu 2
  22. Default: false
  23. .IP \(bu 2
  24. Type: Boolean
  25. .RE
  26. .P
  27. Causes npm to install the package into your local \fBnode_modules\fP folder with
  28. the same layout it uses with the global \fBnode_modules\fP folder\. Only your
  29. direct dependencies will show in \fBnode_modules\fP and everything they depend
  30. on will be flattened in their \fBnode_modules\fP folders\. This obviously will
  31. eliminate some deduping\. If used with \fBlegacy\-bundling\fP, \fBlegacy\-bundling\fP
  32. will be preferred\.
  33. <!\-\- automatically generated, do not edit manually \-\->
  34. <!\-\- see lib/utils/config/definitions\.js \-\->
  35. .SS \fBlegacy\-bundling\fP
  36. .RS 0
  37. .IP \(bu 2
  38. Default: false
  39. .IP \(bu 2
  40. Type: Boolean
  41. .RE
  42. .P
  43. Causes npm to install the package such that versions of npm prior to 1\.4,
  44. such as the one included with node 0\.8, can install the package\. This
  45. eliminates all automatic deduping\. If used with \fBglobal\-style\fP this option
  46. will be preferred\.
  47. <!\-\- automatically generated, do not edit manually \-\->
  48. <!\-\- see lib/utils/config/definitions\.js \-\->
  49. .SS \fBstrict\-peer\-deps\fP
  50. .RS 0
  51. .IP \(bu 2
  52. Default: false
  53. .IP \(bu 2
  54. Type: Boolean
  55. .RE
  56. .P
  57. If set to \fBtrue\fP, and \fB\-\-legacy\-peer\-deps\fP is not set, then \fIany\fR
  58. conflicting \fBpeerDependencies\fP will be treated as an install failure, even
  59. if npm could reasonably guess the appropriate resolution based on non\-peer
  60. dependency relationships\.
  61. .P
  62. By default, conflicting \fBpeerDependencies\fP deep in the dependency graph will
  63. be resolved using the nearest non\-peer dependency specification, even if
  64. doing so will result in some packages receiving a peer dependency outside
  65. the range set in their package's \fBpeerDependencies\fP object\.
  66. .P
  67. When such and override is performed, a warning is printed, explaining the
  68. conflict and the packages involved\. If \fB\-\-strict\-peer\-deps\fP is set, then
  69. this warning is treated as a failure\.
  70. <!\-\- automatically generated, do not edit manually \-\->
  71. <!\-\- see lib/utils/config/definitions\.js \-\->
  72. .SS \fBpackage\-lock\fP
  73. .RS 0
  74. .IP \(bu 2
  75. Default: true
  76. .IP \(bu 2
  77. Type: Boolean
  78. .RE
  79. .P
  80. If set to false, then ignore \fBpackage\-lock\.json\fP files when installing\. This
  81. will also prevent \fIwriting\fR \fBpackage\-lock\.json\fP if \fBsave\fP is true\.
  82. .P
  83. When package package\-locks are disabled, automatic pruning of extraneous
  84. modules will also be disabled\. To remove extraneous modules with
  85. package\-locks disabled use \fBnpm prune\fP\|\.
  86. <!\-\- automatically generated, do not edit manually \-\->
  87. <!\-\- see lib/utils/config/definitions\.js \-\->
  88. .SS \fBomit\fP
  89. .RS 0
  90. .IP \(bu 2
  91. Default: 'dev' if the \fBNODE_ENV\fP environment variable is set to
  92. \|'production', otherwise empty\.
  93. .IP \(bu 2
  94. Type: "dev", "optional", or "peer" (can be set multiple times)
  95. .RE
  96. .P
  97. Dependency types to omit from the installation tree on disk\.
  98. .P
  99. Note that these dependencies \fIare\fR still resolved and added to the
  100. \fBpackage\-lock\.json\fP or \fBnpm\-shrinkwrap\.json\fP file\. They are just not
  101. physically installed on disk\.
  102. .P
  103. If a package type appears in both the \fB\-\-include\fP and \fB\-\-omit\fP lists, then
  104. it will be included\.
  105. .P
  106. If the resulting omit list includes \fB\|'dev'\fP, then the \fBNODE_ENV\fP environment
  107. variable will be set to \fB\|'production'\fP for all lifecycle scripts\.
  108. <!\-\- automatically generated, do not edit manually \-\->
  109. <!\-\- see lib/utils/config/definitions\.js \-\->
  110. .SS \fBignore\-scripts\fP
  111. .RS 0
  112. .IP \(bu 2
  113. Default: false
  114. .IP \(bu 2
  115. Type: Boolean
  116. .RE
  117. .P
  118. If true, npm does not run scripts specified in package\.json files\.
  119. .P
  120. Note that commands explicitly intended to run a particular script, such as
  121. \fBnpm start\fP, \fBnpm stop\fP, \fBnpm restart\fP, \fBnpm test\fP, and \fBnpm run\-script\fP
  122. will still run their intended script if \fBignore\-scripts\fP is set, but they
  123. will \fInot\fR run any pre\- or post\-scripts\.
  124. <!\-\- automatically generated, do not edit manually \-\->
  125. <!\-\- see lib/utils/config/definitions\.js \-\->
  126. .SS \fBaudit\fP
  127. .RS 0
  128. .IP \(bu 2
  129. Default: true
  130. .IP \(bu 2
  131. Type: Boolean
  132. .RE
  133. .P
  134. When "true" submit audit reports alongside the current npm command to the
  135. default registry and all registries configured for scopes\. See the
  136. documentation for npm help \fBaudit\fP for details on what is
  137. submitted\.
  138. <!\-\- automatically generated, do not edit manually \-\->
  139. <!\-\- see lib/utils/config/definitions\.js \-\->
  140. .SS \fBbin\-links\fP
  141. .RS 0
  142. .IP \(bu 2
  143. Default: true
  144. .IP \(bu 2
  145. Type: Boolean
  146. .RE
  147. .P
  148. Tells npm to create symlinks (or \fB\|\.cmd\fP shims on Windows) for package
  149. executables\.
  150. .P
  151. Set to false to have it not do this\. This can be used to work around the
  152. fact that some file systems don't support symlinks, even on ostensibly Unix
  153. systems\.
  154. <!\-\- automatically generated, do not edit manually \-\->
  155. <!\-\- see lib/utils/config/definitions\.js \-\->
  156. .SS \fBfund\fP
  157. .RS 0
  158. .IP \(bu 2
  159. Default: true
  160. .IP \(bu 2
  161. Type: Boolean
  162. .RE
  163. .P
  164. When "true" displays the message at the end of each \fBnpm install\fP
  165. acknowledging the number of dependencies looking for funding\. See npm help \fBnpm
  166. fund\fP for details\.
  167. <!\-\- automatically generated, do not edit manually \-\->
  168. <!\-\- see lib/utils/config/definitions\.js \-\->
  169. .SS \fBworkspace\fP
  170. .RS 0
  171. .IP \(bu 2
  172. Default:
  173. .IP \(bu 2
  174. Type: String (can be set multiple times)
  175. .RE
  176. .P
  177. Enable running a command in the context of the configured workspaces of the
  178. current project while filtering by running only the workspaces defined by
  179. this configuration option\.
  180. .P
  181. Valid values for the \fBworkspace\fP config are either:
  182. .RS 0
  183. .IP \(bu 2
  184. Workspace names
  185. .IP \(bu 2
  186. Path to a workspace directory
  187. .IP \(bu 2
  188. Path to a parent workspace directory (will result in selecting all
  189. workspaces within that folder)
  190. .RE
  191. .P
  192. When set for the \fBnpm init\fP command, this may be set to the folder of a
  193. workspace which does not yet exist, to create the folder and set it up as a
  194. brand new workspace within the project\.
  195. .P
  196. This value is not exported to the environment for child processes\.
  197. <!\-\- automatically generated, do not edit manually \-\->
  198. <!\-\- see lib/utils/config/definitions\.js \-\->
  199. .SS \fBworkspaces\fP
  200. .RS 0
  201. .IP \(bu 2
  202. Default: null
  203. .IP \(bu 2
  204. Type: null or Boolean
  205. .RE
  206. .P
  207. Set to true to run the command in the context of \fBall\fR configured
  208. workspaces\.
  209. .P
  210. Explicitly setting this to false will cause commands like \fBinstall\fP to
  211. ignore workspaces altogether\. When not set explicitly:
  212. .RS 0
  213. .IP \(bu 2
  214. Commands that operate on the \fBnode_modules\fP tree (install, update, etc\.)
  215. will link workspaces into the \fBnode_modules\fP folder\. \- Commands that do
  216. other things (test, exec, publish, etc\.) will operate on the root project,
  217. \fIunless\fR one or more workspaces are specified in the \fBworkspace\fP config\.
  218. .RE
  219. .P
  220. This value is not exported to the environment for child processes\.
  221. <!\-\- automatically generated, do not edit manually \-\->
  222. <!\-\- see lib/utils/config/definitions\.js \-\->
  223. .SS \fBinclude\-workspace\-root\fP
  224. .RS 0
  225. .IP \(bu 2
  226. Default: false
  227. .IP \(bu 2
  228. Type: Boolean
  229. .RE
  230. .P
  231. Include the workspace root when workspaces are enabled for a command\.
  232. .P
  233. When false, specifying individual workspaces via the \fBworkspace\fP config, or
  234. all workspaces via the \fBworkspaces\fP flag, will cause npm to operate only on
  235. the specified workspaces, and not on the root project\.
  236. <!\-\- automatically generated, do not edit manually \-\->
  237. <!\-\- see lib/utils/config/definitions\.js \-\->
  238. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
  239. .SS See Also
  240. .RS 0
  241. .IP \(bu 2
  242. npm help dedupe
  243. .IP \(bu 2
  244. npm help ls
  245. .IP \(bu 2
  246. npm help update
  247. .IP \(bu 2
  248. npm help install
  249. .RE