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