@@ -206,8 +206,8 @@ $ npm audit --audit-level=moderate
206206* Default: null
207207* Type: null, "info", "low", "moderate", "high", "critical", or "none"
208208
209- The minimum level of vulnerability for `npm audit` to exit with a
210- non-zero exit code.
209+ The minimum level of vulnerability for `npm audit` to exit with a non-zero
210+ exit code.
211211
212212
213213
@@ -216,14 +216,13 @@ non-zero exit code.
216216* Default: false
217217* Type: Boolean
218218
219- Indicates that you don't want npm to make any changes and that it
220- should only report what it would have done. This can be passed into
221- any of the commands that modify your local installation, eg,
222- `install`, `update`, `dedupe`, `uninstall`, as well as `pack` and
223- `publish`.
219+ Indicates that you don't want npm to make any changes and that it should
220+ only report what it would have done. This can be passed into any of the
221+ commands that modify your local installation, eg, `install`, `update`,
222+ `dedupe`, `uninstall`, as well as `pack` and `publish`.
224223
225- Note: This is NOT honored by other network related commands, eg
226- `dist-tags`, ` owner`, etc.
224+ Note: This is NOT honored by other network related commands, eg `dist-tags`,
225+ `owner`, etc.
227226
228227
229228
@@ -238,16 +237,14 @@ mistakes, unnecessary performance degradation, and malicious input.
238237* Allow clobbering non-npm files in global installs.
239238* Allow the `npm version` command to work on an unclean git repository.
240239* Allow deleting the cache folder with `npm cache clean`.
241- * Allow installing packages that have an `engines` declaration
242- requiring a different version of npm.
243- * Allow installing packages that have an `engines` declaration
244- requiring a different version of `node`, even if `--engine-strict` is
245- enabled.
246- * Allow `npm audit fix` to install modules outside your stated
247- dependency range (including SemVer-major changes).
240+ * Allow installing packages that have an `engines` declaration requiring a
241+ different version of npm.
242+ * Allow installing packages that have an `engines` declaration requiring a
243+ different version of `node`, even if `--engine-strict` is enabled.
244+ * Allow `npm audit fix` to install modules outside your stated dependency
245+ range (including SemVer-major changes).
248246* Allow unpublishing all versions of a published package.
249- * Allow conflicting peerDependencies to be installed in the root
250- project.
247+ * Allow conflicting peerDependencies to be installed in the root project.
251248* Implicitly set `--yes` during `npm init`.
252249* Allow clobbering existing values in `npm pkg`
253250* Allow unpublishing of entire packages (not just a single version).
@@ -264,8 +261,8 @@ recommended that you do not use this option!
264261
265262Whether or not to output JSON data, rather than the normal output.
266263
267- * In `npm pkg set` it enables parsing set values with JSON.parse()
268- before saving them to your `package.json`.
264+ * In `npm pkg set` it enables parsing set values with JSON.parse() before
265+ saving them to your `package.json`.
269266
270267Not supported by all npm commands.
271268
@@ -276,15 +273,14 @@ Not supported by all npm commands.
276273* Default: false
277274* Type: Boolean
278275
279- If set to true, the current operation will only use the
280- `package-lock.json`, ignoring `node_modules`.
276+ If set to true, the current operation will only use the `package-lock.json`,
277+ ignoring `node_modules`.
281278
282279For `update` this means only the `package-lock.json` will be updated,
283280instead of checking `node_modules` and downloading dependencies.
284281
285- For `list` this means the output will be based on the tree described
286- by the `package-lock.json`, rather than the contents of
287- `node_modules`.
282+ For `list` this means the output will be based on the tree described by the
283+ `package-lock.json`, rather than the contents of `node_modules`.
288284
289285
290286
@@ -293,9 +289,8 @@ by the `package-lock.json`, rather than the contents of
293289* Default: true
294290* Type: Boolean
295291
296- If set to false, then ignore `package-lock.json` files when
297- installing. This will also prevent _writing_ `package-lock.json` if
298- `save` is true.
292+ If set to false, then ignore `package-lock.json` files when installing. This
293+ will also prevent _writing_ `package-lock.json` if `save` is true.
299294
300295
301296
@@ -311,45 +306,40 @@ Note that these dependencies _are_ still resolved and added to the
311306`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
312307physically installed on disk.
313308
314- If a package type appears in both the `--include` and `--omit` lists,
315- then it will be included.
309+ If a package type appears in both the `--include` and `--omit` lists, then
310+ it will be included.
316311
317- If the resulting omit list includes `'dev'`, then the `NODE_ENV`
318- environment variable will be set to `'production'` for all lifecycle
319- scripts.
312+ If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
313+ variable will be set to `'production'` for all lifecycle scripts.
320314
321315
322316
323317#### `include`
324318
325319* Default:
326- * Type: "prod", "dev", "optional", or "peer" (can be set multiple
327- times)
320+ * Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
328321
329- Option that allows for defining which types of dependencies to
330- install.
322+ Option that allows for defining which types of dependencies to install.
331323
332324This is the inverse of `--omit=<type>`.
333325
334- Dependency types specified in `--include` will not be omitted,
335- regardless of the order in which omit/include are specified on the
336- command-line.
326+ Dependency types specified in `--include` will not be omitted, regardless of
327+ the order in which omit/include are specified on the command-line.
337328
338329
339330
340331#### `foreground-scripts`
341332
342- * Default: `false` unless when using `npm pack` or `npm publish` where
343- it defaults to `true`
333+ * Default: `false` unless when using `npm pack` or `npm publish` where it
334+ defaults to `true`
344335* Type: Boolean
345336
346- Run all build scripts (ie, `preinstall`, `install`, and
347- `postinstall`) scripts for installed packages in the foreground
348- process, sharing standard input, output, and error with the main npm
349- process.
337+ Run all build scripts (ie, `preinstall`, `install`, and `postinstall`)
338+ scripts for installed packages in the foreground process, sharing standard
339+ input, output, and error with the main npm process.
350340
351- Note that this will generally make installs run slower, and be much
352- noisier, but can be useful for debugging.
341+ Note that this will generally make installs run slower, and be much noisier,
342+ but can be useful for debugging.
353343
354344
355345
@@ -360,10 +350,10 @@ noisier, but can be useful for debugging.
360350
361351If true, npm does not run scripts specified in package.json files.
362352
363- Note that commands explicitly intended to run a particular script,
364- such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm
365- run` will still run their intended script if `ignore-scripts` is set,
366- but they will *not* run any pre- or post-scripts.
353+ Note that commands explicitly intended to run a particular script, such as
354+ `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run` will still
355+ run their intended script if `ignore-scripts` is set, but they will *not*
356+ run any pre- or post-scripts.
367357
368358
369359
@@ -372,9 +362,9 @@ but they will *not* run any pre- or post-scripts.
372362* Default:
373363* Type: String (can be set multiple times)
374364
375- Enable running a command in the context of the configured workspaces
376- of the current project while filtering by running only the workspaces
377- defined by this configuration option.
365+ Enable running a command in the context of the configured workspaces of the
366+ current project while filtering by running only the workspaces defined by
367+ this configuration option.
378368
379369Valid values for the `workspace` config are either:
380370
@@ -383,9 +373,9 @@ Valid values for the `workspace` config are either:
383373* Path to a parent workspace directory (will result in selecting all
384374 workspaces within that folder)
385375
386- When set for the `npm init` command, this may be set to the folder of
387- a workspace which does not yet exist, to create the folder and set it
388- up as a brand new workspace within the project.
376+ When set for the `npm init` command, this may be set to the folder of a
377+ workspace which does not yet exist, to create the folder and set it up as a
378+ brand new workspace within the project.
389379
390380This value is not exported to the environment for child processes.
391381
@@ -397,14 +387,13 @@ This value is not exported to the environment for child processes.
397387Set to true to run the command in the context of **all** configured
398388workspaces.
399389
400- Explicitly setting this to false will cause commands like `install`
401- to ignore workspaces altogether. When not set explicitly:
390+ Explicitly setting this to false will cause commands like `install` to
391+ ignore workspaces altogether. When not set explicitly:
402392
403- - Commands that operate on the `node_modules` tree (install, update,
404- etc.) will link workspaces into the `node_modules` folder. - Commands
405- that do other things (test, exec, publish, etc.) will operate on the
406- root project, _unless_ one or more workspaces are specified in the
407- `workspace` config.
393+ - Commands that operate on the `node_modules` tree (install, update, etc.)
394+ will link workspaces into the `node_modules` folder. - Commands that do
395+ other things (test, exec, publish, etc.) will operate on the root project,
396+ _unless_ one or more workspaces are specified in the `workspace` config.
408397
409398This value is not exported to the environment for child processes.
410399
@@ -415,10 +404,9 @@ This value is not exported to the environment for child processes.
415404
416405Include the workspace root when workspaces are enabled for a command.
417406
418- When false, specifying individual workspaces via the `workspace`
419- config, or all workspaces via the `workspaces` flag, will cause npm
420- to operate only on the specified workspaces, and not on the root
421- project.
407+ When false, specifying individual workspaces via the `workspace` config, or
408+ all workspaces via the `workspaces` flag, will cause npm to operate only on
409+ the specified workspaces, and not on the root project.
422410
423411This value is not exported to the environment for child processes.
424412
@@ -427,9 +415,9 @@ This value is not exported to the environment for child processes.
427415* Default: false
428416* Type: Boolean
429417
430- When set file: protocol dependencies will be packed and installed as
431- regular dependencies instead of creating a symlink. This option has
432- no effect on workspaces.
418+ When set file: protocol dependencies will be packed and installed as regular
419+ dependencies instead of creating a symlink. This option has no effect on
420+ workspaces.
433421
434422
435423
0 commit comments