@@ -84,15 +84,129 @@ cache:
8484<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
8585<!-- automatically generated, do not edit manually -->
8686<!-- see lib/utils/config/definitions.js -->
87- #### ` audit `
87+ #### ` save `
88+
89+ * Default: ` true ` unless when using ` npm update ` where it defaults to ` false `
90+ * Type: Boolean
91+
92+ Save installed packages to a ` package.json ` file as dependencies.
93+
94+ When used with the ` npm rm ` command, removes the dependency from
95+ ` package.json ` .
96+
97+ Will also prevent writing to ` package-lock.json ` if set to ` false ` .
98+
99+ <!-- automatically generated, do not edit manually -->
100+ <!-- see lib/utils/config/definitions.js -->
101+
102+ #### ` save-exact `
103+
104+ * Default: false
105+ * Type: Boolean
106+
107+ Dependencies saved to package.json will be configured with an exact version
108+ rather than using npm's default semver range operator.
109+
110+ <!-- automatically generated, do not edit manually -->
111+ <!-- see lib/utils/config/definitions.js -->
112+
113+ #### ` global `
114+
115+ * Default: false
116+ * Type: Boolean
117+
118+ Operates in "global" mode, so that packages are installed into the ` prefix `
119+ folder instead of the current working directory. See
120+ [ folders] ( /configuring-npm/folders ) for more on the differences in behavior.
121+
122+ * packages are installed into the ` {prefix}/lib/node_modules ` folder, instead
123+ of the current working directory.
124+ * bin files are linked to ` {prefix}/bin `
125+ * man pages are linked to ` {prefix}/share/man `
126+
127+ <!-- automatically generated, do not edit manually -->
128+ <!-- see lib/utils/config/definitions.js -->
129+
130+ #### ` global-style `
131+
132+ * Default: false
133+ * Type: Boolean
134+
135+ Causes npm to install the package into your local ` node_modules ` folder with
136+ the same layout it uses with the global ` node_modules ` folder. Only your
137+ direct dependencies will show in ` node_modules ` and everything they depend
138+ on will be flattened in their ` node_modules ` folders. This obviously will
139+ eliminate some deduping. If used with ` legacy-bundling ` , ` legacy-bundling `
140+ will be preferred.
141+
142+ <!-- automatically generated, do not edit manually -->
143+ <!-- see lib/utils/config/definitions.js -->
144+
145+ #### ` legacy-bundling `
146+
147+ * Default: false
148+ * Type: Boolean
149+
150+ Causes npm to install the package such that versions of npm prior to 1.4,
151+ such as the one included with node 0.8, can install the package. This
152+ eliminates all automatic deduping. If used with ` global-style ` this option
153+ will be preferred.
154+
155+ <!-- automatically generated, do not edit manually -->
156+ <!-- see lib/utils/config/definitions.js -->
157+
158+ #### ` omit `
159+
160+ * Default: 'dev' if the ` NODE_ENV ` environment variable is set to
161+ 'production', otherwise empty.
162+ * Type: "dev", "optional", or "peer" (can be set multiple times)
163+
164+ Dependency types to omit from the installation tree on disk.
165+
166+ Note that these dependencies _ are_ still resolved and added to the
167+ ` package-lock.json ` or ` npm-shrinkwrap.json ` file. They are just not
168+ physically installed on disk.
169+
170+ If a package type appears in both the ` --include ` and ` --omit ` lists, then
171+ it will be included.
172+
173+ If the resulting omit list includes ` 'dev' ` , then the ` NODE_ENV ` environment
174+ variable will be set to ` 'production' ` for all lifecycle scripts.
175+
176+ <!-- automatically generated, do not edit manually -->
177+ <!-- see lib/utils/config/definitions.js -->
178+
179+ #### ` strict-peer-deps `
180+
181+ * Default: false
182+ * Type: Boolean
183+
184+ If set to ` true ` , and ` --legacy-peer-deps ` is not set, then _ any_
185+ conflicting ` peerDependencies ` will be treated as an install failure, even
186+ if npm could reasonably guess the appropriate resolution based on non-peer
187+ dependency relationships.
188+
189+ By default, conflicting ` peerDependencies ` deep in the dependency graph will
190+ be resolved using the nearest non-peer dependency specification, even if
191+ doing so will result in some packages receiving a peer dependency outside
192+ the range set in their package's ` peerDependencies ` object.
193+
194+ When such and override is performed, a warning is printed, explaining the
195+ conflict and the packages involved. If ` --strict-peer-deps ` is set, then
196+ this warning is treated as a failure.
197+
198+ <!-- automatically generated, do not edit manually -->
199+ <!-- see lib/utils/config/definitions.js -->
200+
201+ #### ` package-lock `
88202
89203* Default: true
90204* Type: Boolean
91205
92- When "true" submit audit reports alongside the current npm command to the
93- default registry and all registries configured for scopes. See the
94- documentation for [ ` npm audit ` ] ( /commands/npm-audit ) for details on what is
95- submitted .
206+ If set to false, then ignore ` package-lock.json ` files when installing. This
207+ will also prevent _ writing _ ` package-lock.json ` if ` save ` is true.
208+
209+ This configuration does not affect ` npm ci ` .
96210
97211<!-- automatically generated, do not edit manually -->
98212<!-- see lib/utils/config/definitions.js -->
@@ -127,13 +241,132 @@ will *not* run any pre- or post-scripts.
127241<!-- automatically generated, do not edit manually -->
128242<!-- see lib/utils/config/definitions.js -->
129243
130- #### ` script-shell `
244+ #### ` audit `
131245
132- * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
133- * Type: null or String
246+ * Default: true
247+ * Type: Boolean
248+
249+ When "true" submit audit reports alongside the current npm command to the
250+ default registry and all registries configured for scopes. See the
251+ documentation for [ ` npm audit ` ] ( /commands/npm-audit ) for details on what is
252+ submitted.
253+
254+ <!-- automatically generated, do not edit manually -->
255+ <!-- see lib/utils/config/definitions.js -->
256+
257+ #### ` bin-links `
258+
259+ * Default: true
260+ * Type: Boolean
261+
262+ Tells npm to create symlinks (or ` .cmd ` shims on Windows) for package
263+ executables.
264+
265+ Set to false to have it not do this. This can be used to work around the
266+ fact that some file systems don't support symlinks, even on ostensibly Unix
267+ systems.
268+
269+ <!-- automatically generated, do not edit manually -->
270+ <!-- see lib/utils/config/definitions.js -->
271+
272+ #### ` fund `
273+
274+ * Default: true
275+ * Type: Boolean
276+
277+ When "true" displays the message at the end of each ` npm install `
278+ acknowledging the number of dependencies looking for funding. See [ `npm
279+ fund`] ( /commands/npm-fund ) for details.
280+
281+ <!-- automatically generated, do not edit manually -->
282+ <!-- see lib/utils/config/definitions.js -->
283+
284+ #### ` dry-run `
285+
286+ * Default: false
287+ * Type: Boolean
288+
289+ Indicates that you don't want npm to make any changes and that it should
290+ only report what it would have done. This can be passed into any of the
291+ commands that modify your local installation, eg, ` install ` , ` update ` ,
292+ ` dedupe ` , ` uninstall ` , as well as ` pack ` and ` publish ` .
293+
294+ Note: This is NOT honored by other network related commands, eg ` dist-tags ` ,
295+ ` owner ` , etc.
296+
297+ <!-- automatically generated, do not edit manually -->
298+ <!-- see lib/utils/config/definitions.js -->
299+
300+ #### ` workspace `
301+
302+ * Default:
303+ * Type: String (can be set multiple times)
304+
305+ Enable running a command in the context of the configured workspaces of the
306+ current project while filtering by running only the workspaces defined by
307+ this configuration option.
308+
309+ Valid values for the ` workspace ` config are either:
310+
311+ * Workspace names
312+ * Path to a workspace directory
313+ * Path to a parent workspace directory (will result in selecting all
314+ workspaces within that folder)
315+
316+ When set for the ` npm init ` command, this may be set to the folder of a
317+ workspace which does not yet exist, to create the folder and set it up as a
318+ brand new workspace within the project.
319+
320+ This value is not exported to the environment for child processes.
321+
322+ <!-- automatically generated, do not edit manually -->
323+ <!-- see lib/utils/config/definitions.js -->
324+
325+ #### ` workspaces `
326+
327+ * Default: null
328+ * Type: null or Boolean
329+
330+ Set to true to run the command in the context of ** all** configured
331+ workspaces.
332+
333+ Explicitly setting this to false will cause commands like ` install ` to
334+ ignore workspaces altogether. When not set explicitly:
335+
336+ - Commands that operate on the ` node_modules ` tree (install, update, etc.)
337+ will link workspaces into the ` node_modules ` folder. - Commands that do
338+ other things (test, exec, publish, etc.) will operate on the root project,
339+ _ unless_ one or more workspaces are specified in the ` workspace ` config.
340+
341+ This value is not exported to the environment for child processes.
342+
343+ <!-- automatically generated, do not edit manually -->
344+ <!-- see lib/utils/config/definitions.js -->
345+
346+ #### ` include-workspace-root `
347+
348+ * Default: false
349+ * Type: Boolean
350+
351+ Include the workspace root when workspaces are enabled for a command.
352+
353+ When false, specifying individual workspaces via the ` workspace ` config, or
354+ all workspaces via the ` workspaces ` flag, will cause npm to operate only on
355+ the specified workspaces, and not on the root project.
356+
357+ This value is not exported to the environment for child processes.
358+
359+ <!-- automatically generated, do not edit manually -->
360+ <!-- see lib/utils/config/definitions.js -->
361+
362+ #### ` install-links `
363+
364+ * Default: false
365+ * Type: Boolean
134366
135- The shell to use for scripts run with the ` npm exec ` , ` npm run ` and `npm
136- init <package-spec >` commands.
367+ When set file: protocol dependencies that exist outside of the project root
368+ will be packed and installed as regular dependencies instead of creating a
369+ symlink. This option has no effect on workspaces.
137370
138371<!-- automatically generated, do not edit manually -->
139372<!-- see lib/utils/config/definitions.js -->
0 commit comments