@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
dhei/classic-tokens
@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 240 lines 9.21 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/v10
7 github_path: docs/lib/content/commands/npm-dedupe.md
8 redirect_from:
9 - /cli-documentation/v10/cli-commands/dedupe
10 - /cli-documentation/v10/cli-commands/npm-dedupe
11 - /cli-documentation/v10/commands/dedupe
12 - /cli-documentation/v10/commands/npm-dedupe
13 - /cli-documentation/v10/dedupe
14 - /cli-documentation/v10/npm-dedupe
15 - /cli/v10/cli-commands/dedupe
16 - /cli/v10/cli-commands/npm-dedupe
17 - /cli/v10/commands/dedupe
18 - /cli/v10/dedupe
19 - /cli/v10/npm-dedupe
20 ---
21
22 ### Synopsis
23
24 ```bash
25 npm dedupe
26
27 alias: ddp
28 ```
29
30 ### Description
31
32 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.
33
34 For example, consider this dependency graph:
35
36 ```
37 a
38 +-- b <-- depends on c@1.0.x
39 | `-- c@1.0.3
40 `-- d <-- depends on c@~1.0.9
41 `-- c@1.0.10
42 ```
43
44 In this case, `npm dedupe` will transform the tree to:
45
46 ```bash
47 a
48 +-- b
49 +-- d
50 `-- c@1.0.10
51 ```
52
53 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.
54
55 In some cases, you may have a dependency graph like this:
56
57 ```
58 a
59 +-- b <-- depends on c@1.0.x
60 +-- c@1.0.3
61 `-- d <-- depends on c@1.x
62 `-- c@1.9.9
63 ```
64
65 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.
66
67 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.
68
69 To prefer deduplication over novelty during the installation process, run `npm install --prefer-dedupe` or `npm config set prefer-dedupe true`.
70
71 Arguments are ignored. Dedupe always acts on the entire tree.
72
73 Note that this operation transforms the dependency tree, but will never result in new modules being installed.
74
75 Using `npm find-dupes` will run the command in `--dry-run` mode.
76
77 Note: `npm dedupe` will never update the semver values of direct dependencies in your project `package.json`, if you want to update values in `package.json` you can run: `npm update --save` instead.
78
79 ### Configuration
80
81 #### `install-strategy`
82
83 - Default: "hoisted"
84 - Type: "hoisted", "nested", "shallow", or "linked"
85
86 Sets the strategy for installing packages in node_modules. hoisted (default): Install non-duplicated in top-level, and duplicated as necessary within directory structure. nested: (formerly --legacy-bundling) install in place, no hoisting. shallow (formerly --global-style) only install direct deps at top-level. linked: (experimental) install in node_modules/.store, link in place, unhoisted.
87
88 #### `legacy-bundling`
89
90 - Default: false
91 - Type: Boolean
92 - DEPRECATED: This option has been deprecated in favor of `--install-strategy=nested`
93
94 Instead of hoisting package installs in `node_modules`, install packages in the same manner that they are depended on. This may cause very deep directory structures and duplicate package installs as there is no de-duplicating. Sets `--install-strategy=nested`.
95
96 #### `global-style`
97
98 - Default: false
99 - Type: Boolean
100 - DEPRECATED: This option has been deprecated in favor of `--install-strategy=shallow`
101
102 Only install direct dependencies in the top level `node_modules`, but hoist on deeper dependencies. Sets `--install-strategy=shallow`.
103
104 #### `strict-peer-deps`
105
106 - Default: false
107 - Type: Boolean
108
109 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.
110
111 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.
112
113 When such an 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.
114
115 #### `package-lock`
116
117 - Default: true
118 - Type: Boolean
119
120 If set to false, then ignore `package-lock.json` files when installing. This will also prevent _writing_ `package-lock.json` if `save` is true.
121
122 #### `omit`
123
124 - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
125 - Type: "dev", "optional", or "peer" (can be set multiple times)
126
127 Dependency types to omit from the installation tree on disk.
128
129 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.
130
131 If a package type appears in both the `--include` and `--omit` lists, then it will be included.
132
133 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts.
134
135 #### `include`
136
137 - Default:
138 - Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
139
140 Option that allows for defining which types of dependencies to install.
141
142 This is the inverse of `--omit=<type>`.
143
144 Dependency types specified in `--include` will not be omitted, regardless of the order in which omit/include are specified on the command-line.
145
146 #### `ignore-scripts`
147
148 - Default: false
149 - Type: Boolean
150
151 If true, npm does not run scripts specified in package.json files.
152
153 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.
154
155 #### `audit`
156
157 - Default: true
158 - Type: Boolean
159
160 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/v10/commands/npm-audit) for details on what is submitted.
161
162 #### `bin-links`
163
164 - Default: true
165 - Type: Boolean
166
167 Tells npm to create symlinks (or `.cmd` shims on Windows) for package executables.
168
169 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.
170
171 #### `fund`
172
173 - Default: true
174 - Type: Boolean
175
176 When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v10/commands/npm-fund) for details.
177
178 #### `dry-run`
179
180 - Default: false
181 - Type: Boolean
182
183 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`.
184
185 Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
186
187 #### `workspace`
188
189 - Default:
190 - Type: String (can be set multiple times)
191
192 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.
193
194 Valid values for the `workspace` config are either:
195
196 - Workspace names
197 - Path to a workspace directory
198 - Path to a parent workspace directory (will result in selecting all workspaces within that folder)
199
200 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.
201
202 This value is not exported to the environment for child processes.
203
204 #### `workspaces`
205
206 - Default: null
207 - Type: null or Boolean
208
209 Set to true to run the command in the context of **all** configured workspaces.
210
211 Explicitly setting this to false will cause commands like `install` to ignore workspaces altogether. When not set explicitly:
212
213 - 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.
214
215 This value is not exported to the environment for child processes.
216
217 #### `include-workspace-root`
218
219 - Default: false
220 - Type: Boolean
221
222 Include the workspace root when workspaces are enabled for a command.
223
224 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.
225
226 This value is not exported to the environment for child processes.
227
228 #### `install-links`
229
230 - Default: false
231 - Type: Boolean
232
233 When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.
234
235 ### See Also
236
237 - [npm find-dupes](/cli/v10/commands/npm-find-dupes)
238 - [npm ls](/cli/v10/commands/npm-ls)
239 - [npm update](/cli/v10/commands/npm-update)
240 - [npm install](/cli/v10/commands/npm-install)