Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

npm-find-dupes (1)

Name

npm-find-dupes - Find duplication in the package tree Synopsis npm find-dupes Description Runs npm dedupe in --dry-run mode, making npm only output the duplica- tions, without actually changing the package tree. Configuration global-style o Default: false o Type: Boolean Causes npm to install the package into your local node_modules folder with the same layout it uses with the global node_modules folder. Only your direct dependencies will show in node_modules and everything they depend on will be flattened in their node_modules folders. This obvi- ously will eliminate some deduping. If used with legacy-bundling, legacy-bundling will be preferred. legacy-bundling o Default: false o Type: Boolean Causes npm to install the package such that versions of npm prior to 1.4, such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with global-style this option will be preferred. strict-peer-deps o Default: false o Type: Boolean If set to true, and --legacy-peer-deps is not set, then any conflicting peerDependencies will be treated as an install failure, even if npm could reasonably guess the appropriate resolution based on non-peer dependency relationships. By default, conflicting peerDependencies deep in the dependency graph will be resolved using the nearest non-peer dependency specification, even if doing so will result in some packages receiving a peer depen- dency outside the range set in their package's peerDependencies object. When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If --strict-peer-deps is set, then this warning is treated as a failure. package-lock o Default: true o Type: Boolean If set to false, then ignore package-lock.json files when installing. This will also prevent writing package-lock.json if save is true. When package package-locks are disabled, automatic pruning of extrane- ous modules will also be disabled. To remove extraneous modules with package-locks disabled use npm prune. This configuration does not affect npm ci. omit o Default: 'dev' if the NODE_ENV environment variable is set to 'pro- duction', otherwise empty. o Type: "dev", "optional", or "peer" (can be set multiple times) Dependency types to omit from the installation tree on disk. Note that these dependencies are still resolved and added to the pack- age-lock.json or npm-shrinkwrap.json file. They are just not physically installed on disk. If a package type appears in both the --include and --omit lists, then it will be included. If the resulting omit list includes 'dev', then the NODE_ENV environ- ment variable will be set to 'production' for all lifecycle scripts. ignore-scripts o Default: false o Type: Boolean If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as npm start, npm stop, npm restart, npm test, and npm run-script will still run their intended script if ignore-scripts is set, but they will not run any pre- or post-scripts. audit o Default: true o Type: Boolean When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for npm help audit for details on what is submitted. bin-links o Default: true o Type: Boolean Tells npm to create symlinks (or .cmd shims on Windows) for package executables. Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on osten- sibly Unix systems. fund o Default: true o Type: Boolean When "true" displays the message at the end of each npm install acknowledging the number of dependencies looking for funding. See npm help npm fund for details. workspace o Default: o Type: String (can be set multiple times) Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option. Valid values for the workspace config are either: o Workspace names o Path to a workspace directory o Path to a parent workspace directory (will result in selecting all workspaces within that folder) When set for the npm init command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project. This value is not exported to the environment for child processes. workspaces o Default: null o Type: null or Boolean Set to true to run the command in the context of all configured workspaces. Explicitly setting this to false will cause commands like install to ignore workspaces altogether. When not set explicitly: o Commands that operate on the node_modules tree (install, update, etc.) will link workspaces into the node_modules folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, unless one or more workspaces are specified in the workspace config. This value is not exported to the environment for child processes. include-workspace-root o Default: false o Type: Boolean Include the workspace root when workspaces are enabled for a command. When false, specifying individual workspaces via the workspace config, or all workspaces via the workspaces flag, will cause npm to operate only on the specified workspaces, and not on the root project. This value is not exported to the environment for child processes. install-links o Default: false o Type: Boolean When set file: protocol dependencies that exist outside of the project root will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces. See Also o npm help dedupe o npm help ls o npm help update o npm help install

Synopsis

Please see following description for synopsis

Description

NPM-FIND-DUPES(1)                                            NPM-FIND-DUPES(1)



NAME
       npm-find-dupes - Find duplication in the package tree

   Synopsis
         npm find-dupes

   Description
       Runs  npm dedupe in --dry-run mode, making npm only output the duplica-
       tions, without actually changing the package tree.

   Configuration
   global-style
       o Default: false

       o Type: Boolean


       Causes npm to install the package into your local  node_modules  folder
       with  the same layout it uses with the global node_modules folder. Only
       your direct dependencies will show in node_modules and everything  they
       depend  on  will be flattened in their node_modules folders. This obvi-
       ously will eliminate  some  deduping.  If  used  with  legacy-bundling,
       legacy-bundling will be preferred.

   legacy-bundling
       o Default: false

       o Type: Boolean


       Causes  npm  to  install the package such that versions of npm prior to
       1.4, such as the one included with node 0.8, can install  the  package.
       This  eliminates all automatic deduping. If used with global-style this
       option will be preferred.

   strict-peer-deps
       o Default: false

       o Type: Boolean


       If set to true, and --legacy-peer-deps is not set, then any conflicting
       peerDependencies  will  be  treated  as an install failure, even if npm
       could reasonably guess the appropriate  resolution  based  on  non-peer
       dependency relationships.

       By  default,  conflicting peerDependencies deep in the dependency graph
       will be resolved using the nearest non-peer  dependency  specification,
       even  if  doing so will result in some packages receiving a peer depen-
       dency outside the range set in their package's peerDependencies object.

       When such and override is performed, a warning is  printed,  explaining
       the  conflict  and the packages involved. If --strict-peer-deps is set,
       then this warning is treated as a failure.

   package-lock
       o Default: true

       o Type: Boolean


       If set to false, then ignore package-lock.json files  when  installing.
       This will also prevent writing package-lock.json if save is true.

       When  package package-locks are disabled, automatic pruning of extrane-
       ous modules will also be disabled. To remove  extraneous  modules  with
       package-locks disabled use npm prune.

       This configuration does not affect npm ci.

   omit
       o Default:  'dev'  if the NODE_ENV environment variable is set to 'pro-
         duction', otherwise empty.

       o Type: "dev", "optional", or "peer" (can be set multiple times)


       Dependency types to omit from the installation tree on disk.

       Note that these dependencies are still resolved and added to the  pack-
       age-lock.json or npm-shrinkwrap.json file. They are just not physically
       installed on disk.

       If a package type appears in both the --include and --omit lists,  then
       it will be included.

       If  the  resulting omit list includes 'dev', then the NODE_ENV environ-
       ment variable will be set to 'production' for all lifecycle scripts.

   ignore-scripts
       o Default: false

       o Type: Boolean


       If true, npm does not run scripts specified in package.json files.

       Note that commands explicitly intended to run a particular script, such
       as  npm start, npm stop, npm restart, npm test, and npm run-script will
       still run their intended script if ignore-scripts is set, but they will
       not run any pre- or post-scripts.

   audit
       o Default: true

       o Type: Boolean


       When  "true"  submit audit reports alongside the current npm command to
       the default registry and all registries configured for scopes. See  the
       documentation for npm help audit for details on what is submitted.

   bin-links
       o Default: true

       o Type: Boolean


       Tells  npm  to  create  symlinks (or .cmd shims on Windows) for package
       executables.

       Set to false to have it not do this. This can be used  to  work  around
       the  fact that some file systems don't support symlinks, even on osten-
       sibly Unix systems.

   fund
       o Default: true

       o Type: Boolean


       When "true" displays the  message  at  the  end  of  each  npm  install
       acknowledging  the  number of dependencies looking for funding. See npm
       help npm fund for details.

   workspace
       o Default:

       o Type: String (can be set multiple times)


       Enable running a command in the context of the configured workspaces of
       the  current  project  while  filtering  by running only the workspaces
       defined by this configuration option.

       Valid values for the workspace config are either:

       o Workspace names

       o Path to a workspace directory

       o Path to a parent workspace directory (will result  in  selecting  all
         workspaces within that folder)


       When  set  for the npm init command, this may be set to the folder of a
       workspace which does not yet exist, to create the folder and set it  up
       as a brand new workspace within the project.

       This value is not exported to the environment for child processes.

   workspaces
       o Default: null

       o Type: null or Boolean


       Set  to  true  to  run  the  command  in  the context of all configured
       workspaces.

       Explicitly setting this to false will cause commands  like  install  to
       ignore workspaces altogether. When not set explicitly:

       o Commands  that  operate  on  the  node_modules tree (install, update,
         etc.)  will link workspaces into the node_modules folder. -  Commands
         that  do other things (test, exec, publish, etc.) will operate on the
         root project, unless one or more  workspaces  are  specified  in  the
         workspace config.


       This value is not exported to the environment for child processes.

   include-workspace-root
       o Default: false

       o Type: Boolean


       Include the workspace root when workspaces are enabled for a command.

       When  false, specifying individual workspaces via the workspace config,
       or all workspaces via the workspaces flag, will cause  npm  to  operate
       only on the specified workspaces, and not on the root project.

       This value is not exported to the environment for child processes.

   install-links
       o Default: false

       o Type: Boolean


       When  set file: protocol dependencies that exist outside of the project
       root will be packed and installed as regular  dependencies  instead  of
       creating a symlink. This option has no effect on workspaces.

   See Also
       o npm help dedupe

       o npm help ls

       o npm help update

       o npm help install




ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | runtime/nodejs/nodejs-18 |
       +---------------+--------------------------+
       |Stability      | Pass-thru volatile       |
       +---------------+--------------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was   downloaded   from    https://github.com/nodejs/node/ar-
       chive/v18.1.0.zip.

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                  April 2022                 NPM-FIND-DUPES(1)