@cryptotaxi247 / documentation
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 222 lines 8.5 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/v8
7 github_path: docs/lib/content/commands/npm-dedupe.md
8 redirect_from:
9 - /cli-documentation/v8/cli-commands/dedupe
10 - /cli-documentation/v8/cli-commands/npm-dedupe
11 - /cli-documentation/v8/commands/dedupe
12 - /cli-documentation/v8/commands/npm-dedupe
13 - /cli-documentation/v8/dedupe
14 - /cli-documentation/v8/npm-dedupe
15 - /cli/v8/cli-commands/dedupe
16 - /cli/v8/cli-commands/npm-dedupe
17 - /cli/v8/commands/dedupe
18 - /cli/v8/dedupe
19 - /cli/v8/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 #### `global-style`
82
83 - Default: false
84 - Type: Boolean
85
86 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.
87
88 #### `legacy-bundling`
89
90 - Default: false
91 - Type: Boolean
92
93 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.
94
95 #### `strict-peer-deps`
96
97 - Default: false
98 - Type: Boolean
99
100 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.
101
102 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.
103
104 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.
105
106 #### `package-lock`
107
108 - Default: true
109 - Type: Boolean
110
111 If set to false, then ignore `package-lock.json` files when installing. This will also prevent _writing_ `package-lock.json` if `save` is true.
112
113 This configuration does not affect `npm ci`.
114
115 #### `omit`
116
117 - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
118 - Type: "dev", "optional", or "peer" (can be set multiple times)
119
120 Dependency types to omit from the installation tree on disk.
121
122 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.
123
124 If a package type appears in both the `--include` and `--omit` lists, then it will be included.
125
126 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts.
127
128 #### `ignore-scripts`
129
130 - Default: false
131 - Type: Boolean
132
133 If true, npm does not run scripts specified in package.json files.
134
135 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.
136
137 #### `audit`
138
139 - Default: true
140 - Type: Boolean
141
142 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/v8/commands/npm-audit) for details on what is submitted.
143
144 #### `bin-links`
145
146 - Default: true
147 - Type: Boolean
148
149 Tells npm to create symlinks (or `.cmd` shims on Windows) for package executables.
150
151 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.
152
153 #### `fund`
154
155 - Default: true
156 - Type: Boolean
157
158 When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v8/commands/npm-fund) for details.
159
160 #### `dry-run`
161
162 - Default: false
163 - Type: Boolean
164
165 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`.
166
167 Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
168
169 #### `workspace`
170
171 - Default:
172 - Type: String (can be set multiple times)
173
174 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.
175
176 Valid values for the `workspace` config are either:
177
178 - Workspace names
179 - Path to a workspace directory
180 - Path to a parent workspace directory (will result in selecting all workspaces within that folder)
181
182 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.
183
184 This value is not exported to the environment for child processes.
185
186 #### `workspaces`
187
188 - Default: null
189 - Type: null or Boolean
190
191 Set to true to run the command in the context of **all** configured workspaces.
192
193 Explicitly setting this to false will cause commands like `install` to ignore workspaces altogether. When not set explicitly:
194
195 - 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.
196
197 This value is not exported to the environment for child processes.
198
199 #### `include-workspace-root`
200
201 - Default: false
202 - Type: Boolean
203
204 Include the workspace root when workspaces are enabled for a command.
205
206 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.
207
208 This value is not exported to the environment for child processes.
209
210 #### `install-links`
211
212 - Default: false
213 - Type: Boolean
214
215 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.
216
217 ### See Also
218
219 - [npm find-dupes](/cli/v8/commands/npm-find-dupes)
220 - [npm ls](/cli/v8/commands/npm-ls)
221 - [npm update](/cli/v8/commands/npm-update)
222 - [npm install](/cli/v8/commands/npm-install)