@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
kartykp/upgrade-path-to-regex
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 199 lines 7.36 KB
Raw
1 ---
2 title: npm-dedupe
3 section: 1
4 description: Reduce duplication in the package tree
5 github_repo: npm/cli
6 github_branch: release/v7
7 github_path: docs/content/commands/npm-dedupe.md
8 redirect_from:
9 - /cli-documentation/v7/cli-commands/dedupe
10 - /cli-documentation/v7/cli-commands/npm-dedupe
11 - /cli-documentation/v7/commands/dedupe
12 - /cli-documentation/v7/commands/npm-dedupe
13 - /cli-documentation/v7/dedupe
14 - /cli-documentation/v7/npm-dedupe
15 - /cli/v7/cli-commands/dedupe
16 - /cli/v7/cli-commands/npm-dedupe
17 - /cli/v7/commands/dedupe
18 - /cli/v7/dedupe
19 - /cli/v7/npm-dedupe
20 ---
21
22 ### Synopsis
23
24 ```bash
25 npm dedupe
26 npm ddp
27
28 aliases: ddp
29 ```
30
31 ### Description
32
33 Searches the local package tree and attempts to simplify the overall structure by moving dependencies further up the tree, where they can be more effectively shared by multiple dependent packages.
34
35 For example, consider this dependency graph:
36
37 ```
38 a
39 +-- b <-- depends on c@1.0.x
40 | `-- c@1.0.3
41 `-- d <-- depends on c@~1.0.9
42 `-- c@1.0.10
43 ```
44
45 In this case, `npm dedupe` will transform the tree to:
46
47 ```bash
48 a
49 +-- b
50 +-- d
51 `-- c@1.0.10
52 ```
53
54 Because of the hierarchical nature of node's module lookup, b and d will both get their dependency met by the single c package at the root level of the tree.
55
56 In some cases, you may have a dependency graph like this:
57
58 ```
59 a
60 +-- b <-- depends on c@1.0.x
61 +-- c@1.0.3
62 `-- d <-- depends on c@1.x
63 `-- c@1.9.9
64 ```
65
66 During the installation process, the `c@1.0.3` dependency for `b` was placed in the root of the tree. Though `d`'s dependency on `c@1.x` could have been satisfied by `c@1.0.3`, the newer `c@1.9.0` dependency was used, because npm favors updates by default, even when doing so causes duplication.
67
68 Running `npm dedupe` will cause npm to note the duplication and re-evaluate, deleting the nested `c` module, because the one in the root is sufficient.
69
70 To prefer deduplication over novelty during the installation process, run `npm install --prefer-dedupe` or `npm config set prefer-dedupe true`.
71
72 Arguments are ignored. Dedupe always acts on the entire tree.
73
74 Note that this operation transforms the dependency tree, but will never result in new modules being installed.
75
76 Using `npm find-dupes` will run the command in `--dry-run` mode.
77
78 ### Configuration
79
80 #### `global-style`
81
82 - Default: false
83 - Type: Boolean
84
85 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 obviously will eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling` will be preferred.
86
87 #### `legacy-bundling`
88
89 - Default: false
90 - Type: Boolean
91
92 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.
93
94 #### `strict-peer-deps`
95
96 - Default: false
97 - Type: Boolean
98
99 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.
100
101 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 dependency outside the range set in their package's `peerDependencies` object.
102
103 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.
104
105 #### `package-lock`
106
107 - Default: true
108 - Type: Boolean
109
110 If set to false, then ignore `package-lock.json` files when installing. This will also prevent _writing_ `package-lock.json` if `save` is true.
111
112 When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`.
113
114 #### `omit`
115
116 - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
117 - Type: "dev", "optional", or "peer" (can be set multiple times)
118
119 Dependency types to omit from the installation tree on disk.
120
121 Note that these dependencies _are_ still resolved and added to the `package-lock.json` or `npm-shrinkwrap.json` file. They are just not physically installed on disk.
122
123 If a package type appears in both the `--include` and `--omit` lists, then it will be included.
124
125 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts.
126
127 #### `ignore-scripts`
128
129 - Default: false
130 - Type: Boolean
131
132 If true, npm does not run scripts specified in package.json files.
133
134 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.
135
136 #### `audit`
137
138 - Default: true
139 - Type: Boolean
140
141 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 audit`](/cli/v7/commands/npm-audit) for details on what is submitted.
142
143 #### `bin-links`
144
145 - Default: true
146 - Type: Boolean
147
148 Tells npm to create symlinks (or `.cmd` shims on Windows) for package executables.
149
150 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 ostensibly Unix systems.
151
152 #### `fund`
153
154 - Default: true
155 - Type: Boolean
156
157 When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v7/commands/npm-fund) for details.
158
159 #### `dry-run`
160
161 - Default: false
162 - Type: Boolean
163
164 Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, `install`, `update`, `dedupe`, `uninstall`, as well as `pack` and `publish`.
165
166 Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
167
168 #### `workspace`
169
170 - Default:
171 - Type: String (can be set multiple times)
172
173 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.
174
175 Valid values for the `workspace` config are either:
176
177 - Workspace names
178 - Path to a workspace directory
179 - Path to a parent workspace directory (will result to selecting all of the nested workspaces)
180
181 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.
182
183 This value is not exported to the environment for child processes.
184
185 #### `workspaces`
186
187 - Default: false
188 - Type: Boolean
189
190 Enable running a command in the context of **all** the configured workspaces.
191
192 This value is not exported to the environment for child processes.
193
194 ### See Also
195
196 - [npm find-dupes](/cli/v7/commands/npm-find-dupes)
197 - [npm ls](/cli/v7/commands/npm-ls)
198 - [npm update](/cli/v7/commands/npm-update)
199 - [npm install](/cli/v7/commands/npm-install)