| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -57,8 +57,8 @@ Management of teams and team memberships is done with the `npm team` command. | |||
| 57 | 57 | ||
| 58 | 58 | Whether or not to output JSON data, rather than the normal output. | |
| 59 | 59 | ||
| 60 | - * In `npm pkg set` it enables parsing set values with JSON.parse() | ||
| 61 | - before saving them to your `package.json`. | ||
| 60 | + * In `npm pkg set` it enables parsing set values with JSON.parse() before | ||
| 61 | + saving them to your `package.json`. | ||
| 62 | 62 | ||
| 63 | 63 | Not supported by all npm commands. | |
| 64 | 64 | ||
@@ -69,12 +69,11 @@ Not supported by all npm commands. | |||
| 69 | 69 | * Default: null | |
| 70 | 70 | * Type: null or String | |
| 71 | 71 | ||
| 72 | - This is a one-time password from a two-factor authenticator. It's | ||
| 73 | - needed when publishing or changing package permissions with `npm | ||
| 74 | - access`. | ||
| 72 | + This is a one-time password from a two-factor authenticator. It's needed | ||
| 73 | + when publishing or changing package permissions with `npm access`. | ||
| 75 | 74 | ||
| 76 | - If not set, and a registry response fails with a challenge for a | ||
| 77 | - one-time password, npm will prompt on the command line for one. | ||
| 75 | + If not set, and a registry response fails with a challenge for a one-time | ||
| 76 | + password, npm will prompt on the command line for one. | ||
| 78 | 77 | ||
| 79 | 78 | ||
| 80 | 79 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -71,8 +71,8 @@ npm init --scope=@foo --yes | |||
| 71 | 71 | * Default: "web" | |
| 72 | 72 | * Type: "legacy" or "web" | |
| 73 | 73 | ||
| 74 | - What authentication strategy to use with `login`. Note that if an | ||
| 75 | - `otp` config is given, this value will always be set to `legacy`. | ||
| 74 | + What authentication strategy to use with `login`. Note that if an `otp` | ||
| 75 | + config is given, this value will always be set to `legacy`. | ||
| 76 | 76 | ||
| 77 | 77 | ||
| 78 | 78 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -206,8 +206,8 @@ $ npm audit --audit-level=moderate | |||
| 206 | 206 | * Default: null | |
| 207 | 207 | * Type: null, "info", "low", "moderate", "high", "critical", or "none" | |
| 208 | 208 | ||
| 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. | ||
| 211 | 211 | ||
| 212 | 212 | ||
| 213 | 213 | ||
@@ -216,14 +216,13 @@ non-zero exit code. | |||
| 216 | 216 | * Default: false | |
| 217 | 217 | * Type: Boolean | |
| 218 | 218 | ||
| 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`. | ||
| 224 | 223 | ||
| 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. | ||
| 227 | 226 | ||
| 228 | 227 | ||
| 229 | 228 | ||
@@ -238,16 +237,14 @@ mistakes, unnecessary performance degradation, and malicious input. | |||
| 238 | 237 | * Allow clobbering non-npm files in global installs. | |
| 239 | 238 | * Allow the `npm version` command to work on an unclean git repository. | |
| 240 | 239 | * 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). | ||
| 248 | 246 | * 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. | ||
| 251 | 248 | * Implicitly set `--yes` during `npm init`. | |
| 252 | 249 | * Allow clobbering existing values in `npm pkg` | |
| 253 | 250 | * Allow unpublishing of entire packages (not just a single version). | |
@@ -264,8 +261,8 @@ recommended that you do not use this option! | |||
| 264 | 261 | ||
| 265 | 262 | Whether or not to output JSON data, rather than the normal output. | |
| 266 | 263 | ||
| 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`. | ||
| 269 | 266 | ||
| 270 | 267 | Not supported by all npm commands. | |
| 271 | 268 | ||
@@ -276,15 +273,14 @@ Not supported by all npm commands. | |||
| 276 | 273 | * Default: false | |
| 277 | 274 | * Type: Boolean | |
| 278 | 275 | ||
| 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`. | ||
| 281 | 278 | ||
| 282 | 279 | For `update` this means only the `package-lock.json` will be updated, | |
| 283 | 280 | instead of checking `node_modules` and downloading dependencies. | |
| 284 | 281 | ||
| 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`. | ||
| 288 | 284 | ||
| 289 | 285 | ||
| 290 | 286 | ||
@@ -293,9 +289,8 @@ by the `package-lock.json`, rather than the contents of | |||
| 293 | 289 | * Default: true | |
| 294 | 290 | * Type: Boolean | |
| 295 | 291 | ||
| 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. | ||
| 299 | 294 | ||
| 300 | 295 | ||
| 301 | 296 | ||
@@ -311,45 +306,40 @@ Note that these dependencies _are_ still resolved and added to the | |||
| 311 | 306 | `package-lock.json` or `npm-shrinkwrap.json` file. They are just not | |
| 312 | 307 | physically installed on disk. | |
| 313 | 308 | ||
| 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. | ||
| 316 | 311 | ||
| 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. | ||
| 320 | 314 | ||
| 321 | 315 | ||
| 322 | 316 | ||
| 323 | 317 | #### `include` | |
| 324 | 318 | ||
| 325 | 319 | * 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) | ||
| 328 | 321 | ||
| 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. | ||
| 331 | 323 | ||
| 332 | 324 | This is the inverse of `--omit=<type>`. | |
| 333 | 325 | ||
| 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. | ||
| 337 | 328 | ||
| 338 | 329 | ||
| 339 | 330 | ||
| 340 | 331 | #### `foreground-scripts` | |
| 341 | 332 | ||
| 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` | ||
| 344 | 335 | * Type: Boolean | |
| 345 | 336 | ||
| 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. | ||
| 350 | 340 | ||
| 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. | ||
| 353 | 343 | ||
| 354 | 344 | ||
| 355 | 345 | ||
@@ -360,10 +350,10 @@ noisier, but can be useful for debugging. | |||
| 360 | 350 | ||
| 361 | 351 | If true, npm does not run scripts specified in package.json files. | |
| 362 | 352 | ||
| 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. | ||
| 367 | 357 | ||
| 368 | 358 | ||
| 369 | 359 | ||
@@ -372,9 +362,9 @@ but they will *not* run any pre- or post-scripts. | |||
| 372 | 362 | * Default: | |
| 373 | 363 | * Type: String (can be set multiple times) | |
| 374 | 364 | ||
| 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. | ||
| 378 | 368 | ||
| 379 | 369 | Valid values for the `workspace` config are either: | |
| 380 | 370 | ||
@@ -383,9 +373,9 @@ Valid values for the `workspace` config are either: | |||
| 383 | 373 | * Path to a parent workspace directory (will result in selecting all | |
| 384 | 374 | workspaces within that folder) | |
| 385 | 375 | ||
| 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. | ||
| 389 | 379 | ||
| 390 | 380 | This value is not exported to the environment for child processes. | |
| 391 | 381 | ||
@@ -397,14 +387,13 @@ This value is not exported to the environment for child processes. | |||
| 397 | 387 | Set to true to run the command in the context of **all** configured | |
| 398 | 388 | workspaces. | |
| 399 | 389 | ||
| 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: | ||
| 402 | 392 | ||
| 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. | ||
| 408 | 397 | ||
| 409 | 398 | This value is not exported to the environment for child processes. | |
| 410 | 399 | ||
@@ -415,10 +404,9 @@ This value is not exported to the environment for child processes. | |||
| 415 | 404 | ||
| 416 | 405 | Include the workspace root when workspaces are enabled for a command. | |
| 417 | 406 | ||
| 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. | ||
| 422 | 410 | ||
| 423 | 411 | This value is not exported to the environment for child processes. | |
| 424 | 412 | ||
@@ -427,9 +415,9 @@ This value is not exported to the environment for child processes. | |||
| 427 | 415 | * Default: false | |
| 428 | 416 | * Type: Boolean | |
| 429 | 417 | ||
| 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. | ||
| 433 | 421 | ||
| 434 | 422 | ||
| 435 | 423 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -47,9 +47,9 @@ The base URL of the npm registry. | |||
| 47 | 47 | * Default: | |
| 48 | 48 | * Type: String (can be set multiple times) | |
| 49 | 49 | ||
| 50 | - Enable running a command in the context of the configured workspaces | ||
| 51 | - of the current project while filtering by running only the workspaces | ||
| 52 | - defined by this configuration option. | ||
| 50 | + Enable running a command in the context of the configured workspaces of the | ||
| 51 | + current project while filtering by running only the workspaces defined by | ||
| 52 | + this configuration option. | ||
| 53 | 53 | ||
| 54 | 54 | Valid values for the `workspace` config are either: | |
| 55 | 55 | ||
@@ -58,9 +58,9 @@ Valid values for the `workspace` config are either: | |||
| 58 | 58 | * Path to a parent workspace directory (will result in selecting all | |
| 59 | 59 | workspaces within that folder) | |
| 60 | 60 | ||
| 61 | - When set for the `npm init` command, this may be set to the folder of | ||
| 62 | - a workspace which does not yet exist, to create the folder and set it | ||
| 63 | - up as a brand new workspace within the project. | ||
| 61 | + When set for the `npm init` command, this may be set to the folder of a | ||
| 62 | + workspace which does not yet exist, to create the folder and set it up as a | ||
| 63 | + brand new workspace within the project. | ||
| 64 | 64 | ||
| 65 | 65 | This value is not exported to the environment for child processes. | |
| 66 | 66 | ||
@@ -72,14 +72,13 @@ This value is not exported to the environment for child processes. | |||
| 72 | 72 | Set to true to run the command in the context of **all** configured | |
| 73 | 73 | workspaces. | |
| 74 | 74 | ||
| 75 | - Explicitly setting this to false will cause commands like `install` | ||
| 76 | - to ignore workspaces altogether. When not set explicitly: | ||
| 75 | + Explicitly setting this to false will cause commands like `install` to | ||
| 76 | + ignore workspaces altogether. When not set explicitly: | ||
| 77 | 77 | ||
| 78 | - - Commands that operate on the `node_modules` tree (install, update, | ||
| 79 | - etc.) will link workspaces into the `node_modules` folder. - Commands | ||
| 80 | - that do other things (test, exec, publish, etc.) will operate on the | ||
| 81 | - root project, _unless_ one or more workspaces are specified in the | ||
| 82 | - `workspace` config. | ||
| 78 | + - Commands that operate on the `node_modules` tree (install, update, etc.) | ||
| 79 | + will link workspaces into the `node_modules` folder. - Commands that do | ||
| 80 | + other things (test, exec, publish, etc.) will operate on the root project, | ||
| 81 | + _unless_ one or more workspaces are specified in the `workspace` config. | ||
| 83 | 82 | ||
| 84 | 83 | This value is not exported to the environment for child processes. | |
| 85 | 84 | ||
@@ -90,10 +89,9 @@ This value is not exported to the environment for child processes. | |||
| 90 | 89 | ||
| 91 | 90 | Include the workspace root when workspaces are enabled for a command. | |
| 92 | 91 | ||
| 93 | - When false, specifying individual workspaces via the `workspace` | ||
| 94 | - config, or all workspaces via the `workspaces` flag, will cause npm | ||
| 95 | - to operate only on the specified workspaces, and not on the root | ||
| 96 | - project. | ||
| 92 | + When false, specifying individual workspaces via the `workspace` config, or | ||
| 93 | + all workspaces via the `workspaces` flag, will cause npm to operate only on | ||
| 94 | + the specified workspaces, and not on the root project. | ||
| 97 | 95 | ||
| 98 | 96 | This value is not exported to the environment for child processes. | |
| 99 | 97 | ||
| Back | FazBrowse Home | New Git URL |
0 commit comments