diff options
Diffstat (limited to 'deps/npm/docs')
127 files changed, 2220 insertions, 8 deletions
diff --git a/deps/npm/docs/content/commands/npm-access.md b/deps/npm/docs/content/commands/npm-access.md index 6d73d6a5e28..1f661c911f4 100644 --- a/deps/npm/docs/content/commands/npm-access.md +++ b/deps/npm/docs/content/commands/npm-access.md @@ -85,6 +85,7 @@ Management of teams and team memberships is done with the `npm team` command. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -92,6 +93,9 @@ Management of teams and team memberships is done with the `npm team` command. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -103,6 +107,9 @@ when publishing or changing package permissions with `npm access`. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-adduser.md b/deps/npm/docs/content/commands/npm-adduser.md index f25d3ccd87a..21a31ca940e 100644 --- a/deps/npm/docs/content/commands/npm-adduser.md +++ b/deps/npm/docs/content/commands/npm-adduser.md @@ -37,6 +37,7 @@ your existing record. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -44,6 +45,9 @@ your existing record. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `scope` * Default: the scope of the current project, if any, or "" @@ -74,6 +78,9 @@ npm init --scope=@foo --yes ``` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-audit.md b/deps/npm/docs/content/commands/npm-audit.md index 94b16b27bd7..9fa8c0fcc6f 100644 --- a/deps/npm/docs/content/commands/npm-audit.md +++ b/deps/npm/docs/content/commands/npm-audit.md @@ -191,6 +191,7 @@ $ npm audit --audit-level=moderate <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `audit-level` * Default: null @@ -199,6 +200,9 @@ $ npm audit --audit-level=moderate The minimum level of vulnerability for `npm audit` to exit with a non-zero exit code. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dry-run` * Default: false @@ -212,6 +216,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `force` * Default: false @@ -237,6 +244,9 @@ mistakes, unnecessary performance degradation, and malicious input. If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option! +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -249,6 +259,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock-only` * Default: false @@ -263,6 +276,9 @@ instead of checking `node_modules` and downloading dependencies. For `list` this means the output will be based on the tree described by the `package-lock.json`, rather than the contents of `node_modules`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `omit` * Default: 'dev' if the `NODE_ENV` environment variable is set to @@ -281,6 +297,9 @@ it will be included. If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -303,6 +322,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -313,6 +335,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-bin.md b/deps/npm/docs/content/commands/npm-bin.md index 12984da1d1d..2d7c1d5b814 100644 --- a/deps/npm/docs/content/commands/npm-bin.md +++ b/deps/npm/docs/content/commands/npm-bin.md @@ -20,6 +20,7 @@ Print the folder where npm will install executables. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `global` * Default: false @@ -34,6 +35,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-bugs.md b/deps/npm/docs/content/commands/npm-bugs.md index b8778324b8e..f92241a14b9 100644 --- a/deps/npm/docs/content/commands/npm-bugs.md +++ b/deps/npm/docs/content/commands/npm-bugs.md @@ -23,6 +23,7 @@ will search for a `package.json` in the current folder and use the `name` proper <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `browser` * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -35,6 +36,9 @@ terminal. Set to `true` to use default system URL opener. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `registry` * Default: "https://registry.npmjs.org/" @@ -42,6 +46,9 @@ Set to `true` to use default system URL opener. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-cache.md b/deps/npm/docs/content/commands/npm-cache.md index e371f196d7c..6497a3988c9 100644 --- a/deps/npm/docs/content/commands/npm-cache.md +++ b/deps/npm/docs/content/commands/npm-cache.md @@ -77,6 +77,7 @@ verify`. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `cache` * Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm` @@ -85,6 +86,9 @@ verify`. The location of npm's cache directory. See [`npm cache`](/commands/npm-cache) +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-ci.md b/deps/npm/docs/content/commands/npm-ci.md index 31c92b13c5c..1ce50c66d5f 100644 --- a/deps/npm/docs/content/commands/npm-ci.md +++ b/deps/npm/docs/content/commands/npm-ci.md @@ -69,6 +69,7 @@ cache: <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `audit` * Default: true @@ -79,6 +80,9 @@ default registry and all registries configured for scopes. See the documentation for [`npm audit`](/commands/npm-audit) for details on what is submitted. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ignore-scripts` * Default: false @@ -91,6 +95,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -99,6 +106,9 @@ will *not* run any pre- or post-scripts. The shell to use for scripts run with the `npm exec`, `npm run` and `npm init <pkg>` commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-config.md b/deps/npm/docs/content/commands/npm-config.md index 9e76a23671e..2d77f045cbc 100644 --- a/deps/npm/docs/content/commands/npm-config.md +++ b/deps/npm/docs/content/commands/npm-config.md @@ -97,6 +97,7 @@ global config. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `json` * Default: false @@ -109,6 +110,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global` * Default: false @@ -123,6 +127,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `editor` * Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on @@ -131,6 +138,9 @@ folder instead of the current working directory. See The command to run for `npm edit` and `npm config edit`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `location` * Default: "user" unless `--global` is passed, which will also set this value @@ -139,6 +149,9 @@ The command to run for `npm edit` and `npm config edit`. When passed to `npm config` this refers to which config file to use. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `long` * Default: false @@ -146,6 +159,9 @@ When passed to `npm config` this refers to which config file to use. Show extended information in `ls`, `search`, and `help-search`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-dedupe.md b/deps/npm/docs/content/commands/npm-dedupe.md index 324e6a71b7a..dcb2a98fe9f 100644 --- a/deps/npm/docs/content/commands/npm-dedupe.md +++ b/deps/npm/docs/content/commands/npm-dedupe.md @@ -76,6 +76,7 @@ Using `npm find-dupes` will run the command in `--dry-run` mode. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `global-style` * Default: false @@ -88,6 +89,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `legacy-bundling` * Default: false @@ -98,6 +102,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `strict-peer-deps` * Default: false @@ -117,6 +124,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock` * Default: true @@ -129,6 +139,9 @@ When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `omit` * Default: 'dev' if the `NODE_ENV` environment variable is set to @@ -147,6 +160,9 @@ it will be included. If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ignore-scripts` * Default: false @@ -159,6 +175,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `audit` * Default: true @@ -169,6 +188,9 @@ default registry and all registries configured for scopes. See the documentation for [`npm audit`](/commands/npm-audit) for details on what is submitted. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `bin-links` * Default: true @@ -181,6 +203,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fund` * Default: true @@ -190,6 +215,9 @@ When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/commands/npm-fund) for details. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dry-run` * Default: false @@ -203,6 +231,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -225,6 +256,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -235,6 +269,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-deprecate.md b/deps/npm/docs/content/commands/npm-deprecate.md index b5c0e67144a..4888e42e8ba 100644 --- a/deps/npm/docs/content/commands/npm-deprecate.md +++ b/deps/npm/docs/content/commands/npm-deprecate.md @@ -44,6 +44,7 @@ format an empty string. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -51,6 +52,9 @@ format an empty string. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -62,6 +66,9 @@ when publishing or changing package permissions with `npm access`. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-diff.md b/deps/npm/docs/content/commands/npm-diff.md index 479cb63b112..cf0bbec15f4 100644 --- a/deps/npm/docs/content/commands/npm-diff.md +++ b/deps/npm/docs/content/commands/npm-diff.md @@ -155,6 +155,7 @@ located within the folder `./lib/` and changed lines of code within the <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `diff` * Default: @@ -162,6 +163,9 @@ located within the folder `./lib/` and changed lines of code within the Define arguments to compare in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-name-only` * Default: false @@ -169,6 +173,9 @@ Define arguments to compare in `npm diff`. Prints only filenames when using `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-unified` * Default: 3 @@ -176,6 +183,9 @@ Prints only filenames when using `npm diff`. The number of lines of context to print in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-ignore-all-space` * Default: false @@ -183,6 +193,9 @@ The number of lines of context to print in `npm diff`. Ignore whitespace when comparing lines in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-no-prefix` * Default: false @@ -193,6 +206,9 @@ Do not show any source or destination prefix in `npm diff` output. Note: this causes `npm diff` to ignore the `--diff-src-prefix` and `--diff-dst-prefix` configs. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-src-prefix` * Default: "a/" @@ -200,6 +216,9 @@ Note: this causes `npm diff` to ignore the `--diff-src-prefix` and Source prefix to be used in `npm diff` output. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-dst-prefix` * Default: "b/" @@ -207,6 +226,9 @@ Source prefix to be used in `npm diff` output. Destination prefix to be used in `npm diff` output. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-text` * Default: false @@ -214,6 +236,9 @@ Destination prefix to be used in `npm diff` output. Treat all files as text in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global` * Default: false @@ -228,6 +253,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `tag` * Default: "latest" @@ -242,6 +270,9 @@ command, if no explicit tag is given. When used by the `npm diff` command, this is the tag used to fetch the tarball that will be compared with the local files by default. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -264,6 +295,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -274,6 +308,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ## See Also diff --git a/deps/npm/docs/content/commands/npm-dist-tag.md b/deps/npm/docs/content/commands/npm-dist-tag.md index 0e4e0ce56c6..4ad68ff56d0 100644 --- a/deps/npm/docs/content/commands/npm-dist-tag.md +++ b/deps/npm/docs/content/commands/npm-dist-tag.md @@ -92,6 +92,7 @@ not begin with a number or the letter `v`. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `workspace` * Default: @@ -114,6 +115,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -124,6 +128,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-docs.md b/deps/npm/docs/content/commands/npm-docs.md index 7f4c8608370..9f1387daef8 100644 --- a/deps/npm/docs/content/commands/npm-docs.md +++ b/deps/npm/docs/content/commands/npm-docs.md @@ -24,6 +24,7 @@ the `name` property. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `browser` * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -36,6 +37,9 @@ terminal. Set to `true` to use default system URL opener. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `registry` * Default: "https://registry.npmjs.org/" @@ -43,6 +47,9 @@ Set to `true` to use default system URL opener. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -65,6 +72,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -75,6 +85,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-doctor.md b/deps/npm/docs/content/commands/npm-doctor.md index 839f4261bbb..0cce60c7b7b 100644 --- a/deps/npm/docs/content/commands/npm-doctor.md +++ b/deps/npm/docs/content/commands/npm-doctor.md @@ -106,6 +106,7 @@ reset the cache. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -113,6 +114,9 @@ reset the cache. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-edit.md b/deps/npm/docs/content/commands/npm-edit.md index 6930844bcae..5ae7f2481ae 100644 --- a/deps/npm/docs/content/commands/npm-edit.md +++ b/deps/npm/docs/content/commands/npm-edit.md @@ -29,6 +29,7 @@ changes to your locally installed copy. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `editor` * Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on @@ -37,6 +38,9 @@ changes to your locally installed copy. The command to run for `npm edit` and `npm config edit`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-exec.md b/deps/npm/docs/content/commands/npm-exec.md index d4ea94371a8..82908d65e01 100644 --- a/deps/npm/docs/content/commands/npm-exec.md +++ b/deps/npm/docs/content/commands/npm-exec.md @@ -124,6 +124,7 @@ $ npm exec -- foo@latest bar --package=@npmcli/foo <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `package` * Default: @@ -131,6 +132,9 @@ $ npm exec -- foo@latest bar --package=@npmcli/foo The package to install for [`npm exec`](/commands/npm-exec) +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `call` * Default: "" @@ -144,6 +148,9 @@ npm exec --package yo --package generator-node --call "yo node" ``` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -166,6 +173,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -176,6 +186,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### Examples diff --git a/deps/npm/docs/content/commands/npm-explain.md b/deps/npm/docs/content/commands/npm-explain.md index 3a87ee8e438..4a8af2f7000 100644 --- a/deps/npm/docs/content/commands/npm-explain.md +++ b/deps/npm/docs/content/commands/npm-explain.md @@ -56,6 +56,7 @@ node_modules/nyc/node_modules/find-up ### Configuration <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `json` * Default: false @@ -68,6 +69,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -90,6 +94,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-explore.md b/deps/npm/docs/content/commands/npm-explore.md index c4a40cf7229..3979da9573d 100644 --- a/deps/npm/docs/content/commands/npm-explore.md +++ b/deps/npm/docs/content/commands/npm-explore.md @@ -33,6 +33,7 @@ sure to use `npm rebuild <pkg>` if you make any changes. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `shell` * Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on @@ -41,6 +42,9 @@ sure to use `npm rebuild <pkg>` if you make any changes. The shell to run for the `npm explore` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-find-dupes.md b/deps/npm/docs/content/commands/npm-find-dupes.md index 3b28f6443de..e9dbac6d181 100644 --- a/deps/npm/docs/content/commands/npm-find-dupes.md +++ b/deps/npm/docs/content/commands/npm-find-dupes.md @@ -19,6 +19,7 @@ duplications, without actually changing the package tree. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `global-style` * Default: false @@ -31,6 +32,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `legacy-bundling` * Default: false @@ -41,6 +45,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `strict-peer-deps` * Default: false @@ -60,6 +67,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock` * Default: true @@ -72,6 +82,9 @@ When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `omit` * Default: 'dev' if the `NODE_ENV` environment variable is set to @@ -90,6 +103,9 @@ it will be included. If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ignore-scripts` * Default: false @@ -102,6 +118,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `audit` * Default: true @@ -112,6 +131,9 @@ default registry and all registries configured for scopes. See the documentation for [`npm audit`](/commands/npm-audit) for details on what is submitted. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `bin-links` * Default: true @@ -124,6 +146,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fund` * Default: true @@ -133,6 +158,9 @@ When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/commands/npm-fund) for details. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -155,6 +183,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -165,6 +196,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-fund.md b/deps/npm/docs/content/commands/npm-fund.md index ec5f5a37fdb..83c0b13d8cb 100644 --- a/deps/npm/docs/content/commands/npm-fund.md +++ b/deps/npm/docs/content/commands/npm-fund.md @@ -66,6 +66,7 @@ test-workspaces-fund@1.0.0 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `json` * Default: false @@ -78,6 +79,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `browser` * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -90,6 +94,9 @@ terminal. Set to `true` to use default system URL opener. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `unicode` * Default: false on windows, true on mac/unix systems with a unicode locale, @@ -99,6 +106,9 @@ Set to `true` to use default system URL opener. When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -121,6 +131,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `which` * Default: null @@ -128,6 +141,9 @@ This value is not exported to the environment for child processes. If there are multiple funding sources, which 1-indexed source URL to open. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ## See Also diff --git a/deps/npm/docs/content/commands/npm-help-search.md b/deps/npm/docs/content/commands/npm-help-search.md index 70f4f182d17..78553a14ecb 100644 --- a/deps/npm/docs/content/commands/npm-help-search.md +++ b/deps/npm/docs/content/commands/npm-help-search.md @@ -27,6 +27,7 @@ directly. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `long` * Default: false @@ -34,6 +35,9 @@ directly. Show extended information in `ls`, `search`, and `help-search`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-help.md b/deps/npm/docs/content/commands/npm-help.md index 81f55db332e..a8002eef171 100644 --- a/deps/npm/docs/content/commands/npm-help.md +++ b/deps/npm/docs/content/commands/npm-help.md @@ -25,6 +25,7 @@ topic, so unique matches are equivalent to specifying a topic name. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `viewer` * Default: "man" on Posix, "browser" on Windows @@ -34,6 +35,9 @@ The program to use to view help content. Set to `"browser"` to view html help content in the default web browser. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-hook.md b/deps/npm/docs/content/commands/npm-hook.md index 2917375ea38..c91bce3075e 100644 --- a/deps/npm/docs/content/commands/npm-hook.md +++ b/deps/npm/docs/content/commands/npm-hook.md @@ -87,6 +87,7 @@ $ npm hook rm id-deadbeef <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -94,6 +95,9 @@ $ npm hook rm id-deadbeef The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -105,6 +109,9 @@ when publishing or changing package permissions with `npm access`. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-init.md b/deps/npm/docs/content/commands/npm-init.md index 54c3bdb4b74..7355c75884b 100644 --- a/deps/npm/docs/content/commands/npm-init.md +++ b/deps/npm/docs/content/commands/npm-init.md @@ -147,6 +147,7 @@ dot to represent the current directory in that context, e.g: `react-app .`: <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `yes` * Default: null @@ -155,6 +156,9 @@ dot to represent the current directory in that context, e.g: `react-app .`: Automatically answer "yes" to any prompts that npm might print on the command line. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `force` * Default: false @@ -180,6 +184,9 @@ mistakes, unnecessary performance degradation, and malicious input. If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option! +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -202,6 +209,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -212,6 +222,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-install-ci-test.md b/deps/npm/docs/content/commands/npm-install-ci-test.md index 2640311cf94..5c37ed8f561 100644 --- a/deps/npm/docs/content/commands/npm-install-ci-test.md +++ b/deps/npm/docs/content/commands/npm-install-ci-test.md @@ -20,6 +20,7 @@ This command runs `npm ci` followed immediately by `npm test`. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `audit` * Default: true @@ -30,6 +31,9 @@ default registry and all registries configured for scopes. See the documentation for [`npm audit`](/commands/npm-audit) for details on what is submitted. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ignore-scripts` * Default: false @@ -42,6 +46,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -50,6 +57,9 @@ will *not* run any pre- or post-scripts. The shell to use for scripts run with the `npm exec`, `npm run` and `npm init <pkg>` commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-install-test.md b/deps/npm/docs/content/commands/npm-install-test.md index c8533cafedd..c2f9ab3d2f4 100644 --- a/deps/npm/docs/content/commands/npm-install-test.md +++ b/deps/npm/docs/content/commands/npm-install-test.md @@ -29,6 +29,7 @@ takes exactly the same arguments as `npm install`. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `save` * Default: true @@ -39,6 +40,9 @@ Save installed packages to a package.json file as dependencies. When used with the `npm rm` command, removes the dependency from package.json. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-exact` * Default: false @@ -47,6 +51,9 @@ package.json. Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global` * Default: false @@ -61,6 +68,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global-style` * Default: false @@ -73,6 +83,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `legacy-bundling` * Default: false @@ -83,6 +96,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `strict-peer-deps` * Default: false @@ -102,6 +118,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock` * Default: true @@ -114,6 +133,9 @@ When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `omit` * Default: 'dev' if the `NODE_ENV` environment variable is set to @@ -132,6 +154,9 @@ it will be included. If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ignore-scripts` * Default: false @@ -144,6 +169,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `audit` * Default: true @@ -154,6 +182,9 @@ default registry and all registries configured for scopes. See the documentation for [`npm audit`](/commands/npm-audit) for details on what is submitted. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `bin-links` * Default: true @@ -166,6 +197,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fund` * Default: true @@ -175,6 +209,9 @@ When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/commands/npm-fund) for details. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dry-run` * Default: false @@ -188,6 +225,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -210,6 +250,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -220,6 +263,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-install.md b/deps/npm/docs/content/commands/npm-install.md index 70d4c0d46ff..de73787181a 100644 --- a/deps/npm/docs/content/commands/npm-install.md +++ b/deps/npm/docs/content/commands/npm-install.md @@ -413,6 +413,7 @@ These are some of the most common options related to installation. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `save` * Default: true @@ -423,6 +424,9 @@ Save installed packages to a package.json file as dependencies. When used with the `npm rm` command, removes the dependency from package.json. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-exact` * Default: false @@ -431,6 +435,9 @@ package.json. Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global` * Default: false @@ -445,6 +452,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global-style` * Default: false @@ -457,6 +467,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `legacy-bundling` * Default: false @@ -467,6 +480,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `strict-peer-deps` * Default: false @@ -486,6 +502,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock` * Default: true @@ -498,6 +517,9 @@ When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `omit` * Default: 'dev' if the `NODE_ENV` environment variable is set to @@ -516,6 +538,9 @@ it will be included. If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ignore-scripts` * Default: false @@ -528,6 +553,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `audit` * Default: true @@ -538,6 +566,9 @@ default registry and all registries configured for scopes. See the documentation for [`npm audit`](/commands/npm-audit) for details on what is submitted. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `bin-links` * Default: true @@ -550,6 +581,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fund` * Default: true @@ -559,6 +593,9 @@ When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/commands/npm-fund) for details. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dry-run` * Default: false @@ -572,6 +609,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -594,6 +634,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -604,6 +647,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### Algorithm diff --git a/deps/npm/docs/content/commands/npm-link.md b/deps/npm/docs/content/commands/npm-link.md index c7b38500951..5811a8b23b9 100644 --- a/deps/npm/docs/content/commands/npm-link.md +++ b/deps/npm/docs/content/commands/npm-link.md @@ -113,6 +113,7 @@ workspace(s). <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `save` * Default: true @@ -123,6 +124,9 @@ Save installed packages to a package.json file as dependencies. When used with the `npm rm` command, removes the dependency from package.json. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-exact` * Default: false @@ -131,6 +135,9 @@ package.json. Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global` * Default: false @@ -145,6 +152,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global-style` * Default: false @@ -157,6 +167,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `legacy-bundling` * Default: false @@ -167,6 +180,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `strict-peer-deps` * Default: false @@ -186,6 +202,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock` * Default: true @@ -198,6 +217,9 @@ When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `omit` * Default: 'dev' if the `NODE_ENV` environment variable is set to @@ -216,6 +238,9 @@ it will be included. If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ignore-scripts` * Default: false @@ -228,6 +253,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `audit` * Default: true @@ -238,6 +266,9 @@ default registry and all registries configured for scopes. See the documentation for [`npm audit`](/commands/npm-audit) for details on what is submitted. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `bin-links` * Default: true @@ -250,6 +281,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fund` * Default: true @@ -259,6 +293,9 @@ When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/commands/npm-fund) for details. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dry-run` * Default: false @@ -272,6 +309,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -294,6 +334,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -304,6 +347,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-logout.md b/deps/npm/docs/content/commands/npm-logout.md index 000b1006e8b..cb7c8496fb4 100644 --- a/deps/npm/docs/content/commands/npm-logout.md +++ b/deps/npm/docs/content/commands/npm-logout.md @@ -29,6 +29,7 @@ connected to that scope, if set. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -36,6 +37,9 @@ connected to that scope, if set. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `scope` * Default: the scope of the current project, if any, or "" @@ -66,6 +70,9 @@ npm init --scope=@foo --yes ``` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-ls.md b/deps/npm/docs/content/commands/npm-ls.md index 350f40a9991..528140bee95 100644 --- a/deps/npm/docs/content/commands/npm-ls.md +++ b/deps/npm/docs/content/commands/npm-ls.md @@ -75,6 +75,7 @@ least the default human-readable `npm ls` output in npm v8. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `all` * Default: false @@ -84,6 +85,9 @@ When running `npm outdated` and `npm ls`, setting `--all` will show all outdated or installed packages, rather than only those directly depended upon by the current project. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -96,6 +100,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `long` * Default: false @@ -103,6 +110,9 @@ Not supported by all npm commands. Show extended information in `ls`, `search`, and `help-search`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `parseable` * Default: false @@ -111,6 +121,9 @@ Show extended information in `ls`, `search`, and `help-search`. Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global` * Default: false @@ -125,6 +138,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `depth` * Default: `Infinity` if `--all` is set, otherwise `1` @@ -135,6 +151,9 @@ The depth to go when recursing packages for `npm ls`. If not set, `npm ls` will show only the immediate dependencies of the root project. If `--all` is set, then npm will show all dependencies by default. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `omit` * Default: 'dev' if the `NODE_ENV` environment variable is set to @@ -153,6 +172,9 @@ it will be included. If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `link` * Default: false @@ -160,6 +182,9 @@ variable will be set to `'production'` for all lifecycle scripts. Used with `npm ls`, limiting output to only those packages that are linked. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock-only` * Default: false @@ -174,6 +199,9 @@ instead of checking `node_modules` and downloading dependencies. For `list` this means the output will be based on the tree described by the `package-lock.json`, rather than the contents of `node_modules`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `unicode` * Default: false on windows, true on mac/unix systems with a unicode locale, @@ -183,6 +211,9 @@ For `list` this means the output will be based on the tree described by the When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -205,6 +236,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -215,6 +249,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-org.md b/deps/npm/docs/content/commands/npm-org.md index 269f5cc3ee5..2f08f611529 100644 --- a/deps/npm/docs/content/commands/npm-org.md +++ b/deps/npm/docs/content/commands/npm-org.md @@ -62,6 +62,7 @@ listing them, and finding specific ones and their roles. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -69,6 +70,9 @@ listing them, and finding specific ones and their roles. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -80,6 +84,9 @@ when publishing or changing package permissions with `npm access`. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -92,6 +99,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `parseable` * Default: false @@ -100,6 +110,9 @@ Not supported by all npm commands. Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-outdated.md b/deps/npm/docs/content/commands/npm-outdated.md index 40e5feafd4c..8eb5528c3d0 100644 --- a/deps/npm/docs/content/commands/npm-outdated.md +++ b/deps/npm/docs/content/commands/npm-outdated.md @@ -88,6 +88,7 @@ A few things to note: <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `all` * Default: false @@ -97,6 +98,9 @@ When running `npm outdated` and `npm ls`, setting `--all` will show all outdated or installed packages, rather than only those directly depended upon by the current project. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -109,6 +113,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `long` * Default: false @@ -116,6 +123,9 @@ Not supported by all npm commands. Show extended information in `ls`, `search`, and `help-search`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `parseable` * Default: false @@ -124,6 +134,9 @@ Show extended information in `ls`, `search`, and `help-search`. Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global` * Default: false @@ -138,6 +151,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -160,6 +176,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-owner.md b/deps/npm/docs/content/commands/npm-owner.md index da22e899c2e..74e7f84af6c 100644 --- a/deps/npm/docs/content/commands/npm-owner.md +++ b/deps/npm/docs/content/commands/npm-owner.md @@ -39,6 +39,7 @@ on the command line when changing ownership with `--otp`. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -46,6 +47,9 @@ on the command line when changing ownership with `--otp`. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -57,6 +61,9 @@ when publishing or changing package permissions with `npm access`. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-pack.md b/deps/npm/docs/content/commands/npm-pack.md index cd4a175919e..dda30512db8 100644 --- a/deps/npm/docs/content/commands/npm-pack.md +++ b/deps/npm/docs/content/commands/npm-pack.md @@ -14,6 +14,7 @@ npm pack [[<@scope>/]<pkg>...] [--dry-run] [--json] <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `dry-run` * Default: false @@ -27,6 +28,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -39,6 +43,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `pack-destination` * Default: "." @@ -46,6 +53,9 @@ Not supported by all npm commands. Directory in which `npm pack` will save tarballs. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -68,6 +78,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -78,6 +91,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### Description diff --git a/deps/npm/docs/content/commands/npm-ping.md b/deps/npm/docs/content/commands/npm-ping.md index 7c7b66b181b..6f1c4582f05 100644 --- a/deps/npm/docs/content/commands/npm-ping.md +++ b/deps/npm/docs/content/commands/npm-ping.md @@ -29,6 +29,7 @@ Ping error: {*Detail about error} <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -36,6 +37,9 @@ Ping error: {*Detail about error} The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-pkg.md b/deps/npm/docs/content/commands/npm-pkg.md index bc96eb8c3af..bf6a2df5da6 100644 --- a/deps/npm/docs/content/commands/npm-pkg.md +++ b/deps/npm/docs/content/commands/npm-pkg.md @@ -166,6 +166,7 @@ npm pkg get name version --ws <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `force` * Default: false @@ -191,6 +192,9 @@ mistakes, unnecessary performance degradation, and malicious input. If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option! +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -203,6 +207,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -225,6 +232,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -235,6 +245,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ## See Also diff --git a/deps/npm/docs/content/commands/npm-prefix.md b/deps/npm/docs/content/commands/npm-prefix.md index 0523c9e1951..276a9e9e699 100644 --- a/deps/npm/docs/content/commands/npm-prefix.md +++ b/deps/npm/docs/content/commands/npm-prefix.md @@ -37,6 +37,7 @@ npm prefix -g <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `global` * Default: false @@ -51,6 +52,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-profile.md b/deps/npm/docs/content/commands/npm-profile.md index 079440d7858..cecc48518db 100644 --- a/deps/npm/docs/content/commands/npm-profile.md +++ b/deps/npm/docs/content/commands/npm-profile.md @@ -77,6 +77,7 @@ Some of these commands may not be available on non npmjs.com registries. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -84,6 +85,9 @@ Some of these commands may not be available on non npmjs.com registries. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -96,6 +100,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `parseable` * Default: false @@ -104,6 +111,9 @@ Not supported by all npm commands. Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -115,6 +125,9 @@ when publishing or changing package permissions with `npm access`. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-prune.md b/deps/npm/docs/content/commands/npm-prune.md index d9b5b068f7a..7bd7ad13113 100644 --- a/deps/npm/docs/content/commands/npm-prune.md +++ b/deps/npm/docs/content/commands/npm-prune.md @@ -37,6 +37,7 @@ this command can help clean up any resulting garbage. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `omit` * Default: 'dev' if the `NODE_ENV` environment variable is set to @@ -55,6 +56,9 @@ it will be included. If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dry-run` * Default: false @@ -68,6 +72,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -80,6 +87,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -102,6 +112,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -112,6 +125,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-publish.md b/deps/npm/docs/content/commands/npm-publish.md index 0d25d7d29da..946109de404 100644 --- a/deps/npm/docs/content/commands/npm-publish.md +++ b/deps/npm/docs/content/commands/npm-publish.md @@ -108,6 +108,7 @@ built. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `tag` * Default: "latest" @@ -122,6 +123,9 @@ command, if no explicit tag is given. When used by the `npm diff` command, this is the tag used to fetch the tarball that will be compared with the local files by default. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `access` * Default: 'restricted' for scoped packages, 'public' for unscoped packages @@ -132,6 +136,15 @@ If you want your scoped package to be publicly viewable (and installable) set `--access=public`. The only valid values for `access` are `public` and `restricted`. Unscoped packages _always_ have an access level of `public`. +Note: Using the `--access` flag on the `npm publish` command will only set +the package access level on the initial publish of the package. Any +subsequent `npm publish` commands using the `--access` flag will not have an +effect to the access level. To make changes to the access level after the +initial publish use `npm access`. + +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dry-run` * Default: false @@ -145,6 +158,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -156,6 +172,9 @@ when publishing or changing package permissions with `npm access`. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -178,6 +197,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -188,6 +210,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-rebuild.md b/deps/npm/docs/content/commands/npm-rebuild.md index 49c822d7305..19684796f8f 100644 --- a/deps/npm/docs/content/commands/npm-rebuild.md +++ b/deps/npm/docs/content/commands/npm-rebuild.md @@ -28,6 +28,7 @@ will be rebuilt. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `global` * Default: false @@ -42,6 +43,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `bin-links` * Default: true @@ -54,6 +58,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ignore-scripts` * Default: false @@ -66,6 +73,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -88,6 +98,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -98,6 +111,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-repo.md b/deps/npm/docs/content/commands/npm-repo.md index ade08e7d938..c3c509e0b4b 100644 --- a/deps/npm/docs/content/commands/npm-repo.md +++ b/deps/npm/docs/content/commands/npm-repo.md @@ -21,6 +21,7 @@ in the current folder and use the `repository` property. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `browser` * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -33,6 +34,9 @@ terminal. Set to `true` to use default system URL opener. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -55,6 +59,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -65,6 +72,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-restart.md b/deps/npm/docs/content/commands/npm-restart.md index 4b905c26706..80f8ab77ef0 100644 --- a/deps/npm/docs/content/commands/npm-restart.md +++ b/deps/npm/docs/content/commands/npm-restart.md @@ -38,6 +38,7 @@ If it does _not_ have a `"restart"` script specified, but it does have <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `ignore-scripts` * Default: false @@ -50,6 +51,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -58,6 +62,9 @@ will *not* run any pre- or post-scripts. The shell to use for scripts run with the `npm exec`, `npm run` and `npm init <pkg>` commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-root.md b/deps/npm/docs/content/commands/npm-root.md index 2d072c16dec..98d1108d33f 100644 --- a/deps/npm/docs/content/commands/npm-root.md +++ b/deps/npm/docs/content/commands/npm-root.md @@ -27,6 +27,7 @@ echo "Global packages installed in: ${global_node_modules}" <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `global` * Default: false @@ -41,6 +42,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-run-script.md b/deps/npm/docs/content/commands/npm-run-script.md index 5e3828c4071..e436bc27f9d 100644 --- a/deps/npm/docs/content/commands/npm-run-script.md +++ b/deps/npm/docs/content/commands/npm-run-script.md @@ -138,6 +138,7 @@ packages. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `workspace` * Default: @@ -160,6 +161,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -170,6 +174,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `if-present` * Default: false @@ -182,6 +189,9 @@ it's present and fail if the script fails. This is useful, for example, when running scripts that may only apply for some builds in an otherwise generic CI setup. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ignore-scripts` * Default: false @@ -194,6 +204,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -202,6 +215,9 @@ will *not* run any pre- or post-scripts. The shell to use for scripts run with the `npm exec`, `npm run` and `npm init <pkg>` commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-search.md b/deps/npm/docs/content/commands/npm-search.md index e30287635b5..252822e7198 100644 --- a/deps/npm/docs/content/commands/npm-search.md +++ b/deps/npm/docs/content/commands/npm-search.md @@ -41,6 +41,7 @@ expression characters in most shells.) <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `long` * Default: false @@ -48,6 +49,9 @@ expression characters in most shells.) Show extended information in `ls`, `search`, and `help-search`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -60,6 +64,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `color` * Default: true unless the NO_COLOR environ is set to something other than '0' @@ -68,6 +75,9 @@ Not supported by all npm commands. If false, never shows colors. If `"always"` then always shows colors. If true, then only prints color codes for tty file descriptors. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `parseable` * Default: false @@ -76,6 +86,9 @@ true, then only prints color codes for tty file descriptors. Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `description` * Default: true @@ -83,6 +96,9 @@ Output parseable results from commands that write to standard output. For Show the description in `npm search` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `searchopts` * Default: "" @@ -90,6 +106,9 @@ Show the description in `npm search` Space-separated options that are always passed to search. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `searchexclude` * Default: "" @@ -97,6 +116,9 @@ Space-separated options that are always passed to search. Space-separated options that limit the results from search. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `registry` * Default: "https://registry.npmjs.org/" @@ -104,6 +126,9 @@ Space-separated options that limit the results from search. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `prefer-online` * Default: false @@ -112,6 +137,9 @@ The base URL of the npm registry. If true, staleness checks for cached data will be forced, making the CLI look for updates immediately even for fresh package data. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `prefer-offline` * Default: false @@ -121,6 +149,9 @@ If true, staleness checks for cached data will be bypassed, but missing data will be requested from the server. To force full offline mode, use `--offline`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `offline` * Default: false @@ -129,6 +160,9 @@ will be requested from the server. To force full offline mode, use Force offline mode: no network requests will be done during install. To allow the CLI to fill in missing cache data, see `--prefer-offline`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-set-script.md b/deps/npm/docs/content/commands/npm-set-script.md index c5d5df53203..e39b7a18c09 100644 --- a/deps/npm/docs/content/commands/npm-set-script.md +++ b/deps/npm/docs/content/commands/npm-set-script.md @@ -30,6 +30,7 @@ npm set-script [<script>] [<command>] <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `workspace` * Default: @@ -52,6 +53,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -62,6 +66,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-star.md b/deps/npm/docs/content/commands/npm-star.md index 5af08e2da67..21109c35096 100644 --- a/deps/npm/docs/content/commands/npm-star.md +++ b/deps/npm/docs/content/commands/npm-star.md @@ -37,6 +37,7 @@ You can see all your starred packages using [`npm stars`](/commands/npm-stars) <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -44,6 +45,9 @@ You can see all your starred packages using [`npm stars`](/commands/npm-stars) The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `unicode` * Default: false on windows, true on mac/unix systems with a unicode locale, @@ -53,6 +57,9 @@ The base URL of the npm registry. When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-stars.md b/deps/npm/docs/content/commands/npm-stars.md index edea74a0c27..101559ad99b 100644 --- a/deps/npm/docs/content/commands/npm-stars.md +++ b/deps/npm/docs/content/commands/npm-stars.md @@ -23,6 +23,7 @@ you will most certainly enjoy this command. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -30,6 +31,9 @@ you will most certainly enjoy this command. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-start.md b/deps/npm/docs/content/commands/npm-start.md index 1c532de44be..50a54cb5e5b 100644 --- a/deps/npm/docs/content/commands/npm-start.md +++ b/deps/npm/docs/content/commands/npm-start.md @@ -49,6 +49,7 @@ npm start <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `ignore-scripts` * Default: false @@ -61,6 +62,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -69,6 +73,9 @@ will *not* run any pre- or post-scripts. The shell to use for scripts run with the `npm exec`, `npm run` and `npm init <pkg>` commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-stop.md b/deps/npm/docs/content/commands/npm-stop.md index 859de54c391..d4de4caf3a6 100644 --- a/deps/npm/docs/content/commands/npm-stop.md +++ b/deps/npm/docs/content/commands/npm-stop.md @@ -42,6 +42,7 @@ npm stop <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `ignore-scripts` * Default: false @@ -54,6 +55,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -62,6 +66,9 @@ will *not* run any pre- or post-scripts. The shell to use for scripts run with the `npm exec`, `npm run` and `npm init <pkg>` commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-team.md b/deps/npm/docs/content/commands/npm-team.md index c7d5defcc63..6050af1dff2 100644 --- a/deps/npm/docs/content/commands/npm-team.md +++ b/deps/npm/docs/content/commands/npm-team.md @@ -105,6 +105,7 @@ use the `npm access` command to grant or revoke the appropriate permissions. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -112,6 +113,9 @@ use the `npm access` command to grant or revoke the appropriate permissions. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -123,6 +127,9 @@ when publishing or changing package permissions with `npm access`. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `parseable` * Default: false @@ -131,6 +138,9 @@ password, npm will prompt on the command line for one. Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -143,6 +153,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-test.md b/deps/npm/docs/content/commands/npm-test.md index 73cdf6de857..2059f93dec4 100644 --- a/deps/npm/docs/content/commands/npm-test.md +++ b/deps/npm/docs/content/commands/npm-test.md @@ -39,6 +39,7 @@ npm test <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `ignore-scripts` * Default: false @@ -51,6 +52,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -59,6 +63,9 @@ will *not* run any pre- or post-scripts. The shell to use for scripts run with the `npm exec`, `npm run` and `npm init <pkg>` commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-token.md b/deps/npm/docs/content/commands/npm-token.md index c586a691523..16da1f73192 100644 --- a/deps/npm/docs/content/commands/npm-token.md +++ b/deps/npm/docs/content/commands/npm-token.md @@ -78,6 +78,7 @@ This lets you list, create and revoke authentication tokens. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `read-only` * Default: false @@ -86,6 +87,9 @@ This lets you list, create and revoke authentication tokens. This is used to mark a token as unable to publish when configuring limited access tokens with the `npm token create` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cidr` * Default: null @@ -94,6 +98,9 @@ access tokens with the `npm token create` command. This is a list of CIDR address to be used when configuring limited access tokens with the `npm token create` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `registry` * Default: "https://registry.npmjs.org/" @@ -101,6 +108,9 @@ tokens with the `npm token create` command. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -112,6 +122,9 @@ when publishing or changing package permissions with `npm access`. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-uninstall.md b/deps/npm/docs/content/commands/npm-uninstall.md index b6ba3139383..c04e1a7fd41 100644 --- a/deps/npm/docs/content/commands/npm-uninstall.md +++ b/deps/npm/docs/content/commands/npm-uninstall.md @@ -58,6 +58,7 @@ npm uninstall lodash --no-save <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `save` * Default: true @@ -68,6 +69,9 @@ Save installed packages to a package.json file as dependencies. When used with the `npm rm` command, removes the dependency from package.json. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -90,6 +94,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -100,6 +107,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-unpublish.md b/deps/npm/docs/content/commands/npm-unpublish.md index b17ff454068..1678bb305dc 100644 --- a/deps/npm/docs/content/commands/npm-unpublish.md +++ b/deps/npm/docs/content/commands/npm-unpublish.md @@ -49,6 +49,7 @@ passed. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `dry-run` * Default: false @@ -62,6 +63,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `force` * Default: false @@ -87,6 +91,9 @@ mistakes, unnecessary performance degradation, and malicious input. If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option! +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -109,6 +116,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -119,6 +129,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-unstar.md b/deps/npm/docs/content/commands/npm-unstar.md index f1a1f7a2e35..d6e36207723 100644 --- a/deps/npm/docs/content/commands/npm-unstar.md +++ b/deps/npm/docs/content/commands/npm-unstar.md @@ -33,6 +33,7 @@ You can see all your starred packages using [`npm stars`](/commands/npm-stars) <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -40,6 +41,9 @@ You can see all your starred packages using [`npm stars`](/commands/npm-stars) The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `unicode` * Default: false on windows, true on mac/unix systems with a unicode locale, @@ -49,6 +53,9 @@ The base URL of the npm registry. When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -60,6 +67,9 @@ when publishing or changing package permissions with `npm access`. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-update.md b/deps/npm/docs/content/commands/npm-update.md index c4f7694e19a..57b9b91f978 100644 --- a/deps/npm/docs/content/commands/npm-update.md +++ b/deps/npm/docs/content/commands/npm-update.md @@ -153,6 +153,7 @@ be _downgraded_. <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `global` * Default: false @@ -167,6 +168,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global-style` * Default: false @@ -179,6 +183,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `legacy-bundling` * Default: false @@ -189,6 +196,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `strict-peer-deps` * Default: false @@ -208,6 +218,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock` * Default: true @@ -220,6 +233,9 @@ When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `omit` * Default: 'dev' if the `NODE_ENV` environment variable is set to @@ -238,6 +254,9 @@ it will be included. If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ignore-scripts` * Default: false @@ -250,6 +269,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `audit` * Default: true @@ -260,6 +282,9 @@ default registry and all registries configured for scopes. See the documentation for [`npm audit`](/commands/npm-audit) for details on what is submitted. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `bin-links` * Default: true @@ -272,6 +297,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fund` * Default: true @@ -281,6 +309,9 @@ When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/commands/npm-fund) for details. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dry-run` * Default: false @@ -294,6 +325,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -316,6 +350,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -326,6 +363,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/commands/npm-version.md b/deps/npm/docs/content/commands/npm-version.md index a3e34153a06..a02bf5bb99b 100644 --- a/deps/npm/docs/content/commands/npm-version.md +++ b/deps/npm/docs/content/commands/npm-version.md @@ -18,6 +18,7 @@ npm version [<newversion> | major | minor | patch | premajor | preminor | prepat <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `allow-same-version` * Default: false @@ -26,6 +27,9 @@ npm version [<newversion> | major | minor | patch | premajor | preminor | prepat Prevents throwing an error when `npm version` is used to set the new version to the same value as the current version. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `commit-hooks` * Default: true @@ -33,6 +37,9 @@ to the same value as the current version. Run git commit hooks when using the `npm version` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `git-tag-version` * Default: true @@ -40,6 +47,9 @@ Run git commit hooks when using the `npm version` command. Tag the commit when using the `npm version` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -52,6 +62,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `preid` * Default: "" @@ -60,6 +73,9 @@ Not supported by all npm commands. The "prerelease identifier" to use as a prefix for the "prerelease" part of a semver. Like the `rc` in `1.2.0-rc.8`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `sign-git-tag` * Default: false @@ -71,6 +87,9 @@ If set to true, then the `npm version` command will tag the version using Note that git requires you to have set up GPG keys in your git configs for this to work properly. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -93,6 +112,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -103,6 +125,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### Description diff --git a/deps/npm/docs/content/commands/npm-view.md b/deps/npm/docs/content/commands/npm-view.md index b3d5df86e34..af354deb88a 100644 --- a/deps/npm/docs/content/commands/npm-view.md +++ b/deps/npm/docs/content/commands/npm-view.md @@ -98,6 +98,7 @@ npm view connect versions <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `json` * Default: false @@ -110,6 +111,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -132,6 +136,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -142,6 +149,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### Output diff --git a/deps/npm/docs/content/commands/npm-whoami.md b/deps/npm/docs/content/commands/npm-whoami.md index 09253b3b633..2cd7ffde3f4 100644 --- a/deps/npm/docs/content/commands/npm-whoami.md +++ b/deps/npm/docs/content/commands/npm-whoami.md @@ -27,6 +27,7 @@ If logged into a registry that uses Basic Auth, then simply print the <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `registry` * Default: "https://registry.npmjs.org/" @@ -34,6 +35,9 @@ If logged into a registry that uses Basic Auth, then simply print the The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See Also diff --git a/deps/npm/docs/content/configuring-npm/package-json.md b/deps/npm/docs/content/configuring-npm/package-json.md index 0fc5dc5075e..856adb3366c 100644 --- a/deps/npm/docs/content/configuring-npm/package-json.md +++ b/deps/npm/docs/content/configuring-npm/package-json.md @@ -286,12 +286,10 @@ Certain files are always included, regardless of settings: * `package.json` * `README` -* `CHANGES` / `CHANGELOG` / `HISTORY` * `LICENSE` / `LICENCE` -* `NOTICE` * The file in the "main" field -`README`, `CHANGES`, `LICENSE` & `NOTICE` can have any case and extension. +`README` & `LICENSE` can have any case and extension. Conversely, some files are always ignored: diff --git a/deps/npm/docs/content/using-npm/config.md b/deps/npm/docs/content/using-npm/config.md index c4d1afed35c..10e8ca9b9dc 100644 --- a/deps/npm/docs/content/using-npm/config.md +++ b/deps/npm/docs/content/using-npm/config.md @@ -61,6 +61,7 @@ The following shorthands are parsed on the command-line: <!-- AUTOGENERATED CONFIG SHORTHANDS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> * `-a`: `--all` * `--enjoy-by`: `--before` * `-c`: `--call` @@ -101,6 +102,8 @@ The following shorthands are parsed on the command-line: * `--ws`: `--workspaces` * `-y`: `--yes` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> <!-- AUTOGENERATED CONFIG SHORTHANDS END --> If the specified configuration param resolves unambiguously to a known @@ -128,6 +131,7 @@ npm ls --global --parseable --long --loglevel info <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `_auth` * Default: null @@ -139,6 +143,9 @@ Warning: This should generally not be set via a command-line option. It is safer to use a registry-provided authentication bearer token stored in the ~/.npmrc file by running `npm login`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `access` * Default: 'restricted' for scoped packages, 'public' for unscoped packages @@ -149,6 +156,15 @@ If you want your scoped package to be publicly viewable (and installable) set `--access=public`. The only valid values for `access` are `public` and `restricted`. Unscoped packages _always_ have an access level of `public`. +Note: Using the `--access` flag on the `npm publish` command will only set +the package access level on the initial publish of the package. Any +subsequent `npm publish` commands using the `--access` flag will not have an +effect to the access level. To make changes to the access level after the +initial publish use `npm access`. + +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `all` * Default: false @@ -158,6 +174,9 @@ When running `npm outdated` and `npm ls`, setting `--all` will show all outdated or installed packages, rather than only those directly depended upon by the current project. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `allow-same-version` * Default: false @@ -166,6 +185,9 @@ upon by the current project. Prevents throwing an error when `npm version` is used to set the new version to the same value as the current version. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `audit` * Default: true @@ -176,6 +198,9 @@ default registry and all registries configured for scopes. See the documentation for [`npm audit`](/commands/npm-audit) for details on what is submitted. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `audit-level` * Default: null @@ -184,6 +209,9 @@ submitted. The minimum level of vulnerability for `npm audit` to exit with a non-zero exit code. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `before` * Default: null @@ -199,6 +227,9 @@ If the requested version is a `dist-tag` and the given tag does not pass the will be used. For example, `foo@latest` might install `foo@1.2` even though `latest` is `2.0`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `bin-links` * Default: true @@ -211,6 +242,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `browser` * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -223,6 +257,9 @@ terminal. Set to `true` to use default system URL opener. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ca` * Default: null @@ -249,6 +286,9 @@ ca[]="..." See also the `strict-ssl` config. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cache` * Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm` @@ -257,6 +297,9 @@ See also the `strict-ssl` config. The location of npm's cache directory. See [`npm cache`](/commands/npm-cache) +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cafile` * Default: null @@ -266,6 +309,9 @@ A path to a file containing one or multiple Certificate Authority signing certificates. Similar to the `ca` setting, but allows for multiple CA's, as well as for the CA information to be stored in a file on disk. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `call` * Default: "" @@ -279,6 +325,9 @@ npm exec --package yo --package generator-node --call "yo node" ``` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cert` * Default: null @@ -295,6 +344,9 @@ cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----" It is _not_ the path to a certificate file (and there is no "certfile" option). +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ci-name` * Default: The name of the current CI system, or `null` when not on a known CI @@ -305,6 +357,9 @@ The name of a continuous integration system. If not set explicitly, npm will detect the current CI environment using the [`@npmcli/ci-detect`](http://npm.im/@npmcli/ci-detect) module. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cidr` * Default: null @@ -313,6 +368,9 @@ detect the current CI environment using the This is a list of CIDR address to be used when configuring limited access tokens with the `npm token create` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `color` * Default: true unless the NO_COLOR environ is set to something other than '0' @@ -321,6 +379,9 @@ tokens with the `npm token create` command. If false, never shows colors. If `"always"` then always shows colors. If true, then only prints color codes for tty file descriptors. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `commit-hooks` * Default: true @@ -328,6 +389,9 @@ true, then only prints color codes for tty file descriptors. Run git commit hooks when using the `npm version` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `depth` * Default: `Infinity` if `--all` is set, otherwise `1` @@ -338,6 +402,9 @@ The depth to go when recursing packages for `npm ls`. If not set, `npm ls` will show only the immediate dependencies of the root project. If `--all` is set, then npm will show all dependencies by default. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `description` * Default: true @@ -345,6 +412,9 @@ project. If `--all` is set, then npm will show all dependencies by default. Show the description in `npm search` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff` * Default: @@ -352,6 +422,9 @@ Show the description in `npm search` Define arguments to compare in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-dst-prefix` * Default: "b/" @@ -359,6 +432,9 @@ Define arguments to compare in `npm diff`. Destination prefix to be used in `npm diff` output. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-ignore-all-space` * Default: false @@ -366,6 +442,9 @@ Destination prefix to be used in `npm diff` output. Ignore whitespace when comparing lines in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-name-only` * Default: false @@ -373,6 +452,9 @@ Ignore whitespace when comparing lines in `npm diff`. Prints only filenames when using `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-no-prefix` * Default: false @@ -383,6 +465,9 @@ Do not show any source or destination prefix in `npm diff` output. Note: this causes `npm diff` to ignore the `--diff-src-prefix` and `--diff-dst-prefix` configs. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-src-prefix` * Default: "a/" @@ -390,6 +475,9 @@ Note: this causes `npm diff` to ignore the `--diff-src-prefix` and Source prefix to be used in `npm diff` output. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-text` * Default: false @@ -397,6 +485,9 @@ Source prefix to be used in `npm diff` output. Treat all files as text in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-unified` * Default: 3 @@ -404,6 +495,9 @@ Treat all files as text in `npm diff`. The number of lines of context to print in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dry-run` * Default: false @@ -417,6 +511,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `editor` * Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on @@ -425,6 +522,9 @@ Note: This is NOT honored by other network related commands, eg `dist-tags`, The command to run for `npm edit` and `npm config edit`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `engine-strict` * Default: false @@ -436,6 +536,9 @@ Node.js version. This can be overridden by setting the `--force` flag. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fetch-retries` * Default: 2 @@ -447,6 +550,9 @@ from the registry. npm will retry idempotent read requests to the registry in the case of network failures or 5xx HTTP errors. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fetch-retry-factor` * Default: 10 @@ -454,6 +560,9 @@ network failures or 5xx HTTP errors. The "factor" config for the `retry` module to use when fetching packages. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fetch-retry-maxtimeout` * Default: 60000 (1 minute) @@ -462,6 +571,9 @@ The "factor" config for the `retry` module to use when fetching packages. The "maxTimeout" config for the `retry` module to use when fetching packages. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fetch-retry-mintimeout` * Default: 10000 (10 seconds) @@ -470,6 +582,9 @@ packages. The "minTimeout" config for the `retry` module to use when fetching packages. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fetch-timeout` * Default: 300000 (5 minutes) @@ -477,6 +592,9 @@ packages. The maximum amount of time to wait for HTTP requests to complete. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `force` * Default: false @@ -502,6 +620,9 @@ mistakes, unnecessary performance degradation, and malicious input. If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option! +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `foreground-scripts` * Default: false @@ -514,6 +635,9 @@ input, output, and error with the main npm process. Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `format-package-lock` * Default: true @@ -522,6 +646,9 @@ but can be useful for debugging. Format `package-lock.json` or `npm-shrinkwrap.json` as a human readable file. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fund` * Default: true @@ -531,6 +658,9 @@ When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/commands/npm-fund) for details. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `git` * Default: "git" @@ -539,6 +669,9 @@ fund`](/commands/npm-fund) for details. The command to use for git commands. If git is installed on the computer, but is not in the `PATH`, then set this to the full path to the git binary. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `git-tag-version` * Default: true @@ -546,6 +679,9 @@ but is not in the `PATH`, then set this to the full path to the git binary. Tag the commit when using the `npm version` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global` * Default: false @@ -560,6 +696,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global-style` * Default: false @@ -572,6 +711,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `globalconfig` * Default: The global --prefix setting plus 'etc/npmrc'. For example, @@ -580,6 +722,9 @@ will be preferred. The config file to read for global config options. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `heading` * Default: "npm" @@ -587,6 +732,9 @@ The config file to read for global config options. The string that starts all the debugging log output. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `https-proxy` * Default: null @@ -597,6 +745,9 @@ A proxy to use for outgoing https requests. If the `HTTPS_PROXY` or proxy settings will be honored by the underlying `make-fetch-happen` library. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `if-present` * Default: false @@ -609,6 +760,9 @@ it's present and fail if the script fails. This is useful, for example, when running scripts that may only apply for some builds in an otherwise generic CI setup. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ignore-scripts` * Default: false @@ -621,6 +775,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `include` * Default: @@ -633,6 +790,9 @@ This is the inverse of `--omit=<type>`. Dependency types specified in `--include` will not be omitted, regardless of the order in which omit/include are specified on the command-line. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `include-staged` * Default: false @@ -643,6 +803,9 @@ Allow installing "staged" published packages, as defined by [npm RFC PR This is experimental, and not implemented by the npm public registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-author-email` * Default: "" @@ -650,6 +813,9 @@ This is experimental, and not implemented by the npm public registry. The value `npm init` should use by default for the package author's email. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-author-name` * Default: "" @@ -657,6 +823,9 @@ The value `npm init` should use by default for the package author's email. The value `npm init` should use by default for the package author's name. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-author-url` * Default: "" @@ -665,6 +834,9 @@ The value `npm init` should use by default for the package author's name. The value `npm init` should use by default for the package author's homepage. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-license` * Default: "ISC" @@ -672,6 +844,9 @@ homepage. The value `npm init` should use by default for the package license. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-module` * Default: "~/.npm-init.js" @@ -682,6 +857,9 @@ documentation for the [init-package-json](https://github.com/npm/init-package-json) module for more information, or [npm init](/commands/npm-init). +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-version` * Default: "1.0.0" @@ -690,6 +868,9 @@ more information, or [npm init](/commands/npm-init). The value that `npm init` should use by default for the package version number, if not already set in package.json. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `json` * Default: false @@ -702,6 +883,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `key` * Default: null @@ -716,6 +900,9 @@ key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----" It is _not_ the path to a key file (and there is no "keyfile" option). +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `legacy-bundling` * Default: false @@ -726,6 +913,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `legacy-peer-deps` * Default: false @@ -744,6 +934,9 @@ This differs from `--omit=peer`, in that `--omit=peer` will avoid unpacking Use of `legacy-peer-deps` is not recommended, as it will not enforce the `peerDependencies` contract that meta-dependencies may rely on. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `link` * Default: false @@ -751,6 +944,9 @@ Use of `legacy-peer-deps` is not recommended, as it will not enforce the Used with `npm ls`, limiting output to only those packages that are linked. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `local-address` * Default: null @@ -759,6 +955,9 @@ Used with `npm ls`, limiting output to only those packages that are linked. The IP address of the local interface to use when making connections to the npm registry. Must be IPv4 in versions of Node prior to 0.12. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `location` * Default: "user" unless `--global` is passed, which will also set this value @@ -767,6 +966,9 @@ npm registry. Must be IPv4 in versions of Node prior to 0.12. When passed to `npm config` this refers to which config file to use. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `loglevel` * Default: "notice" @@ -781,6 +983,9 @@ Any logs of a higher level than the setting are shown. The default is See also the `foreground-scripts` config. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `logs-max` * Default: 10 @@ -788,6 +993,9 @@ See also the `foreground-scripts` config. The maximum number of log files to store. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `long` * Default: false @@ -795,6 +1003,9 @@ The maximum number of log files to store. Show extended information in `ls`, `search`, and `help-search`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `maxsockets` * Default: 15 @@ -803,6 +1014,9 @@ Show extended information in `ls`, `search`, and `help-search`. The maximum number of connections to use per origin (protocol/host/port combination). +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `message` * Default: "%s" @@ -812,6 +1026,9 @@ Commit message which is used by `npm version` when creating version commit. Any "%s" in the message will be replaced with the version number. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `node-options` * Default: null @@ -821,6 +1038,9 @@ Options to pass through to Node.js via the `NODE_OPTIONS` environment variable. This does not impact how npm itself is executed but it does impact how lifecycle scripts are called. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `node-version` * Default: Node.js `process.version` value @@ -828,6 +1048,9 @@ how lifecycle scripts are called. The node version to use when checking a package's `engines` setting. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `noproxy` * Default: The value of the NO_PROXY environment variable @@ -837,6 +1060,9 @@ Domain extensions that should bypass any proxies. Also accepts a comma-delimited string. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `npm-version` * Default: Output of `npm --version` @@ -844,6 +1070,9 @@ Also accepts a comma-delimited string. The npm version to use when checking a package's `engines` setting. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `offline` * Default: false @@ -852,6 +1081,9 @@ The npm version to use when checking a package's `engines` setting. Force offline mode: no network requests will be done during install. To allow the CLI to fill in missing cache data, see `--prefer-offline`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `omit` * Default: 'dev' if the `NODE_ENV` environment variable is set to @@ -870,6 +1102,9 @@ it will be included. If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -881,6 +1116,9 @@ when publishing or changing package permissions with `npm access`. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `pack-destination` * Default: "." @@ -888,6 +1126,9 @@ password, npm will prompt on the command line for one. Directory in which `npm pack` will save tarballs. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package` * Default: @@ -895,6 +1136,9 @@ Directory in which `npm pack` will save tarballs. The package to install for [`npm exec`](/commands/npm-exec) +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock` * Default: true @@ -907,6 +1151,9 @@ When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock-only` * Default: false @@ -921,6 +1168,9 @@ instead of checking `node_modules` and downloading dependencies. For `list` this means the output will be based on the tree described by the `package-lock.json`, rather than the contents of `node_modules`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `parseable` * Default: false @@ -929,6 +1179,9 @@ For `list` this means the output will be based on the tree described by the Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `prefer-offline` * Default: false @@ -938,6 +1191,9 @@ If true, staleness checks for cached data will be bypassed, but missing data will be requested from the server. To force full offline mode, use `--offline`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `prefer-online` * Default: false @@ -946,6 +1202,9 @@ will be requested from the server. To force full offline mode, use If true, staleness checks for cached data will be forced, making the CLI look for updates immediately even for fresh package data. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `prefix` * Default: In global mode, the folder where the node executable is installed. @@ -956,6 +1215,9 @@ look for updates immediately even for fresh package data. The location to install global items. If set on the command line, then it forces non-global commands to run in the specified folder. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `preid` * Default: "" @@ -964,6 +1226,9 @@ forces non-global commands to run in the specified folder. The "prerelease identifier" to use as a prefix for the "prerelease" part of a semver. Like the `rc` in `1.2.0-rc.8`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `progress` * Default: `true` unless running in a known CI system @@ -974,6 +1239,9 @@ operations, if `process.stderr` is a TTY. Set to `false` to suppress the progress bar. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `proxy` * Default: null @@ -983,6 +1251,9 @@ A proxy to use for outgoing http requests. If the `HTTP_PROXY` or `http_proxy` environment variables are set, proxy settings will be honored by the underlying `request` library. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `read-only` * Default: false @@ -991,6 +1262,9 @@ by the underlying `request` library. This is used to mark a token as unable to publish when configuring limited access tokens with the `npm token create` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `rebuild-bundle` * Default: true @@ -998,6 +1272,9 @@ access tokens with the `npm token create` command. Rebuild bundled dependencies after installation. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `registry` * Default: "https://registry.npmjs.org/" @@ -1005,6 +1282,9 @@ Rebuild bundled dependencies after installation. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save` * Default: true @@ -1015,6 +1295,9 @@ Save installed packages to a package.json file as dependencies. When used with the `npm rm` command, removes the dependency from package.json. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-bundle` * Default: false @@ -1026,6 +1309,9 @@ If a package would be saved at install time by the use of `--save`, Ignore if `--save-peer` is set, since peerDependencies cannot be bundled. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-dev` * Default: false @@ -1033,6 +1319,9 @@ Ignore if `--save-peer` is set, since peerDependencies cannot be bundled. Save installed packages to a package.json file as `devDependencies`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-exact` * Default: false @@ -1041,6 +1330,9 @@ Save installed packages to a package.json file as `devDependencies`. Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-optional` * Default: false @@ -1048,6 +1340,9 @@ rather than using npm's default semver range operator. Save installed packages to a package.json file as `optionalDependencies`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-peer` * Default: false @@ -1055,6 +1350,9 @@ Save installed packages to a package.json file as `optionalDependencies`. Save installed packages. to a package.json file as `peerDependencies` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-prefix` * Default: "^" @@ -1068,6 +1366,9 @@ to `^1.2.3` which allows minor upgrades for that package, but after `npm config set save-prefix='~'` it would be set to `~1.2.3` which only allows patch upgrades. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-prod` * Default: false @@ -1080,6 +1381,9 @@ you want to move it to be a non-optional production dependency. This is the default behavior if `--save` is true, and neither `--save-dev` or `--save-optional` are true. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `scope` * Default: the scope of the current project, if any, or "" @@ -1110,6 +1414,9 @@ npm init --scope=@foo --yes ``` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -1118,6 +1425,9 @@ npm init --scope=@foo --yes The shell to use for scripts run with the `npm exec`, `npm run` and `npm init <pkg>` commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `searchexclude` * Default: "" @@ -1125,6 +1435,9 @@ init <pkg>` commands. Space-separated options that limit the results from search. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `searchlimit` * Default: 20 @@ -1133,6 +1446,9 @@ Space-separated options that limit the results from search. Number of items to limit search results to. Will not apply at all to legacy searches. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `searchopts` * Default: "" @@ -1140,6 +1456,9 @@ searches. Space-separated options that are always passed to search. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `searchstaleness` * Default: 900 @@ -1148,6 +1467,9 @@ Space-separated options that are always passed to search. The age of the cache, in seconds, before another registry request is made if using legacy search endpoint. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `shell` * Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on @@ -1156,6 +1478,9 @@ using legacy search endpoint. The shell to run for the `npm explore` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `sign-git-commit` * Default: false @@ -1167,6 +1492,9 @@ version using `-S` to add a signature. Note that git requires you to have set up GPG keys in your git configs for this to work properly. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `sign-git-tag` * Default: false @@ -1178,6 +1506,9 @@ If set to true, then the `npm version` command will tag the version using Note that git requires you to have set up GPG keys in your git configs for this to work properly. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `strict-peer-deps` * Default: false @@ -1197,6 +1528,9 @@ 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. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `strict-ssl` * Default: true @@ -1207,6 +1541,9 @@ via https. See also the `ca` config. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `tag` * Default: "latest" @@ -1221,6 +1558,9 @@ command, if no explicit tag is given. When used by the `npm diff` command, this is the tag used to fetch the tarball that will be compared with the local files by default. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `tag-version-prefix` * Default: "v" @@ -1234,6 +1574,9 @@ Because other tools may rely on the convention that npm version tags look like `v1.0.0`, _only use this property if it is absolutely necessary_. In particular, use care when overriding this setting for public packages. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `timing` * Default: false @@ -1246,6 +1589,9 @@ successfully. `_timing.json` is a newline delimited list of JSON objects. You can quickly view it with this [json](https://npm.im/json) command line: `npm exec -- json -g < ~/.npm/_timing.json`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `umask` * Default: 0 @@ -1266,6 +1612,9 @@ Thus, the effective default umask value on most POSIX systems is 0o22, meaning that folders and executables are created with a mode of 0o755 and other files are created with a mode of 0o644. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `unicode` * Default: false on windows, true on mac/unix systems with a unicode locale, @@ -1275,6 +1624,9 @@ other files are created with a mode of 0o644. When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `update-notifier` * Default: true @@ -1283,6 +1635,9 @@ false, it uses ascii characters instead of unicode glyphs. Set to false to suppress the update notification when using an older version of npm than the latest. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `usage` * Default: false @@ -1290,6 +1645,9 @@ of npm than the latest. Show short usage output about the command specified. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `user-agent` * Default: "npm/{npm-version} node/{node-version} {platform} {arch} @@ -1308,6 +1666,9 @@ their actual counterparts: * `{ci}` - The value of the `ci-name` config, if set, prefixed with `ci/`, or an empty string if `ci-name` is empty. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `userconfig` * Default: "~/.npmrc" @@ -1319,6 +1680,9 @@ This may be overridden by the `npm_config_userconfig` environment variable or the `--userconfig` command line option, but may _not_ be overridden by settings in the `globalconfig` file. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `version` * Default: false @@ -1328,6 +1692,9 @@ If true, output the npm version and exit successfully. Only relevant when specified explicitly on the command line. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `versions` * Default: false @@ -1339,6 +1706,9 @@ exists, and exit successfully. Only relevant when specified explicitly on the command line. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `viewer` * Default: "man" on Posix, "browser" on Windows @@ -1348,6 +1718,9 @@ The program to use to view help content. Set to `"browser"` to view html help content in the default web browser. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `which` * Default: null @@ -1355,6 +1728,9 @@ Set to `"browser"` to view html help content in the default web browser. If there are multiple funding sources, which 1-indexed source URL to open. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspace` * Default: @@ -1377,6 +1753,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -1387,6 +1766,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `yes` * Default: null @@ -1395,6 +1777,9 @@ This value is not exported to the environment for child processes. Automatically answer "yes" to any prompts that npm might print on the command line. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `also` * Default: null @@ -1403,6 +1788,9 @@ command line. When set to `dev` or `development`, this is an alias for `--include=dev`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `auth-type` * Default: "legacy" @@ -1412,6 +1800,9 @@ When set to `dev` or `development`, this is an alias for `--include=dev`. What authentication strategy to use with `adduser`/`login`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cache-max` * Default: Infinity @@ -1420,6 +1811,9 @@ What authentication strategy to use with `adduser`/`login`. `--cache-max=0` is an alias for `--prefer-online` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cache-min` * Default: 0 @@ -1428,6 +1822,9 @@ What authentication strategy to use with `adduser`/`login`. `--cache-min=9999 (or bigger)` is an alias for `--prefer-offline`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dev` * Default: false @@ -1436,6 +1833,9 @@ What authentication strategy to use with `adduser`/`login`. Alias for `--include=dev`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.author.email` * Default: "" @@ -1444,6 +1844,9 @@ Alias for `--include=dev`. Alias for `--init-author-email` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.author.name` * Default: "" @@ -1452,6 +1855,9 @@ Alias for `--init-author-email` Alias for `--init-author-name` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.author.url` * Default: "" @@ -1460,6 +1866,9 @@ Alias for `--init-author-name` Alias for `--init-author-url` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.license` * Default: "ISC" @@ -1468,6 +1877,9 @@ Alias for `--init-author-url` Alias for `--init-license` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.module` * Default: "~/.npm-init.js" @@ -1476,6 +1888,9 @@ Alias for `--init-license` Alias for `--init-module` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.version` * Default: "1.0.0" @@ -1484,6 +1899,9 @@ Alias for `--init-module` Alias for `--init-version` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `only` * Default: null @@ -1492,6 +1910,9 @@ Alias for `--init-version` When set to `prod` or `production`, this is an alias for `--omit=dev`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `optional` * Default: null @@ -1503,6 +1924,9 @@ Default value does install optional deps unless otherwise omitted. Alias for --include=optional or --omit=optional +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `production` * Default: null @@ -1511,6 +1935,9 @@ Alias for --include=optional or --omit=optional Alias for `--omit=dev` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `shrinkwrap` * Default: true @@ -1519,6 +1946,9 @@ Alias for `--omit=dev` Alias for --package-lock +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `sso-poll-frequency` * Default: 500 @@ -1529,6 +1959,9 @@ Alias for --package-lock When used with SSO-enabled `auth-type`s, configures how regularly the registry should be polled while the user is completing authentication. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `sso-type` * Default: "oauth" @@ -1538,6 +1971,9 @@ registry should be polled while the user is completing authentication. If `--auth-type=sso`, the type of SSO type to use. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `tmp` * Default: The value returned by the Node.js `os.tmpdir()` method @@ -1550,6 +1986,8 @@ If `--auth-type=sso`, the type of SSO type to use. Historically, the location where temporary files were stored. No longer relevant. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> <!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> ### See also diff --git a/deps/npm/docs/output/commands/npm-access.html b/deps/npm/docs/output/commands/npm-access.html index 68cd1973e5f..bfece57cd7e 100644 --- a/deps/npm/docs/output/commands/npm-access.html +++ b/deps/npm/docs/output/commands/npm-access.html @@ -219,12 +219,15 @@ fail with an HTTP 402 status code (logically enough), unless you use <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="otp"><code>otp</code></h4> <ul> <li>Default: null</li> @@ -235,6 +238,8 @@ when publishing or changing package permissions with <code>npm access</code>.</p <p>If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="https://npm.im/libnpmaccess"><code>libnpmaccess</code></a></li> diff --git a/deps/npm/docs/output/commands/npm-adduser.html b/deps/npm/docs/output/commands/npm-adduser.html index 27851b1dee7..99cf7d373bd 100644 --- a/deps/npm/docs/output/commands/npm-adduser.html +++ b/deps/npm/docs/output/commands/npm-adduser.html @@ -165,12 +165,15 @@ your existing record.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="scope"><code>scope</code></h4> <ul> <li>Default: the scope of the current project, if any, or “”</li> @@ -193,6 +196,8 @@ installation of packages specified according to the pattern npm init --scope=@foo --yes </code></pre> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../using-npm/registry.html">npm registry</a></li> diff --git a/deps/npm/docs/output/commands/npm-audit.html b/deps/npm/docs/output/commands/npm-audit.html index 5cffb546dc7..37bc32edd92 100644 --- a/deps/npm/docs/output/commands/npm-audit.html +++ b/deps/npm/docs/output/commands/npm-audit.html @@ -271,6 +271,7 @@ fixing anything:</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="audit-level"><code>audit-level</code></h4> <ul> <li>Default: null</li> @@ -278,6 +279,8 @@ fixing anything:</p> </ul> <p>The minimum level of vulnerability for <code>npm audit</code> to exit with a non-zero exit code.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dry-run"><code>dry-run</code></h4> <ul> <li>Default: false</li> @@ -289,6 +292,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, <code>owner</code>, etc.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="force"><code>force</code></h4> <ul> <li>Default: false</li> @@ -313,6 +318,8 @@ range (including SemVer-major changes).</li> </ul> <p>If you don’t have a clear idea of what you want to do, it is strongly recommended that you do not use this option!</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -324,6 +331,8 @@ recommended that you do not use this option!</p> saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package-lock-only"><code>package-lock-only</code></h4> <ul> <li>Default: false</li> @@ -335,6 +344,8 @@ ignoring <code>node_modules</code>.</p> instead of checking <code>node_modules</code> and downloading dependencies.</p> <p>For <code>list</code> this means the output will be based on the tree described by the <code>package-lock.json</code>, rather than the contents of <code>node_modules</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="omit"><code>omit</code></h4> <ul> <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to @@ -349,6 +360,8 @@ physically installed on disk.</p> it will be included.</p> <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment variable will be set to <code>'production'</code> for all lifecycle scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -368,6 +381,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -377,6 +392,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-install.html">npm install</a></li> diff --git a/deps/npm/docs/output/commands/npm-bin.html b/deps/npm/docs/output/commands/npm-bin.html index 32b8422f2ca..073b26d46db 100644 --- a/deps/npm/docs/output/commands/npm-bin.html +++ b/deps/npm/docs/output/commands/npm-bin.html @@ -153,6 +153,7 @@ npm command-line interface <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -168,6 +169,8 @@ of the current working directory.</li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-prefix.html">npm prefix</a></li> diff --git a/deps/npm/docs/output/commands/npm-bugs.html b/deps/npm/docs/output/commands/npm-bugs.html index db12c0445a8..e9e40aececb 100644 --- a/deps/npm/docs/output/commands/npm-bugs.html +++ b/deps/npm/docs/output/commands/npm-bugs.html @@ -157,6 +157,7 @@ will search for a <code>package.json</code> in the current folder and use the <c <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="browser"><code>browser</code></h4> <ul> <li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li> @@ -166,6 +167,8 @@ will search for a <code>package.json</code> in the current folder and use the <c <p>Set to <code>false</code> to suppress browser behavior and instead print urls to terminal.</p> <p>Set to <code>true</code> to use default system URL opener.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> @@ -173,6 +176,8 @@ terminal.</p> </ul> <p>The base URL of the npm registry.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-docs.html">npm docs</a></li> diff --git a/deps/npm/docs/output/commands/npm-cache.html b/deps/npm/docs/output/commands/npm-cache.html index 102d3ed1d01..a8c2ed8e7d4 100644 --- a/deps/npm/docs/output/commands/npm-cache.html +++ b/deps/npm/docs/output/commands/npm-cache.html @@ -206,6 +206,7 @@ data that was inserted.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="cache"><code>cache</code></h4> <ul> <li>Default: Windows: <code>%LocalAppData%\npm-cache</code>, Posix: <code>~/.npm</code></li> @@ -213,6 +214,8 @@ data that was inserted.</p> </ul> <p>The location of npm’s cache directory. See <a href="../commands/npm-cache.html"><code>npm cache</code></a></p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../configuring-npm/folders.html">npm folders</a></li> diff --git a/deps/npm/docs/output/commands/npm-ci.html b/deps/npm/docs/output/commands/npm-ci.html index 9f5c85b3637..e52cf55e9e6 100644 --- a/deps/npm/docs/output/commands/npm-ci.html +++ b/deps/npm/docs/output/commands/npm-ci.html @@ -193,6 +193,7 @@ cache: <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="audit"><code>audit</code></h4> <ul> <li>Default: true</li> @@ -202,6 +203,8 @@ cache: default registry and all registries configured for scopes. See the documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is submitted.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -212,6 +215,8 @@ submitted.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="script-shell"><code>script-shell</code></h4> <ul> <li>Default: ‘/bin/sh’ on POSIX systems, ‘cmd.exe’ on Windows</li> @@ -219,6 +224,8 @@ will <em>not</em> run any pre- or post-scripts.</p> </ul> <p>The shell to use for scripts run with the <code>npm exec</code>, <code>npm run</code> and <code>npm init <pkg></code> commands.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-install.html">npm install</a></li> diff --git a/deps/npm/docs/output/commands/npm-config.html b/deps/npm/docs/output/commands/npm-config.html index 8d6e1620720..cbf13aff8da 100644 --- a/deps/npm/docs/output/commands/npm-config.html +++ b/deps/npm/docs/output/commands/npm-config.html @@ -200,6 +200,7 @@ global config.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -211,6 +212,8 @@ global config.</p> saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -225,6 +228,8 @@ of the current working directory.</li> <li>bin files are linked to <code>{prefix}/bin</code></li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="editor"><code>editor</code></h4> <ul> <li>Default: The EDITOR or VISUAL environment variables, or ‘notepad.exe’ on @@ -232,6 +237,8 @@ Windows, or ‘vim’ on Unix systems</li> <li>Type: String</li> </ul> <p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="location"><code>location</code></h4> <ul> <li>Default: “user” unless <code>--global</code> is passed, which will also set this value @@ -239,6 +246,8 @@ to “global”</li> <li>Type: “global”, “user”, or “project”</li> </ul> <p>When passed to <code>npm config</code> this refers to which config file to use.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="long"><code>long</code></h4> <ul> <li>Default: false</li> @@ -246,6 +255,8 @@ to “global”</li> </ul> <p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../configuring-npm/folders.html">npm folders</a></li> diff --git a/deps/npm/docs/output/commands/npm-dedupe.html b/deps/npm/docs/output/commands/npm-dedupe.html index 9de232141e1..084bcc66228 100644 --- a/deps/npm/docs/output/commands/npm-dedupe.html +++ b/deps/npm/docs/output/commands/npm-dedupe.html @@ -194,6 +194,7 @@ result in new modules being installed.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global-style"><code>global-style</code></h4> <ul> <li>Default: false</li> @@ -205,6 +206,8 @@ direct dependencies will show in <code>node_modules</code> and everything they d on will be flattened in their <code>node_modules</code> folders. This obviously will eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code> will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="legacy-bundling"><code>legacy-bundling</code></h4> <ul> <li>Default: false</li> @@ -214,6 +217,8 @@ will be preferred.</p> such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with <code>global-style</code> this option will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4> <ul> <li>Default: false</li> @@ -230,6 +235,8 @@ the range set in their package’s <code>peerDependencies</code> object.</p> <p>When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then this warning is treated as a failure.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package-lock"><code>package-lock</code></h4> <ul> <li>Default: true</li> @@ -240,6 +247,8 @@ will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save< <p>When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use <code>npm prune</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="omit"><code>omit</code></h4> <ul> <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to @@ -254,6 +263,8 @@ physically installed on disk.</p> it will be included.</p> <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment variable will be set to <code>'production'</code> for all lifecycle scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -264,6 +275,8 @@ variable will be set to <code>'production'</code> for all lifecycle scripts.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="audit"><code>audit</code></h4> <ul> <li>Default: true</li> @@ -273,6 +286,8 @@ will <em>not</em> run any pre- or post-scripts.</p> default registry and all registries configured for scopes. See the documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is submitted.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="bin-links"><code>bin-links</code></h4> <ul> <li>Default: true</li> @@ -283,6 +298,8 @@ executables.</p> <p>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.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fund"><code>fund</code></h4> <ul> <li>Default: true</li> @@ -290,6 +307,8 @@ systems.</p> </ul> <p>When “true” displays the message at the end of each <code>npm install</code> acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dry-run"><code>dry-run</code></h4> <ul> <li>Default: false</li> @@ -301,6 +320,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, <code>owner</code>, etc.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -320,6 +341,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -329,6 +352,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-find-dupes.html">npm find-dupes</a></li> diff --git a/deps/npm/docs/output/commands/npm-deprecate.html b/deps/npm/docs/output/commands/npm-deprecate.html index 982c1e6ab82..9544eb5b95e 100644 --- a/deps/npm/docs/output/commands/npm-deprecate.html +++ b/deps/npm/docs/output/commands/npm-deprecate.html @@ -168,12 +168,15 @@ format an empty string.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="otp"><code>otp</code></h4> <ul> <li>Default: null</li> @@ -184,6 +187,8 @@ when publishing or changing package permissions with <code>npm access</code>.</p <p>If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-publish.html">npm publish</a></li> diff --git a/deps/npm/docs/output/commands/npm-diff.html b/deps/npm/docs/output/commands/npm-diff.html index 3f278d49015..63e4e67feee 100644 --- a/deps/npm/docs/output/commands/npm-diff.html +++ b/deps/npm/docs/output/commands/npm-diff.html @@ -260,30 +260,39 @@ located within the folder <code>./lib/</code> and changed lines of code within t <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff"><code>diff</code></h4> <ul> <li>Default:</li> <li>Type: String (can be set multiple times)</li> </ul> <p>Define arguments to compare in <code>npm diff</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-name-only"><code>diff-name-only</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Prints only filenames when using <code>npm diff</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-unified"><code>diff-unified</code></h4> <ul> <li>Default: 3</li> <li>Type: Number</li> </ul> <p>The number of lines of context to print in <code>npm diff</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-ignore-all-space"><code>diff-ignore-all-space</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Ignore whitespace when comparing lines in <code>npm diff</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-no-prefix"><code>diff-no-prefix</code></h4> <ul> <li>Default: false</li> @@ -292,24 +301,32 @@ located within the folder <code>./lib/</code> and changed lines of code within t <p>Do not show any source or destination prefix in <code>npm diff</code> output.</p> <p>Note: this causes <code>npm diff</code> to ignore the <code>--diff-src-prefix</code> and <code>--diff-dst-prefix</code> configs.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-src-prefix"><code>diff-src-prefix</code></h4> <ul> <li>Default: “a/”</li> <li>Type: String</li> </ul> <p>Source prefix to be used in <code>npm diff</code> output.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-dst-prefix"><code>diff-dst-prefix</code></h4> <ul> <li>Default: “b/”</li> <li>Type: String</li> </ul> <p>Destination prefix to be used in <code>npm diff</code> output.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-text"><code>diff-text</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Treat all files as text in <code>npm diff</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -324,6 +341,8 @@ of the current working directory.</li> <li>bin files are linked to <code>{prefix}/bin</code></li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="tag"><code>tag</code></h4> <ul> <li>Default: “latest”</li> @@ -335,6 +354,8 @@ then it will install the specified tag.</p> command, if no explicit tag is given.</p> <p>When used by the <code>npm diff</code> command, this is the tag used to fetch the tarball that will be compared with the local files by default.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -354,6 +375,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -363,6 +386,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h2 id="see-also">See Also</h2> <ul> <li><a href="../commands/npm-outdated.html">npm outdated</a></li> diff --git a/deps/npm/docs/output/commands/npm-dist-tag.html b/deps/npm/docs/output/commands/npm-dist-tag.html index 0b80bd8048b..d7b96250fa4 100644 --- a/deps/npm/docs/output/commands/npm-dist-tag.html +++ b/deps/npm/docs/output/commands/npm-dist-tag.html @@ -211,6 +211,7 @@ not begin with a number or the letter <code>v</code>.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -230,6 +231,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -239,6 +242,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-publish.html">npm publish</a></li> diff --git a/deps/npm/docs/output/commands/npm-docs.html b/deps/npm/docs/output/commands/npm-docs.html index ab740bfb0f6..b42b14d4e3a 100644 --- a/deps/npm/docs/output/commands/npm-docs.html +++ b/deps/npm/docs/output/commands/npm-docs.html @@ -158,6 +158,7 @@ the <code>name</code> property.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="browser"><code>browser</code></h4> <ul> <li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li> @@ -167,12 +168,16 @@ the <code>name</code> property.</p> <p>Set to <code>false</code> to suppress browser behavior and instead print urls to terminal.</p> <p>Set to <code>true</code> to use default system URL opener.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -192,6 +197,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -201,6 +208,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-view.html">npm view</a></li> diff --git a/deps/npm/docs/output/commands/npm-doctor.html b/deps/npm/docs/output/commands/npm-doctor.html index 4b4d572909a..9f81f5c83d7 100644 --- a/deps/npm/docs/output/commands/npm-doctor.html +++ b/deps/npm/docs/output/commands/npm-doctor.html @@ -224,6 +224,7 @@ reset the cache.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> @@ -231,6 +232,8 @@ reset the cache.</p> </ul> <p>The base URL of the npm registry.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-bugs.html">npm bugs</a></li> diff --git a/deps/npm/docs/output/commands/npm-edit.html b/deps/npm/docs/output/commands/npm-edit.html index 26b533ae509..5adf831eabf 100644 --- a/deps/npm/docs/output/commands/npm-edit.html +++ b/deps/npm/docs/output/commands/npm-edit.html @@ -160,6 +160,7 @@ changes to your locally installed copy.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="editor"><code>editor</code></h4> <ul> <li>Default: The EDITOR or VISUAL environment variables, or ‘notepad.exe’ on @@ -168,6 +169,8 @@ Windows, or ‘vim’ on Unix systems</li> </ul> <p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../configuring-npm/folders.html">npm folders</a></li> diff --git a/deps/npm/docs/output/commands/npm-exec.html b/deps/npm/docs/output/commands/npm-exec.html index 0a5993f7568..5ae53a8cb40 100644 --- a/deps/npm/docs/output/commands/npm-exec.html +++ b/deps/npm/docs/output/commands/npm-exec.html @@ -235,12 +235,15 @@ thus be equivalent to the <code>npx</code> command above:</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package"><code>package</code></h4> <ul> <li>Default:</li> <li>Type: String (can be set multiple times)</li> </ul> <p>The package to install for <a href="../commands/npm-exec.html"><code>npm exec</code></a></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="call"><code>call</code></h4> <ul> <li>Default: “”</li> @@ -250,6 +253,8 @@ thus be equivalent to the <code>npx</code> command above:</p> custom command to be run along with the installed packages.</p> <pre lang="bash"><code>npm exec --package yo --package generator-node --call "yo node" </code></pre> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -269,6 +274,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -278,6 +285,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="examples">Examples</h3> <p>Run the version of <code>tap</code> in the local dependencies, with the provided arguments:</p> diff --git a/deps/npm/docs/output/commands/npm-explain.html b/deps/npm/docs/output/commands/npm-explain.html index decfd4d556e..a62c45d323e 100644 --- a/deps/npm/docs/output/commands/npm-explain.html +++ b/deps/npm/docs/output/commands/npm-explain.html @@ -184,6 +184,7 @@ node_modules/nyc/node_modules/find-up <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -195,6 +196,8 @@ node_modules/nyc/node_modules/find-up saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -215,6 +218,8 @@ workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-config.html">npm config</a></li> diff --git a/deps/npm/docs/output/commands/npm-explore.html b/deps/npm/docs/output/commands/npm-explore.html index 69c5ec5c8ec..b5c2d1e8706 100644 --- a/deps/npm/docs/output/commands/npm-explore.html +++ b/deps/npm/docs/output/commands/npm-explore.html @@ -161,6 +161,7 @@ sure to use <code>npm rebuild <pkg></code> if you make any changes.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="shell"><code>shell</code></h4> <ul> <li>Default: SHELL environment variable, or “bash” on Posix, or “cmd.exe” on @@ -169,6 +170,8 @@ Windows</li> </ul> <p>The shell to run for the <code>npm explore</code> command.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../configuring-npm/folders.html">npm folders</a></li> diff --git a/deps/npm/docs/output/commands/npm-find-dupes.html b/deps/npm/docs/output/commands/npm-find-dupes.html index 9f6c4de7857..00f77f3d74f 100644 --- a/deps/npm/docs/output/commands/npm-find-dupes.html +++ b/deps/npm/docs/output/commands/npm-find-dupes.html @@ -153,6 +153,7 @@ duplications, without actually changing the package tree.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global-style"><code>global-style</code></h4> <ul> <li>Default: false</li> @@ -164,6 +165,8 @@ direct dependencies will show in <code>node_modules</code> and everything they d on will be flattened in their <code>node_modules</code> folders. This obviously will eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code> will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="legacy-bundling"><code>legacy-bundling</code></h4> <ul> <li>Default: false</li> @@ -173,6 +176,8 @@ will be preferred.</p> such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with <code>global-style</code> this option will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4> <ul> <li>Default: false</li> @@ -189,6 +194,8 @@ the range set in their package’s <code>peerDependencies</code> object.</p> <p>When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then this warning is treated as a failure.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package-lock"><code>package-lock</code></h4> <ul> <li>Default: true</li> @@ -199,6 +206,8 @@ will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save< <p>When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use <code>npm prune</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="omit"><code>omit</code></h4> <ul> <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to @@ -213,6 +222,8 @@ physically installed on disk.</p> it will be included.</p> <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment variable will be set to <code>'production'</code> for all lifecycle scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -223,6 +234,8 @@ variable will be set to <code>'production'</code> for all lifecycle scripts.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="audit"><code>audit</code></h4> <ul> <li>Default: true</li> @@ -232,6 +245,8 @@ will <em>not</em> run any pre- or post-scripts.</p> default registry and all registries configured for scopes. See the documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is submitted.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="bin-links"><code>bin-links</code></h4> <ul> <li>Default: true</li> @@ -242,6 +257,8 @@ executables.</p> <p>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.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fund"><code>fund</code></h4> <ul> <li>Default: true</li> @@ -249,6 +266,8 @@ systems.</p> </ul> <p>When “true” displays the message at the end of each <code>npm install</code> acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -268,6 +287,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -277,6 +298,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-dedupe.html">npm dedupe</a></li> diff --git a/deps/npm/docs/output/commands/npm-fund.html b/deps/npm/docs/output/commands/npm-fund.html index 074ac105735..0cebb018654 100644 --- a/deps/npm/docs/output/commands/npm-fund.html +++ b/deps/npm/docs/output/commands/npm-fund.html @@ -189,6 +189,7 @@ test-workspaces-fund@1.0.0 <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -200,6 +201,8 @@ test-workspaces-fund@1.0.0 saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="browser"><code>browser</code></h4> <ul> <li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li> @@ -209,6 +212,8 @@ saving them to your <code>package.json</code>.</li> <p>Set to <code>false</code> to suppress browser behavior and instead print urls to terminal.</p> <p>Set to <code>true</code> to use default system URL opener.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="unicode"><code>unicode</code></h4> <ul> <li>Default: false on windows, true on mac/unix systems with a unicode locale, @@ -217,6 +222,8 @@ as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</cod </ul> <p>When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -236,6 +243,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="which"><code>which</code></h4> <ul> <li>Default: null</li> @@ -243,6 +252,8 @@ brand new workspace within the project.</p> </ul> <p>If there are multiple funding sources, which 1-indexed source URL to open.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h2 id="see-also">See Also</h2> <ul> <li><a href="../commands/npm-install.html">npm install</a></li> diff --git a/deps/npm/docs/output/commands/npm-help-search.html b/deps/npm/docs/output/commands/npm-help-search.html index 2e69c210d41..1bef039df2d 100644 --- a/deps/npm/docs/output/commands/npm-help-search.html +++ b/deps/npm/docs/output/commands/npm-help-search.html @@ -158,6 +158,7 @@ directly.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="long"><code>long</code></h4> <ul> <li>Default: false</li> @@ -165,6 +166,8 @@ directly.</p> </ul> <p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm.html">npm</a></li> diff --git a/deps/npm/docs/output/commands/npm-help.html b/deps/npm/docs/output/commands/npm-help.html index a752fe2ec17..c171cb8ba0f 100644 --- a/deps/npm/docs/output/commands/npm-help.html +++ b/deps/npm/docs/output/commands/npm-help.html @@ -157,6 +157,7 @@ topic, so unique matches are equivalent to specifying a topic name.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="viewer"><code>viewer</code></h4> <ul> <li>Default: “man” on Posix, “browser” on Windows</li> @@ -165,6 +166,8 @@ topic, so unique matches are equivalent to specifying a topic name.</p> <p>The program to use to view help content.</p> <p>Set to <code>"browser"</code> to view html help content in the default web browser.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm.html">npm</a></li> diff --git a/deps/npm/docs/output/commands/npm-hook.html b/deps/npm/docs/output/commands/npm-hook.html index aa0d2a841d5..a247dacf0ae 100644 --- a/deps/npm/docs/output/commands/npm-hook.html +++ b/deps/npm/docs/output/commands/npm-hook.html @@ -192,12 +192,15 @@ the request came from your own configured hook.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="otp"><code>otp</code></h4> <ul> <li>Default: null</li> @@ -208,6 +211,8 @@ when publishing or changing package permissions with <code>npm access</code>.</p <p>If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm">“Introducing Hooks” blog post</a></li> diff --git a/deps/npm/docs/output/commands/npm-init.html b/deps/npm/docs/output/commands/npm-init.html index eaa5dfe0f72..b9733a3b529 100644 --- a/deps/npm/docs/output/commands/npm-init.html +++ b/deps/npm/docs/output/commands/npm-init.html @@ -246,6 +246,7 @@ dot to represent the current directory in that context, e.g: <code>react-app .</ <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="yes"><code>yes</code></h4> <ul> <li>Default: null</li> @@ -253,6 +254,8 @@ dot to represent the current directory in that context, e.g: <code>react-app .</ </ul> <p>Automatically answer “yes” to any prompts that npm might print on the command line.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="force"><code>force</code></h4> <ul> <li>Default: false</li> @@ -277,6 +280,8 @@ range (including SemVer-major changes).</li> </ul> <p>If you don’t have a clear idea of what you want to do, it is strongly recommended that you do not use this option!</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -296,6 +301,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -305,6 +312,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="http://npm.im/init-package-json">init-package-json module</a></li> diff --git a/deps/npm/docs/output/commands/npm-install-ci-test.html b/deps/npm/docs/output/commands/npm-install-ci-test.html index d7414ff56cf..46446a2e5bb 100644 --- a/deps/npm/docs/output/commands/npm-install-ci-test.html +++ b/deps/npm/docs/output/commands/npm-install-ci-test.html @@ -154,6 +154,7 @@ alias: npm cit <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="audit"><code>audit</code></h4> <ul> <li>Default: true</li> @@ -163,6 +164,8 @@ alias: npm cit default registry and all registries configured for scopes. See the documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is submitted.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -173,6 +176,8 @@ submitted.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="script-shell"><code>script-shell</code></h4> <ul> <li>Default: ‘/bin/sh’ on POSIX systems, ‘cmd.exe’ on Windows</li> @@ -180,6 +185,8 @@ will <em>not</em> run any pre- or post-scripts.</p> </ul> <p>The shell to use for scripts run with the <code>npm exec</code>, <code>npm run</code> and <code>npm init <pkg></code> commands.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-install-test.html">npm install-test</a></li> diff --git a/deps/npm/docs/output/commands/npm-install-test.html b/deps/npm/docs/output/commands/npm-install-test.html index d2f536e5d81..db0faf2fa15 100644 --- a/deps/npm/docs/output/commands/npm-install-test.html +++ b/deps/npm/docs/output/commands/npm-install-test.html @@ -163,6 +163,7 @@ takes exactly the same arguments as <code>npm install</code>.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save"><code>save</code></h4> <ul> <li>Default: true</li> @@ -171,6 +172,8 @@ takes exactly the same arguments as <code>npm install</code>.</p> <p>Save installed packages to a package.json file as dependencies.</p> <p>When used with the <code>npm rm</code> command, removes the dependency from package.json.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save-exact"><code>save-exact</code></h4> <ul> <li>Default: false</li> @@ -178,6 +181,8 @@ package.json.</p> </ul> <p>Dependencies saved to package.json will be configured with an exact version rather than using npm’s default semver range operator.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -192,6 +197,8 @@ of the current working directory.</li> <li>bin files are linked to <code>{prefix}/bin</code></li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global-style"><code>global-style</code></h4> <ul> <li>Default: false</li> @@ -203,6 +210,8 @@ direct dependencies will show in <code>node_modules</code> and everything they d on will be flattened in their <code>node_modules</code> folders. This obviously will eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code> will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="legacy-bundling"><code>legacy-bundling</code></h4> <ul> <li>Default: false</li> @@ -212,6 +221,8 @@ will be preferred.</p> such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with <code>global-style</code> this option will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4> <ul> <li>Default: false</li> @@ -228,6 +239,8 @@ the range set in their package’s <code>peerDependencies</code> object.</p> <p>When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then this warning is treated as a failure.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package-lock"><code>package-lock</code></h4> <ul> <li>Default: true</li> @@ -238,6 +251,8 @@ will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save< <p>When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use <code>npm prune</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="omit"><code>omit</code></h4> <ul> <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to @@ -252,6 +267,8 @@ physically installed on disk.</p> it will be included.</p> <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment variable will be set to <code>'production'</code> for all lifecycle scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -262,6 +279,8 @@ variable will be set to <code>'production'</code> for all lifecycle scripts.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="audit"><code>audit</code></h4> <ul> <li>Default: true</li> @@ -271,6 +290,8 @@ will <em>not</em> run any pre- or post-scripts.</p> default registry and all registries configured for scopes. See the documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is submitted.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="bin-links"><code>bin-links</code></h4> <ul> <li>Default: true</li> @@ -281,6 +302,8 @@ executables.</p> <p>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.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fund"><code>fund</code></h4> <ul> <li>Default: true</li> @@ -288,6 +311,8 @@ systems.</p> </ul> <p>When “true” displays the message at the end of each <code>npm install</code> acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dry-run"><code>dry-run</code></h4> <ul> <li>Default: false</li> @@ -299,6 +324,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, <code>owner</code>, etc.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -318,6 +345,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -327,6 +356,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-install.html">npm install</a></li> diff --git a/deps/npm/docs/output/commands/npm-install.html b/deps/npm/docs/output/commands/npm-install.html index cebc5ac780e..e33148691fd 100644 --- a/deps/npm/docs/output/commands/npm-install.html +++ b/deps/npm/docs/output/commands/npm-install.html @@ -485,6 +485,7 @@ does.</p> <p>These are some of the most common options related to installation.</p> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save"><code>save</code></h4> <ul> <li>Default: true</li> @@ -493,6 +494,8 @@ does.</p> <p>Save installed packages to a package.json file as dependencies.</p> <p>When used with the <code>npm rm</code> command, removes the dependency from package.json.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save-exact"><code>save-exact</code></h4> <ul> <li>Default: false</li> @@ -500,6 +503,8 @@ package.json.</p> </ul> <p>Dependencies saved to package.json will be configured with an exact version rather than using npm’s default semver range operator.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -514,6 +519,8 @@ of the current working directory.</li> <li>bin files are linked to <code>{prefix}/bin</code></li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global-style"><code>global-style</code></h4> <ul> <li>Default: false</li> @@ -525,6 +532,8 @@ direct dependencies will show in <code>node_modules</code> and everything they d on will be flattened in their <code>node_modules</code> folders. This obviously will eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code> will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="legacy-bundling"><code>legacy-bundling</code></h4> <ul> <li>Default: false</li> @@ -534,6 +543,8 @@ will be preferred.</p> such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with <code>global-style</code> this option will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4> <ul> <li>Default: false</li> @@ -550,6 +561,8 @@ the range set in their package’s <code>peerDependencies</code> object.</p> <p>When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then this warning is treated as a failure.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package-lock"><code>package-lock</code></h4> <ul> <li>Default: true</li> @@ -560,6 +573,8 @@ will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save< <p>When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use <code>npm prune</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="omit"><code>omit</code></h4> <ul> <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to @@ -574,6 +589,8 @@ physically installed on disk.</p> it will be included.</p> <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment variable will be set to <code>'production'</code> for all lifecycle scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -584,6 +601,8 @@ variable will be set to <code>'production'</code> for all lifecycle scripts.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="audit"><code>audit</code></h4> <ul> <li>Default: true</li> @@ -593,6 +612,8 @@ will <em>not</em> run any pre- or post-scripts.</p> default registry and all registries configured for scopes. See the documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is submitted.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="bin-links"><code>bin-links</code></h4> <ul> <li>Default: true</li> @@ -603,6 +624,8 @@ executables.</p> <p>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.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fund"><code>fund</code></h4> <ul> <li>Default: true</li> @@ -610,6 +633,8 @@ systems.</p> </ul> <p>When “true” displays the message at the end of each <code>npm install</code> acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dry-run"><code>dry-run</code></h4> <ul> <li>Default: false</li> @@ -621,6 +646,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, <code>owner</code>, etc.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -640,6 +667,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -649,6 +678,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="algorithm">Algorithm</h3> <p>Given a <code>package{dep}</code> structure: <code>A{B,C}, B{C}, C{D}</code>, the npm install algorithm produces:</p> diff --git a/deps/npm/docs/output/commands/npm-link.html b/deps/npm/docs/output/commands/npm-link.html index 6ac2699867e..ca480e8d856 100644 --- a/deps/npm/docs/output/commands/npm-link.html +++ b/deps/npm/docs/output/commands/npm-link.html @@ -219,6 +219,7 @@ workspace(s).</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save"><code>save</code></h4> <ul> <li>Default: true</li> @@ -227,6 +228,8 @@ workspace(s).</p> <p>Save installed packages to a package.json file as dependencies.</p> <p>When used with the <code>npm rm</code> command, removes the dependency from package.json.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save-exact"><code>save-exact</code></h4> <ul> <li>Default: false</li> @@ -234,6 +237,8 @@ package.json.</p> </ul> <p>Dependencies saved to package.json will be configured with an exact version rather than using npm’s default semver range operator.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -248,6 +253,8 @@ of the current working directory.</li> <li>bin files are linked to <code>{prefix}/bin</code></li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global-style"><code>global-style</code></h4> <ul> <li>Default: false</li> @@ -259,6 +266,8 @@ direct dependencies will show in <code>node_modules</code> and everything they d on will be flattened in their <code>node_modules</code> folders. This obviously will eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code> will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="legacy-bundling"><code>legacy-bundling</code></h4> <ul> <li>Default: false</li> @@ -268,6 +277,8 @@ will be preferred.</p> such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with <code>global-style</code> this option will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4> <ul> <li>Default: false</li> @@ -284,6 +295,8 @@ the range set in their package’s <code>peerDependencies</code> object.</p> <p>When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then this warning is treated as a failure.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package-lock"><code>package-lock</code></h4> <ul> <li>Default: true</li> @@ -294,6 +307,8 @@ will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save< <p>When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use <code>npm prune</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="omit"><code>omit</code></h4> <ul> <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to @@ -308,6 +323,8 @@ physically installed on disk.</p> it will be included.</p> <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment variable will be set to <code>'production'</code> for all lifecycle scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -318,6 +335,8 @@ variable will be set to <code>'production'</code> for all lifecycle scripts.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="audit"><code>audit</code></h4> <ul> <li>Default: true</li> @@ -327,6 +346,8 @@ will <em>not</em> run any pre- or post-scripts.</p> default registry and all registries configured for scopes. See the documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is submitted.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="bin-links"><code>bin-links</code></h4> <ul> <li>Default: true</li> @@ -337,6 +358,8 @@ executables.</p> <p>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.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fund"><code>fund</code></h4> <ul> <li>Default: true</li> @@ -344,6 +367,8 @@ systems.</p> </ul> <p>When “true” displays the message at the end of each <code>npm install</code> acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dry-run"><code>dry-run</code></h4> <ul> <li>Default: false</li> @@ -355,6 +380,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, <code>owner</code>, etc.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -374,6 +401,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -383,6 +412,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../using-npm/developers.html">npm developers</a></li> diff --git a/deps/npm/docs/output/commands/npm-logout.html b/deps/npm/docs/output/commands/npm-logout.html index d6ef8a0f2e0..ace122674d4 100644 --- a/deps/npm/docs/output/commands/npm-logout.html +++ b/deps/npm/docs/output/commands/npm-logout.html @@ -160,12 +160,15 @@ connected to that scope, if set.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="scope"><code>scope</code></h4> <ul> <li>Default: the scope of the current project, if any, or “”</li> @@ -188,6 +191,8 @@ installation of packages specified according to the pattern npm init --scope=@foo --yes </code></pre> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-adduser.html">npm adduser</a></li> diff --git a/deps/npm/docs/output/commands/npm-ls.html b/deps/npm/docs/output/commands/npm-ls.html index 324980536dc..fb05ec983d1 100644 --- a/deps/npm/docs/output/commands/npm-ls.html +++ b/deps/npm/docs/output/commands/npm-ls.html @@ -159,7 +159,7 @@ tree at all, use <a href="../commands/npm-explain.html"><code>npm explain</code> the results to only the paths to the packages named. Note that nested packages will <em>also</em> show the paths to the specified packages. For example, running <code>npm ls promzard</code> in npm’s source tree will show:</p> -<pre lang="bash"><code>npm@7.20.3 /path/to/npm +<pre lang="bash"><code>npm@7.21.0 /path/to/npm └─┬ init-package-json@0.0.4 └── promzard@0.1.5 </code></pre> @@ -194,6 +194,7 @@ least the default human-readable <code>npm ls</code> output in npm v8.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="all"><code>all</code></h4> <ul> <li>Default: false</li> @@ -202,6 +203,8 @@ least the default human-readable <code>npm ls</code> output in npm v8.</p> <p>When running <code>npm outdated</code> and <code>npm ls</code>, setting <code>--all</code> will show all outdated or installed packages, rather than only those directly depended upon by the current project.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -213,12 +216,16 @@ upon by the current project.</p> saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="long"><code>long</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="parseable"><code>parseable</code></h4> <ul> <li>Default: false</li> @@ -226,6 +233,8 @@ saving them to your <code>package.json</code>.</li> </ul> <p>Output parseable results from commands that write to standard output. For <code>npm search</code>, this will be tab-separated table format.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -240,6 +249,8 @@ of the current working directory.</li> <li>bin files are linked to <code>{prefix}/bin</code></li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="depth"><code>depth</code></h4> <ul> <li>Default: <code>Infinity</code> if <code>--all</code> is set, otherwise <code>1</code></li> @@ -248,6 +259,8 @@ of the current working directory.</li> <p>The depth to go when recursing packages for <code>npm ls</code>.</p> <p>If not set, <code>npm ls</code> will show only the immediate dependencies of the root project. If <code>--all</code> is set, then npm will show all dependencies by default.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="omit"><code>omit</code></h4> <ul> <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to @@ -262,12 +275,16 @@ physically installed on disk.</p> it will be included.</p> <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment variable will be set to <code>'production'</code> for all lifecycle scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="link"><code>link</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Used with <code>npm ls</code>, limiting output to only those packages that are linked.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package-lock-only"><code>package-lock-only</code></h4> <ul> <li>Default: false</li> @@ -279,6 +296,8 @@ ignoring <code>node_modules</code>.</p> instead of checking <code>node_modules</code> and downloading dependencies.</p> <p>For <code>list</code> this means the output will be based on the tree described by the <code>package-lock.json</code>, rather than the contents of <code>node_modules</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="unicode"><code>unicode</code></h4> <ul> <li>Default: false on windows, true on mac/unix systems with a unicode locale, @@ -287,6 +306,8 @@ as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</cod </ul> <p>When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -306,6 +327,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -315,6 +338,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-explain.html">npm explain</a></li> diff --git a/deps/npm/docs/output/commands/npm-org.html b/deps/npm/docs/output/commands/npm-org.html index b9b976f05f9..7bf7228cb9d 100644 --- a/deps/npm/docs/output/commands/npm-org.html +++ b/deps/npm/docs/output/commands/npm-org.html @@ -176,12 +176,15 @@ listing them, and finding specific ones and their roles.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="otp"><code>otp</code></h4> <ul> <li>Default: null</li> @@ -191,6 +194,8 @@ listing them, and finding specific ones and their roles.</p> when publishing or changing package permissions with <code>npm access</code>.</p> <p>If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -202,6 +207,8 @@ password, npm will prompt on the command line for one.</p> saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="parseable"><code>parseable</code></h4> <ul> <li>Default: false</li> @@ -210,6 +217,8 @@ saving them to your <code>package.json</code>.</li> <p>Output parseable results from commands that write to standard output. For <code>npm search</code>, this will be tab-separated table format.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../using-npm/orgs.html">using orgs</a></li> diff --git a/deps/npm/docs/output/commands/npm-outdated.html b/deps/npm/docs/output/commands/npm-outdated.html index 2584460fe6b..8b129712698 100644 --- a/deps/npm/docs/output/commands/npm-outdated.html +++ b/deps/npm/docs/output/commands/npm-outdated.html @@ -216,6 +216,7 @@ scratch or running <code>npm update</code> will bring it up to spec.</li> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="all"><code>all</code></h4> <ul> <li>Default: false</li> @@ -224,6 +225,8 @@ scratch or running <code>npm update</code> will bring it up to spec.</li> <p>When running <code>npm outdated</code> and <code>npm ls</code>, setting <code>--all</code> will show all outdated or installed packages, rather than only those directly depended upon by the current project.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -235,12 +238,16 @@ upon by the current project.</p> saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="long"><code>long</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="parseable"><code>parseable</code></h4> <ul> <li>Default: false</li> @@ -248,6 +255,8 @@ saving them to your <code>package.json</code>.</li> </ul> <p>Output parseable results from commands that write to standard output. For <code>npm search</code>, this will be tab-separated table format.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -262,6 +271,8 @@ of the current working directory.</li> <li>bin files are linked to <code>{prefix}/bin</code></li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -282,6 +293,8 @@ workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-update.html">npm update</a></li> diff --git a/deps/npm/docs/output/commands/npm-owner.html b/deps/npm/docs/output/commands/npm-owner.html index e959abfdae4..f12e9deb53c 100644 --- a/deps/npm/docs/output/commands/npm-owner.html +++ b/deps/npm/docs/output/commands/npm-owner.html @@ -171,12 +171,15 @@ on the command line when changing ownership with <code>--otp</code>.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="otp"><code>otp</code></h4> <ul> <li>Default: null</li> @@ -187,6 +190,8 @@ when publishing or changing package permissions with <code>npm access</code>.</p <p>If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-profile.html">npm profile</a></li> diff --git a/deps/npm/docs/output/commands/npm-pack.html b/deps/npm/docs/output/commands/npm-pack.html index a569ff799aa..0852c0becb6 100644 --- a/deps/npm/docs/output/commands/npm-pack.html +++ b/deps/npm/docs/output/commands/npm-pack.html @@ -150,6 +150,7 @@ npm command-line interface <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dry-run"><code>dry-run</code></h4> <ul> <li>Default: false</li> @@ -161,6 +162,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, <code>owner</code>, etc.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -172,12 +175,16 @@ commands that modify your local installation, eg, <code>install</code>, <code>up saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="pack-destination"><code>pack-destination</code></h4> <ul> <li>Default: “.”</li> <li>Type: String</li> </ul> <p>Directory in which <code>npm pack</code> will save tarballs.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -197,6 +204,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -206,6 +215,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="description">Description</h3> <p>For anything that’s installable (that is, a package folder, tarball, tarball url, git url, name@tag, name@version, name, or scoped name), this diff --git a/deps/npm/docs/output/commands/npm-ping.html b/deps/npm/docs/output/commands/npm-ping.html index eba27291520..95f3c5968c7 100644 --- a/deps/npm/docs/output/commands/npm-ping.html +++ b/deps/npm/docs/output/commands/npm-ping.html @@ -159,6 +159,7 @@ If it works it will output something like:</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> @@ -166,6 +167,8 @@ If it works it will output something like:</p> </ul> <p>The base URL of the npm registry.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-doctor.html">npm doctor</a></li> diff --git a/deps/npm/docs/output/commands/npm-pkg.html b/deps/npm/docs/output/commands/npm-pkg.html index f837cb310a6..3adab8936dc 100644 --- a/deps/npm/docs/output/commands/npm-pkg.html +++ b/deps/npm/docs/output/commands/npm-pkg.html @@ -255,6 +255,7 @@ returned from each of the configured workspaces, e.g:</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="force"><code>force</code></h4> <ul> <li>Default: false</li> @@ -279,6 +280,8 @@ range (including SemVer-major changes).</li> </ul> <p>If you don’t have a clear idea of what you want to do, it is strongly recommended that you do not use this option!</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -290,6 +293,8 @@ recommended that you do not use this option!</p> saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -309,6 +314,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -318,6 +325,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h2 id="see-also">See Also</h2> <ul> <li><a href="../commands/npm-install.html">npm install</a></li> diff --git a/deps/npm/docs/output/commands/npm-prefix.html b/deps/npm/docs/output/commands/npm-prefix.html index ff9d3e34ffd..63db4568175 100644 --- a/deps/npm/docs/output/commands/npm-prefix.html +++ b/deps/npm/docs/output/commands/npm-prefix.html @@ -164,6 +164,7 @@ also specified.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -179,6 +180,8 @@ of the current working directory.</li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-root.html">npm root</a></li> diff --git a/deps/npm/docs/output/commands/npm-profile.html b/deps/npm/docs/output/commands/npm-profile.html index 0c24fffead7..84bbd362f61 100644 --- a/deps/npm/docs/output/commands/npm-profile.html +++ b/deps/npm/docs/output/commands/npm-profile.html @@ -215,12 +215,15 @@ dist-tag, or changing access via <code>npm access</code> and <code>npm owner</co <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -232,6 +235,8 @@ dist-tag, or changing access via <code>npm access</code> and <code>npm owner</co saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="parseable"><code>parseable</code></h4> <ul> <li>Default: false</li> @@ -239,6 +244,8 @@ saving them to your <code>package.json</code>.</li> </ul> <p>Output parseable results from commands that write to standard output. For <code>npm search</code>, this will be tab-separated table format.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="otp"><code>otp</code></h4> <ul> <li>Default: null</li> @@ -249,6 +256,8 @@ when publishing or changing package permissions with <code>npm access</code>.</p <p>If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-adduser.html">npm adduser</a></li> diff --git a/deps/npm/docs/output/commands/npm-prune.html b/deps/npm/docs/output/commands/npm-prune.html index 2dcfe0e1ce5..cef16bf889e 100644 --- a/deps/npm/docs/output/commands/npm-prune.html +++ b/deps/npm/docs/output/commands/npm-prune.html @@ -166,6 +166,7 @@ this command can help clean up any resulting garbage.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="omit"><code>omit</code></h4> <ul> <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to @@ -180,6 +181,8 @@ physically installed on disk.</p> it will be included.</p> <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment variable will be set to <code>'production'</code> for all lifecycle scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dry-run"><code>dry-run</code></h4> <ul> <li>Default: false</li> @@ -191,6 +194,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, <code>owner</code>, etc.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -202,6 +207,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -221,6 +228,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -230,6 +239,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-uninstall.html">npm uninstall</a></li> diff --git a/deps/npm/docs/output/commands/npm-publish.html b/deps/npm/docs/output/commands/npm-publish.html index cff5dade6a5..e46684630ce 100644 --- a/deps/npm/docs/output/commands/npm-publish.html +++ b/deps/npm/docs/output/commands/npm-publish.html @@ -249,6 +249,7 @@ built.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="tag"><code>tag</code></h4> <ul> <li>Default: “latest”</li> @@ -260,6 +261,8 @@ then it will install the specified tag.</p> command, if no explicit tag is given.</p> <p>When used by the <code>npm diff</code> command, this is the tag used to fetch the tarball that will be compared with the local files by default.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="access"><code>access</code></h4> <ul> <li>Default: ‘restricted’ for scoped packages, ‘public’ for unscoped packages</li> @@ -269,6 +272,13 @@ tarball that will be compared with the local files by default.</p> If you want your scoped package to be publicly viewable (and installable) set <code>--access=public</code>. The only valid values for <code>access</code> are <code>public</code> and <code>restricted</code>. Unscoped packages <em>always</em> have an access level of <code>public</code>.</p> +<p>Note: Using the <code>--access</code> flag on the <code>npm publish</code> command will only set +the package access level on the initial publish of the package. Any +subsequent <code>npm publish</code> commands using the <code>--access</code> flag will not have an +effect to the access level. To make changes to the access level after the +initial publish use <code>npm access</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dry-run"><code>dry-run</code></h4> <ul> <li>Default: false</li> @@ -280,6 +290,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, <code>owner</code>, etc.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="otp"><code>otp</code></h4> <ul> <li>Default: null</li> @@ -289,6 +301,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up when publishing or changing package permissions with <code>npm access</code>.</p> <p>If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -308,6 +322,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -317,6 +333,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="http://npm.im/npm-packlist">npm-packlist package</a></li> diff --git a/deps/npm/docs/output/commands/npm-rebuild.html b/deps/npm/docs/output/commands/npm-rebuild.html index 44d2101a9ec..b446218c19f 100644 --- a/deps/npm/docs/output/commands/npm-rebuild.html +++ b/deps/npm/docs/output/commands/npm-rebuild.html @@ -161,6 +161,7 @@ will be rebuilt.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -175,6 +176,8 @@ of the current working directory.</li> <li>bin files are linked to <code>{prefix}/bin</code></li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="bin-links"><code>bin-links</code></h4> <ul> <li>Default: true</li> @@ -185,6 +188,8 @@ executables.</p> <p>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.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -195,6 +200,8 @@ systems.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -214,6 +221,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -223,6 +232,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-install.html">npm install</a></li> diff --git a/deps/npm/docs/output/commands/npm-repo.html b/deps/npm/docs/output/commands/npm-repo.html index 2702fa97dd7..84d63dbbfed 100644 --- a/deps/npm/docs/output/commands/npm-repo.html +++ b/deps/npm/docs/output/commands/npm-repo.html @@ -155,6 +155,7 @@ in the current folder and use the <code>repository</code> property.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="browser"><code>browser</code></h4> <ul> <li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li> @@ -164,6 +165,8 @@ in the current folder and use the <code>repository</code> property.</p> <p>Set to <code>false</code> to suppress browser behavior and instead print urls to terminal.</p> <p>Set to <code>true</code> to use default system URL opener.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -183,6 +186,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -192,6 +197,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-docs.html">npm docs</a></li> diff --git a/deps/npm/docs/output/commands/npm-restart.html b/deps/npm/docs/output/commands/npm-restart.html index e7e2729edb3..bebf3aa8916 100644 --- a/deps/npm/docs/output/commands/npm-restart.html +++ b/deps/npm/docs/output/commands/npm-restart.html @@ -171,6 +171,7 @@ npm command-line interface <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -181,6 +182,8 @@ npm command-line interface <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="script-shell"><code>script-shell</code></h4> <ul> <li>Default: ‘/bin/sh’ on POSIX systems, ‘cmd.exe’ on Windows</li> @@ -188,6 +191,8 @@ will <em>not</em> run any pre- or post-scripts.</p> </ul> <p>The shell to use for scripts run with the <code>npm exec</code>, <code>npm run</code> and <code>npm init <pkg></code> commands.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-run-script.html">npm run-script</a></li> diff --git a/deps/npm/docs/output/commands/npm-root.html b/deps/npm/docs/output/commands/npm-root.html index c56b042d9e0..57d40a3a05c 100644 --- a/deps/npm/docs/output/commands/npm-root.html +++ b/deps/npm/docs/output/commands/npm-root.html @@ -158,6 +158,7 @@ echo "Global packages installed in: ${global_node_modules}" <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -173,6 +174,8 @@ of the current working directory.</li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-prefix.html">npm prefix</a></li> diff --git a/deps/npm/docs/output/commands/npm-run-script.html b/deps/npm/docs/output/commands/npm-run-script.html index cbae66c2801..d99ea0ec014 100644 --- a/deps/npm/docs/output/commands/npm-run-script.html +++ b/deps/npm/docs/output/commands/npm-run-script.html @@ -236,6 +236,7 @@ packages.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -255,6 +256,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -263,6 +266,8 @@ brand new workspace within the project.</p> <p>Enable running a command in the context of <strong>all</strong> the configured workspaces.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="if-present"><code>if-present</code></h4> <ul> <li>Default: false</li> @@ -274,6 +279,8 @@ This option can be used when it’s desirable to optionally run a script when it’s present and fail if the script fails. This is useful, for example, when running scripts that may only apply for some builds in an otherwise generic CI setup.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -284,6 +291,8 @@ CI setup.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="script-shell"><code>script-shell</code></h4> <ul> <li>Default: ‘/bin/sh’ on POSIX systems, ‘cmd.exe’ on Windows</li> @@ -291,6 +300,8 @@ will <em>not</em> run any pre- or post-scripts.</p> </ul> <p>The shell to use for scripts run with the <code>npm exec</code>, <code>npm run</code> and <code>npm init <pkg></code> commands.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../using-npm/scripts.html">npm scripts</a></li> diff --git a/deps/npm/docs/output/commands/npm-search.html b/deps/npm/docs/output/commands/npm-search.html index 634229987f2..00b77dd6124 100644 --- a/deps/npm/docs/output/commands/npm-search.html +++ b/deps/npm/docs/output/commands/npm-search.html @@ -171,12 +171,15 @@ expression characters in most shells.)</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="long"><code>long</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -188,6 +191,8 @@ expression characters in most shells.)</p> saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="color"><code>color</code></h4> <ul> <li>Default: true unless the NO_COLOR environ is set to something other than ‘0’</li> @@ -195,6 +200,8 @@ saving them to your <code>package.json</code>.</li> </ul> <p>If false, never shows colors. If <code>"always"</code> then always shows colors. If true, then only prints color codes for tty file descriptors.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="parseable"><code>parseable</code></h4> <ul> <li>Default: false</li> @@ -202,30 +209,40 @@ true, then only prints color codes for tty file descriptors.</p> </ul> <p>Output parseable results from commands that write to standard output. For <code>npm search</code>, this will be tab-separated table format.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="description2"><code>description</code></h4> <ul> <li>Default: true</li> <li>Type: Boolean</li> </ul> <p>Show the description in <code>npm search</code></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="searchopts"><code>searchopts</code></h4> <ul> <li>Default: “”</li> <li>Type: String</li> </ul> <p>Space-separated options that are always passed to search.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="searchexclude"><code>searchexclude</code></h4> <ul> <li>Default: “”</li> <li>Type: String</li> </ul> <p>Space-separated options that limit the results from search.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="prefer-online"><code>prefer-online</code></h4> <ul> <li>Default: false</li> @@ -233,6 +250,8 @@ true, then only prints color codes for tty file descriptors.</p> </ul> <p>If true, staleness checks for cached data will be forced, making the CLI look for updates immediately even for fresh package data.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="prefer-offline"><code>prefer-offline</code></h4> <ul> <li>Default: false</li> @@ -241,6 +260,8 @@ look for updates immediately even for fresh package data.</p> <p>If true, staleness checks for cached data will be bypassed, but missing data will be requested from the server. To force full offline mode, use <code>--offline</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="offline"><code>offline</code></h4> <ul> <li>Default: false</li> @@ -249,6 +270,8 @@ will be requested from the server. To force full offline mode, use <p>Force offline mode: no network requests will be done during install. To allow the CLI to fill in missing cache data, see <code>--prefer-offline</code>.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../using-npm/registry.html">npm registry</a></li> diff --git a/deps/npm/docs/output/commands/npm-set-script.html b/deps/npm/docs/output/commands/npm-set-script.html index 1de9ec1f6a8..a0bf20fd178 100644 --- a/deps/npm/docs/output/commands/npm-set-script.html +++ b/deps/npm/docs/output/commands/npm-set-script.html @@ -163,6 +163,7 @@ npm command-line interface <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -182,6 +183,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -191,6 +194,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-run-script.html">npm run-script</a></li> diff --git a/deps/npm/docs/output/commands/npm-star.html b/deps/npm/docs/output/commands/npm-star.html index 5e5825a3b7d..8b41c7d5834 100644 --- a/deps/npm/docs/output/commands/npm-star.html +++ b/deps/npm/docs/output/commands/npm-star.html @@ -162,12 +162,15 @@ a vaguely positive way to show that you care.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="unicode"><code>unicode</code></h4> <ul> <li>Default: false on windows, true on mac/unix systems with a unicode locale, @@ -177,6 +180,8 @@ as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</cod <p>When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-unstar.html">npm unstar</a></li> diff --git a/deps/npm/docs/output/commands/npm-stars.html b/deps/npm/docs/output/commands/npm-stars.html index 64d306b23a0..8603cbd45a1 100644 --- a/deps/npm/docs/output/commands/npm-stars.html +++ b/deps/npm/docs/output/commands/npm-stars.html @@ -156,6 +156,7 @@ you will most certainly enjoy this command.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> @@ -163,6 +164,8 @@ you will most certainly enjoy this command.</p> </ul> <p>The base URL of the npm registry.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-star.html">npm star</a></li> diff --git a/deps/npm/docs/output/commands/npm-start.html b/deps/npm/docs/output/commands/npm-start.html index 4d0cc57a5b3..2ba04689430 100644 --- a/deps/npm/docs/output/commands/npm-start.html +++ b/deps/npm/docs/output/commands/npm-start.html @@ -175,6 +175,7 @@ use custom arguments when executing scripts. Refer to <a href="../commands/npm-r <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -185,6 +186,8 @@ use custom arguments when executing scripts. Refer to <a href="../commands/npm-r <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="script-shell"><code>script-shell</code></h4> <ul> <li>Default: ‘/bin/sh’ on POSIX systems, ‘cmd.exe’ on Windows</li> @@ -192,6 +195,8 @@ will <em>not</em> run any pre- or post-scripts.</p> </ul> <p>The shell to use for scripts run with the <code>npm exec</code>, <code>npm run</code> and <code>npm init <pkg></code> commands.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-run-script.html">npm run-script</a></li> diff --git a/deps/npm/docs/output/commands/npm-stop.html b/deps/npm/docs/output/commands/npm-stop.html index b821cb27cae..dc2b6895799 100644 --- a/deps/npm/docs/output/commands/npm-stop.html +++ b/deps/npm/docs/output/commands/npm-stop.html @@ -170,6 +170,7 @@ that will run if the <code>"stop"</code> property is not defined.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -180,6 +181,8 @@ that will run if the <code>"stop"</code> property is not defined.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="script-shell"><code>script-shell</code></h4> <ul> <li>Default: ‘/bin/sh’ on POSIX systems, ‘cmd.exe’ on Windows</li> @@ -187,6 +190,8 @@ will <em>not</em> run any pre- or post-scripts.</p> </ul> <p>The shell to use for scripts run with the <code>npm exec</code>, <code>npm run</code> and <code>npm init <pkg></code> commands.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-run-script.html">npm run-script</a></li> diff --git a/deps/npm/docs/output/commands/npm-team.html b/deps/npm/docs/output/commands/npm-team.html index 3e0d06db228..cc084773795 100644 --- a/deps/npm/docs/output/commands/npm-team.html +++ b/deps/npm/docs/output/commands/npm-team.html @@ -219,12 +219,15 @@ use the <code>npm access</code> command to grant or revoke the appropriate permi <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="otp"><code>otp</code></h4> <ul> <li>Default: null</li> @@ -234,6 +237,8 @@ use the <code>npm access</code> command to grant or revoke the appropriate permi when publishing or changing package permissions with <code>npm access</code>.</p> <p>If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="parseable"><code>parseable</code></h4> <ul> <li>Default: false</li> @@ -241,6 +246,8 @@ password, npm will prompt on the command line for one.</p> </ul> <p>Output parseable results from commands that write to standard output. For <code>npm search</code>, this will be tab-separated table format.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -253,6 +260,8 @@ saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-access.html">npm access</a></li> diff --git a/deps/npm/docs/output/commands/npm-test.html b/deps/npm/docs/output/commands/npm-test.html index e2d0f39bc3c..9d0590fc305 100644 --- a/deps/npm/docs/output/commands/npm-test.html +++ b/deps/npm/docs/output/commands/npm-test.html @@ -168,6 +168,7 @@ a package’s <code>"scripts"</code> object.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -178,6 +179,8 @@ a package’s <code>"scripts"</code> object.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="script-shell"><code>script-shell</code></h4> <ul> <li>Default: ‘/bin/sh’ on POSIX systems, ‘cmd.exe’ on Windows</li> @@ -185,6 +188,8 @@ will <em>not</em> run any pre- or post-scripts.</p> </ul> <p>The shell to use for scripts run with the <code>npm exec</code>, <code>npm run</code> and <code>npm init <pkg></code> commands.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-run-script.html">npm run-script</a></li> diff --git a/deps/npm/docs/output/commands/npm-token.html b/deps/npm/docs/output/commands/npm-token.html index eb509831502..57842ff50a8 100644 --- a/deps/npm/docs/output/commands/npm-token.html +++ b/deps/npm/docs/output/commands/npm-token.html @@ -212,6 +212,7 @@ found in the normal <code>npm token list</code> output.</li> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="read-only"><code>read-only</code></h4> <ul> <li>Default: false</li> @@ -219,6 +220,8 @@ found in the normal <code>npm token list</code> output.</li> </ul> <p>This is used to mark a token as unable to publish when configuring limited access tokens with the <code>npm token create</code> command.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="cidr"><code>cidr</code></h4> <ul> <li>Default: null</li> @@ -226,12 +229,16 @@ access tokens with the <code>npm token create</code> command.</p> </ul> <p>This is a list of CIDR address to be used when configuring limited access tokens with the <code>npm token create</code> command.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="otp"><code>otp</code></h4> <ul> <li>Default: null</li> @@ -242,6 +249,8 @@ when publishing or changing package permissions with <code>npm access</code>.</p <p>If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-adduser.html">npm adduser</a></li> diff --git a/deps/npm/docs/output/commands/npm-uninstall.html b/deps/npm/docs/output/commands/npm-uninstall.html index 0fd8a52b285..be2c7b53c75 100644 --- a/deps/npm/docs/output/commands/npm-uninstall.html +++ b/deps/npm/docs/output/commands/npm-uninstall.html @@ -179,6 +179,7 @@ it uninstalls the current package context as a global package. <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save"><code>save</code></h4> <ul> <li>Default: true</li> @@ -187,6 +188,8 @@ it uninstalls the current package context as a global package. <p>Save installed packages to a package.json file as dependencies.</p> <p>When used with the <code>npm rm</code> command, removes the dependency from package.json.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -206,6 +209,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -215,6 +220,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-prune.html">npm prune</a></li> diff --git a/deps/npm/docs/output/commands/npm-unpublish.html b/deps/npm/docs/output/commands/npm-unpublish.html index 3d330e9db5f..80748d9867d 100644 --- a/deps/npm/docs/output/commands/npm-unpublish.html +++ b/deps/npm/docs/output/commands/npm-unpublish.html @@ -171,6 +171,7 @@ passed.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dry-run"><code>dry-run</code></h4> <ul> <li>Default: false</li> @@ -182,6 +183,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, <code>owner</code>, etc.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="force"><code>force</code></h4> <ul> <li>Default: false</li> @@ -206,6 +209,8 @@ range (including SemVer-major changes).</li> </ul> <p>If you don’t have a clear idea of what you want to do, it is strongly recommended that you do not use this option!</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -225,6 +230,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -234,6 +241,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-deprecate.html">npm deprecate</a></li> diff --git a/deps/npm/docs/output/commands/npm-unstar.html b/deps/npm/docs/output/commands/npm-unstar.html index 85b41d77929..15b78217436 100644 --- a/deps/npm/docs/output/commands/npm-unstar.html +++ b/deps/npm/docs/output/commands/npm-unstar.html @@ -160,12 +160,15 @@ it removes an item from your list of favorite packages.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="unicode"><code>unicode</code></h4> <ul> <li>Default: false on windows, true on mac/unix systems with a unicode locale, @@ -174,6 +177,8 @@ as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</cod </ul> <p>When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="otp"><code>otp</code></h4> <ul> <li>Default: null</li> @@ -184,6 +189,8 @@ when publishing or changing package permissions with <code>npm access</code>.</p <p>If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-star.html">npm star</a></li> diff --git a/deps/npm/docs/output/commands/npm-update.html b/deps/npm/docs/output/commands/npm-update.html index f2491347aee..b24f8812817 100644 --- a/deps/npm/docs/output/commands/npm-update.html +++ b/deps/npm/docs/output/commands/npm-update.html @@ -247,6 +247,7 @@ be <em>downgraded</em>.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -261,6 +262,8 @@ of the current working directory.</li> <li>bin files are linked to <code>{prefix}/bin</code></li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global-style"><code>global-style</code></h4> <ul> <li>Default: false</li> @@ -272,6 +275,8 @@ direct dependencies will show in <code>node_modules</code> and everything they d on will be flattened in their <code>node_modules</code> folders. This obviously will eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code> will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="legacy-bundling"><code>legacy-bundling</code></h4> <ul> <li>Default: false</li> @@ -281,6 +286,8 @@ will be preferred.</p> such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with <code>global-style</code> this option will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4> <ul> <li>Default: false</li> @@ -297,6 +304,8 @@ the range set in their package’s <code>peerDependencies</code> object.</p> <p>When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then this warning is treated as a failure.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package-lock"><code>package-lock</code></h4> <ul> <li>Default: true</li> @@ -307,6 +316,8 @@ will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save< <p>When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use <code>npm prune</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="omit"><code>omit</code></h4> <ul> <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to @@ -321,6 +332,8 @@ physically installed on disk.</p> it will be included.</p> <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment variable will be set to <code>'production'</code> for all lifecycle scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -331,6 +344,8 @@ variable will be set to <code>'production'</code> for all lifecycle scripts.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="audit"><code>audit</code></h4> <ul> <li>Default: true</li> @@ -340,6 +355,8 @@ will <em>not</em> run any pre- or post-scripts.</p> default registry and all registries configured for scopes. See the documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is submitted.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="bin-links"><code>bin-links</code></h4> <ul> <li>Default: true</li> @@ -350,6 +367,8 @@ executables.</p> <p>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.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fund"><code>fund</code></h4> <ul> <li>Default: true</li> @@ -357,6 +376,8 @@ systems.</p> </ul> <p>When “true” displays the message at the end of each <code>npm install</code> acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dry-run"><code>dry-run</code></h4> <ul> <li>Default: false</li> @@ -368,6 +389,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, <code>owner</code>, etc.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -387,6 +410,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -396,6 +421,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-install.html">npm install</a></li> diff --git a/deps/npm/docs/output/commands/npm-version.html b/deps/npm/docs/output/commands/npm-version.html index c81569608d5..8afab365cc7 100644 --- a/deps/npm/docs/output/commands/npm-version.html +++ b/deps/npm/docs/output/commands/npm-version.html @@ -154,6 +154,7 @@ npm command-line interface <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="allow-same-version"><code>allow-same-version</code></h4> <ul> <li>Default: false</li> @@ -161,18 +162,24 @@ npm command-line interface </ul> <p>Prevents throwing an error when <code>npm version</code> is used to set the new version to the same value as the current version.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="commit-hooks"><code>commit-hooks</code></h4> <ul> <li>Default: true</li> <li>Type: Boolean</li> </ul> <p>Run git commit hooks when using the <code>npm version</code> command.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="git-tag-version"><code>git-tag-version</code></h4> <ul> <li>Default: true</li> <li>Type: Boolean</li> </ul> <p>Tag the commit when using the <code>npm version</code> command.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -184,6 +191,8 @@ to the same value as the current version.</p> saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="preid"><code>preid</code></h4> <ul> <li>Default: “”</li> @@ -191,6 +200,8 @@ saving them to your <code>package.json</code>.</li> </ul> <p>The “prerelease identifier” to use as a prefix for the “prerelease” part of a semver. Like the <code>rc</code> in <code>1.2.0-rc.8</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="sign-git-tag"><code>sign-git-tag</code></h4> <ul> <li>Default: false</li> @@ -200,6 +211,8 @@ a semver. Like the <code>rc</code> in <code>1.2.0-rc.8</code>.</p> <code>-s</code> to add a signature.</p> <p>Note that git requires you to have set up GPG keys in your git configs for this to work properly.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -219,6 +232,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -228,6 +243,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="description">Description</h3> <p>Run this in a package directory to bump the version and write the new data back to <code>package.json</code>, <code>package-lock.json</code>, and, if present, diff --git a/deps/npm/docs/output/commands/npm-view.html b/deps/npm/docs/output/commands/npm-view.html index 1a0eba4c143..25dd5e6b97d 100644 --- a/deps/npm/docs/output/commands/npm-view.html +++ b/deps/npm/docs/output/commands/npm-view.html @@ -201,6 +201,7 @@ this:</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -212,6 +213,8 @@ this:</p> saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -231,6 +234,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -240,6 +245,8 @@ brand new workspace within the project.</p> workspaces.</p> <p>This value is not exported to the environment for child processes.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="output">Output</h3> <p>If only a single string field for a single version is output, then it will not be colorized or quoted, to enable piping the output to diff --git a/deps/npm/docs/output/commands/npm-whoami.html b/deps/npm/docs/output/commands/npm-whoami.html index 2b98709d100..78506273258 100644 --- a/deps/npm/docs/output/commands/npm-whoami.html +++ b/deps/npm/docs/output/commands/npm-whoami.html @@ -158,6 +158,7 @@ associated with the token, and print to standard output.</p> <h3 id="configuration">Configuration</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> @@ -165,6 +166,8 @@ associated with the token, and print to standard output.</p> </ul> <p>The base URL of the npm registry.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See Also</h3> <ul> <li><a href="../commands/npm-config.html">npm config</a></li> diff --git a/deps/npm/docs/output/commands/npm.html b/deps/npm/docs/output/commands/npm.html index 672238cee09..cb00df323df 100644 --- a/deps/npm/docs/output/commands/npm.html +++ b/deps/npm/docs/output/commands/npm.html @@ -148,7 +148,7 @@ npm command-line interface <pre lang="bash"><code>npm <command> [args] </code></pre> <h3 id="version">Version</h3> -<p>7.20.3</p> +<p>7.21.0</p> <h3 id="description">Description</h3> <p>npm is the package manager for the Node JavaScript platform. It puts modules in place so that node can find them, and manages dependency diff --git a/deps/npm/docs/output/configuring-npm/package-json.html b/deps/npm/docs/output/configuring-npm/package-json.html index f7e5555b573..9c1bb63efe5 100644 --- a/deps/npm/docs/output/configuring-npm/package-json.html +++ b/deps/npm/docs/output/configuring-npm/package-json.html @@ -358,12 +358,10 @@ through <code>.npmignore</code> or <code>.gitignore</code>.</p> <ul> <li><code>package.json</code></li> <li><code>README</code></li> -<li><code>CHANGES</code> / <code>CHANGELOG</code> / <code>HISTORY</code></li> <li><code>LICENSE</code> / <code>LICENCE</code></li> -<li><code>NOTICE</code></li> <li>The file in the “main” field</li> </ul> -<p><code>README</code>, <code>CHANGES</code>, <code>LICENSE</code> & <code>NOTICE</code> can have any case and extension.</p> +<p><code>README</code> & <code>LICENSE</code> can have any case and extension.</p> <p>Conversely, some files are always ignored:</p> <ul> <li><code>.git</code></li> diff --git a/deps/npm/docs/output/using-npm/config.html b/deps/npm/docs/output/using-npm/config.html index 76a92f5dd1c..eb8a7712e5c 100644 --- a/deps/npm/docs/output/using-npm/config.html +++ b/deps/npm/docs/output/using-npm/config.html @@ -187,6 +187,7 @@ internal to npm, and are defaults if nothing else is specified.</p> <p>The following shorthands are parsed on the command-line:</p> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <ul> <li><code>-a</code>: <code>--all</code></li> <li><code>--enjoy-by</code>: <code>--before</code></li> @@ -229,6 +230,8 @@ internal to npm, and are defaults if nothing else is specified.</p> <li><code>-y</code>: <code>--yes</code></li> </ul> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <p>If the specified configuration param resolves unambiguously to a known configuration parameter, then it is expanded to that configuration parameter. For example:</p> @@ -247,6 +250,7 @@ npm ls --global --parseable --long --loglevel info <h3 id="config-settings">Config Settings</h3> <!-- raw HTML omitted --> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="auth"><code>_auth</code></h4> <ul> <li>Default: null</li> @@ -256,6 +260,8 @@ npm ls --global --parseable --long --loglevel info <p>Warning: This should generally not be set via a command-line option. It is safer to use a registry-provided authentication bearer token stored in the ~/.npmrc file by running <code>npm login</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="access"><code>access</code></h4> <ul> <li>Default: ‘restricted’ for scoped packages, ‘public’ for unscoped packages</li> @@ -265,6 +271,13 @@ safer to use a registry-provided authentication bearer token stored in the If you want your scoped package to be publicly viewable (and installable) set <code>--access=public</code>. The only valid values for <code>access</code> are <code>public</code> and <code>restricted</code>. Unscoped packages <em>always</em> have an access level of <code>public</code>.</p> +<p>Note: Using the <code>--access</code> flag on the <code>npm publish</code> command will only set +the package access level on the initial publish of the package. Any +subsequent <code>npm publish</code> commands using the <code>--access</code> flag will not have an +effect to the access level. To make changes to the access level after the +initial publish use <code>npm access</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="all"><code>all</code></h4> <ul> <li>Default: false</li> @@ -273,6 +286,8 @@ set <code>--access=public</code>. The only valid values for <code>access</code> <p>When running <code>npm outdated</code> and <code>npm ls</code>, setting <code>--all</code> will show all outdated or installed packages, rather than only those directly depended upon by the current project.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="allow-same-version"><code>allow-same-version</code></h4> <ul> <li>Default: false</li> @@ -280,6 +295,8 @@ upon by the current project.</p> </ul> <p>Prevents throwing an error when <code>npm version</code> is used to set the new version to the same value as the current version.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="audit"><code>audit</code></h4> <ul> <li>Default: true</li> @@ -289,6 +306,8 @@ to the same value as the current version.</p> default registry and all registries configured for scopes. See the documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is submitted.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="audit-level"><code>audit-level</code></h4> <ul> <li>Default: null</li> @@ -296,6 +315,8 @@ submitted.</p> </ul> <p>The minimum level of vulnerability for <code>npm audit</code> to exit with a non-zero exit code.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="before"><code>before</code></h4> <ul> <li>Default: null</li> @@ -309,6 +330,8 @@ dependencies, the command will error.</p> <code>--before</code> filter, the most recent version less than or equal to that tag will be used. For example, <code>foo@latest</code> might install <code>foo@1.2</code> even though <code>latest</code> is <code>2.0</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="bin-links"><code>bin-links</code></h4> <ul> <li>Default: true</li> @@ -319,6 +342,8 @@ executables.</p> <p>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.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="browser"><code>browser</code></h4> <ul> <li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li> @@ -328,6 +353,8 @@ systems.</p> <p>Set to <code>false</code> to suppress browser behavior and instead print urls to terminal.</p> <p>Set to <code>true</code> to use default system URL opener.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ca"><code>ca</code></h4> <ul> <li>Default: null</li> @@ -346,12 +373,16 @@ trust only that specific signing authority.</p> ca[]="..." </code></pre> <p>See also the <code>strict-ssl</code> config.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="cache"><code>cache</code></h4> <ul> <li>Default: Windows: <code>%LocalAppData%\npm-cache</code>, Posix: <code>~/.npm</code></li> <li>Type: Path</li> </ul> <p>The location of npm’s cache directory. See <a href="../commands/npm-cache.html"><code>npm cache</code></a></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="cafile"><code>cafile</code></h4> <ul> <li>Default: null</li> @@ -360,6 +391,8 @@ ca[]="..." <p>A path to a file containing one or multiple Certificate Authority signing certificates. Similar to the <code>ca</code> setting, but allows for multiple CA’s, as well as for the CA information to be stored in a file on disk.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="call"><code>call</code></h4> <ul> <li>Default: “”</li> @@ -369,6 +402,8 @@ well as for the CA information to be stored in a file on disk.</p> custom command to be run along with the installed packages.</p> <pre lang="bash"><code>npm exec --package yo --package generator-node --call "yo node" </code></pre> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="cert"><code>cert</code></h4> <ul> <li>Default: null</li> @@ -381,6 +416,8 @@ newlines replaced by the string “\n”. For example:</p> </code></pre> <p>It is <em>not</em> the path to a certificate file (and there is no “certfile” option).</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ci-name"><code>ci-name</code></h4> <ul> <li>Default: The name of the current CI system, or <code>null</code> when not on a known CI @@ -390,6 +427,8 @@ platform.</li> <p>The name of a continuous integration system. If not set explicitly, npm will detect the current CI environment using the <a href="http://npm.im/@npmcli/ci-detect"><code>@npmcli/ci-detect</code></a> module.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="cidr"><code>cidr</code></h4> <ul> <li>Default: null</li> @@ -397,6 +436,8 @@ detect the current CI environment using the </ul> <p>This is a list of CIDR address to be used when configuring limited access tokens with the <code>npm token create</code> command.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="color"><code>color</code></h4> <ul> <li>Default: true unless the NO_COLOR environ is set to something other than ‘0’</li> @@ -404,12 +445,16 @@ tokens with the <code>npm token create</code> command.</p> </ul> <p>If false, never shows colors. If <code>"always"</code> then always shows colors. If true, then only prints color codes for tty file descriptors.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="commit-hooks"><code>commit-hooks</code></h4> <ul> <li>Default: true</li> <li>Type: Boolean</li> </ul> <p>Run git commit hooks when using the <code>npm version</code> command.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="depth"><code>depth</code></h4> <ul> <li>Default: <code>Infinity</code> if <code>--all</code> is set, otherwise <code>1</code></li> @@ -418,36 +463,48 @@ true, then only prints color codes for tty file descriptors.</p> <p>The depth to go when recursing packages for <code>npm ls</code>.</p> <p>If not set, <code>npm ls</code> will show only the immediate dependencies of the root project. If <code>--all</code> is set, then npm will show all dependencies by default.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="description2"><code>description</code></h4> <ul> <li>Default: true</li> <li>Type: Boolean</li> </ul> <p>Show the description in <code>npm search</code></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff"><code>diff</code></h4> <ul> <li>Default:</li> <li>Type: String (can be set multiple times)</li> </ul> <p>Define arguments to compare in <code>npm diff</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-dst-prefix"><code>diff-dst-prefix</code></h4> <ul> <li>Default: “b/”</li> <li>Type: String</li> </ul> <p>Destination prefix to be used in <code>npm diff</code> output.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-ignore-all-space"><code>diff-ignore-all-space</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Ignore whitespace when comparing lines in <code>npm diff</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-name-only"><code>diff-name-only</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Prints only filenames when using <code>npm diff</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-no-prefix"><code>diff-no-prefix</code></h4> <ul> <li>Default: false</li> @@ -456,24 +513,32 @@ project. If <code>--all</code> is set, then npm will show all dependencies by de <p>Do not show any source or destination prefix in <code>npm diff</code> output.</p> <p>Note: this causes <code>npm diff</code> to ignore the <code>--diff-src-prefix</code> and <code>--diff-dst-prefix</code> configs.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-src-prefix"><code>diff-src-prefix</code></h4> <ul> <li>Default: “a/”</li> <li>Type: String</li> </ul> <p>Source prefix to be used in <code>npm diff</code> output.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-text"><code>diff-text</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Treat all files as text in <code>npm diff</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="diff-unified"><code>diff-unified</code></h4> <ul> <li>Default: 3</li> <li>Type: Number</li> </ul> <p>The number of lines of context to print in <code>npm diff</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dry-run"><code>dry-run</code></h4> <ul> <li>Default: false</li> @@ -485,6 +550,8 @@ commands that modify your local installation, eg, <code>install</code>, <code>up <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, <code>owner</code>, etc.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="editor"><code>editor</code></h4> <ul> <li>Default: The EDITOR or VISUAL environment variables, or ‘notepad.exe’ on @@ -492,6 +559,8 @@ Windows, or ‘vim’ on Unix systems</li> <li>Type: String</li> </ul> <p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="engine-strict"><code>engine-strict</code></h4> <ul> <li>Default: false</li> @@ -501,6 +570,8 @@ Windows, or ‘vim’ on Unix systems</li> installing) any package that claims to not be compatible with the current Node.js version.</p> <p>This can be overridden by setting the <code>--force</code> flag.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fetch-retries"><code>fetch-retries</code></h4> <ul> <li>Default: 2</li> @@ -510,12 +581,16 @@ Node.js version.</p> from the registry.</p> <p>npm will retry idempotent read requests to the registry in the case of network failures or 5xx HTTP errors.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fetch-retry-factor"><code>fetch-retry-factor</code></h4> <ul> <li>Default: 10</li> <li>Type: Number</li> </ul> <p>The “factor” config for the <code>retry</code> module to use when fetching packages.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fetch-retry-maxtimeout"><code>fetch-retry-maxtimeout</code></h4> <ul> <li>Default: 60000 (1 minute)</li> @@ -523,6 +598,8 @@ network failures or 5xx HTTP errors.</p> </ul> <p>The “maxTimeout” config for the <code>retry</code> module to use when fetching packages.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fetch-retry-mintimeout"><code>fetch-retry-mintimeout</code></h4> <ul> <li>Default: 10000 (10 seconds)</li> @@ -530,12 +607,16 @@ packages.</p> </ul> <p>The “minTimeout” config for the <code>retry</code> module to use when fetching packages.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fetch-timeout"><code>fetch-timeout</code></h4> <ul> <li>Default: 300000 (5 minutes)</li> <li>Type: Number</li> </ul> <p>The maximum amount of time to wait for HTTP requests to complete.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="force"><code>force</code></h4> <ul> <li>Default: false</li> @@ -560,6 +641,8 @@ range (including SemVer-major changes).</li> </ul> <p>If you don’t have a clear idea of what you want to do, it is strongly recommended that you do not use this option!</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="foreground-scripts"><code>foreground-scripts</code></h4> <ul> <li>Default: false</li> @@ -570,6 +653,8 @@ scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.</p> <p>Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="format-package-lock"><code>format-package-lock</code></h4> <ul> <li>Default: true</li> @@ -577,6 +662,8 @@ but can be useful for debugging.</p> </ul> <p>Format <code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> as a human readable file.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="fund"><code>fund</code></h4> <ul> <li>Default: true</li> @@ -584,6 +671,8 @@ file.</p> </ul> <p>When “true” displays the message at the end of each <code>npm install</code> acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="git"><code>git</code></h4> <ul> <li>Default: “git”</li> @@ -591,12 +680,16 @@ acknowledging the number of dependencies looking for funding. See <a href="../co </ul> <p>The command to use for git commands. If git is installed on the computer, but is not in the <code>PATH</code>, then set this to the full path to the git binary.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="git-tag-version"><code>git-tag-version</code></h4> <ul> <li>Default: true</li> <li>Type: Boolean</li> </ul> <p>Tag the commit when using the <code>npm version</code> command.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global"><code>global</code></h4> <ul> <li>Default: false</li> @@ -611,6 +704,8 @@ of the current working directory.</li> <li>bin files are linked to <code>{prefix}/bin</code></li> <li>man pages are linked to <code>{prefix}/share/man</code></li> </ul> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="global-style"><code>global-style</code></h4> <ul> <li>Default: false</li> @@ -622,6 +717,8 @@ direct dependencies will show in <code>node_modules</code> and everything they d on will be flattened in their <code>node_modules</code> folders. This obviously will eliminate some deduping. If used with <code>legacy-bundling</code>, <code>legacy-bundling</code> will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="globalconfig"><code>globalconfig</code></h4> <ul> <li>Default: The global –prefix setting plus ‘etc/npmrc’. For example, @@ -629,12 +726,16 @@ will be preferred.</p> <li>Type: Path</li> </ul> <p>The config file to read for global config options.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="heading"><code>heading</code></h4> <ul> <li>Default: “npm”</li> <li>Type: String</li> </ul> <p>The string that starts all the debugging log output.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="https-proxy"><code>https-proxy</code></h4> <ul> <li>Default: null</li> @@ -644,6 +745,8 @@ will be preferred.</p> <code>https_proxy</code> or <code>HTTP_PROXY</code> or <code>http_proxy</code> environment variables are set, proxy settings will be honored by the underlying <code>make-fetch-happen</code> library.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="if-present"><code>if-present</code></h4> <ul> <li>Default: false</li> @@ -655,6 +758,8 @@ This option can be used when it’s desirable to optionally run a script when it’s present and fail if the script fails. This is useful, for example, when running scripts that may only apply for some builds in an otherwise generic CI setup.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="ignore-scripts"><code>ignore-scripts</code></h4> <ul> <li>Default: false</li> @@ -665,6 +770,8 @@ CI setup.</p> <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> will still run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em> run any pre- or post-scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="include"><code>include</code></h4> <ul> <li>Default:</li> @@ -674,6 +781,8 @@ will <em>not</em> run any pre- or post-scripts.</p> <p>This is the inverse of <code>--omit=<type></code>.</p> <p>Dependency types specified in <code>--include</code> will not be omitted, regardless of the order in which omit/include are specified on the command-line.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="include-staged"><code>include-staged</code></h4> <ul> <li>Default: false</li> @@ -682,18 +791,24 @@ the order in which omit/include are specified on the command-line.</p> <p>Allow installing “staged” published packages, as defined by <a href="https://github.com/npm/rfcs/pull/92">npm RFC PR #92</a>.</p> <p>This is experimental, and not implemented by the npm public registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="init-author-email"><code>init-author-email</code></h4> <ul> <li>Default: “”</li> <li>Type: String</li> </ul> <p>The value <code>npm init</code> should use by default for the package author’s email.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="init-author-name"><code>init-author-name</code></h4> <ul> <li>Default: “”</li> <li>Type: String</li> </ul> <p>The value <code>npm init</code> should use by default for the package author’s name.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="init-author-url"><code>init-author-url</code></h4> <ul> <li>Default: “”</li> @@ -701,12 +816,16 @@ the order in which omit/include are specified on the command-line.</p> </ul> <p>The value <code>npm init</code> should use by default for the package author’s homepage.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="init-license"><code>init-license</code></h4> <ul> <li>Default: “ISC”</li> <li>Type: String</li> </ul> <p>The value <code>npm init</code> should use by default for the package license.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="init-module"><code>init-module</code></h4> <ul> <li>Default: “~/.npm-init.js”</li> @@ -716,6 +835,8 @@ homepage.</p> documentation for the <a href="https://github.com/npm/init-package-json">init-package-json</a> module for more information, or <a href="../commands/npm-init.html">npm init</a>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="init-version"><code>init-version</code></h4> <ul> <li>Default: “1.0.0”</li> @@ -723,6 +844,8 @@ more information, or <a href="../commands/npm-init.html">npm init</a>.</p> </ul> <p>The value that <code>npm init</code> should use by default for the package version number, if not already set in package.json.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="json"><code>json</code></h4> <ul> <li>Default: false</li> @@ -734,6 +857,8 @@ number, if not already set in package.json.</p> saving them to your <code>package.json</code>.</li> </ul> <p>Not supported by all npm commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="key"><code>key</code></h4> <ul> <li>Default: null</li> @@ -744,6 +869,8 @@ format with newlines replaced by the string “\n”. For example:</p> <pre lang="ini"><code>key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----" </code></pre> <p>It is <em>not</em> the path to a key file (and there is no “keyfile” option).</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="legacy-bundling"><code>legacy-bundling</code></h4> <ul> <li>Default: false</li> @@ -753,6 +880,8 @@ format with newlines replaced by the string “\n”. For example:</p> such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with <code>global-style</code> this option will be preferred.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="legacy-peer-deps"><code>legacy-peer-deps</code></h4> <ul> <li>Default: false</li> @@ -767,12 +896,16 @@ that collide, it provides a way to move forward resolving the situation.</p> <code>peerDependencies</code> <em>could</em> be unpacked in a correct place.</p> <p>Use of <code>legacy-peer-deps</code> is not recommended, as it will not enforce the <code>peerDependencies</code> contract that meta-dependencies may rely on.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="link"><code>link</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Used with <code>npm ls</code>, limiting output to only those packages that are linked.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="local-address"><code>local-address</code></h4> <ul> <li>Default: null</li> @@ -780,6 +913,8 @@ that collide, it provides a way to move forward resolving the situation.</p> </ul> <p>The IP address of the local interface to use when making connections to the npm registry. Must be IPv4 in versions of Node prior to 0.12.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="location"><code>location</code></h4> <ul> <li>Default: “user” unless <code>--global</code> is passed, which will also set this value @@ -787,6 +922,8 @@ to “global”</li> <li>Type: “global”, “user”, or “project”</li> </ul> <p>When passed to <code>npm config</code> this refers to which config file to use.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="loglevel"><code>loglevel</code></h4> <ul> <li>Default: “notice”</li> @@ -798,18 +935,24 @@ to “global”</li> <p>Any logs of a higher level than the setting are shown. The default is “notice”.</p> <p>See also the <code>foreground-scripts</code> config.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="logs-max"><code>logs-max</code></h4> <ul> <li>Default: 10</li> <li>Type: Number</li> </ul> <p>The maximum number of log files to store.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="long"><code>long</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="maxsockets"><code>maxsockets</code></h4> <ul> <li>Default: 15</li> @@ -817,6 +960,8 @@ to “global”</li> </ul> <p>The maximum number of connections to use per origin (protocol/host/port combination).</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="message"><code>message</code></h4> <ul> <li>Default: “%s”</li> @@ -824,6 +969,8 @@ combination).</p> </ul> <p>Commit message which is used by <code>npm version</code> when creating version commit.</p> <p>Any “%s” in the message will be replaced with the version number.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="node-options"><code>node-options</code></h4> <ul> <li>Default: null</li> @@ -832,12 +979,16 @@ combination).</p> <p>Options to pass through to Node.js via the <code>NODE_OPTIONS</code> environment variable. This does not impact how npm itself is executed but it does impact how lifecycle scripts are called.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="node-version"><code>node-version</code></h4> <ul> <li>Default: Node.js <code>process.version</code> value</li> <li>Type: SemVer string</li> </ul> <p>The node version to use when checking a package’s <code>engines</code> setting.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="noproxy"><code>noproxy</code></h4> <ul> <li>Default: The value of the NO_PROXY environment variable</li> @@ -845,12 +996,16 @@ how lifecycle scripts are called.</p> </ul> <p>Domain extensions that should bypass any proxies.</p> <p>Also accepts a comma-delimited string.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="npm-version"><code>npm-version</code></h4> <ul> <li>Default: Output of <code>npm --version</code></li> <li>Type: SemVer string</li> </ul> <p>The npm version to use when checking a package’s <code>engines</code> setting.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="offline"><code>offline</code></h4> <ul> <li>Default: false</li> @@ -858,6 +1013,8 @@ how lifecycle scripts are called.</p> </ul> <p>Force offline mode: no network requests will be done during install. To allow the CLI to fill in missing cache data, see <code>--prefer-offline</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="omit"><code>omit</code></h4> <ul> <li>Default: ‘dev’ if the <code>NODE_ENV</code> environment variable is set to @@ -872,6 +1029,8 @@ physically installed on disk.</p> it will be included.</p> <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment variable will be set to <code>'production'</code> for all lifecycle scripts.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="otp"><code>otp</code></h4> <ul> <li>Default: null</li> @@ -881,18 +1040,24 @@ variable will be set to <code>'production'</code> for all lifecycle scripts.</p> when publishing or changing package permissions with <code>npm access</code>.</p> <p>If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="pack-destination"><code>pack-destination</code></h4> <ul> <li>Default: “.”</li> <li>Type: String</li> </ul> <p>Directory in which <code>npm pack</code> will save tarballs.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package"><code>package</code></h4> <ul> <li>Default:</li> <li>Type: String (can be set multiple times)</li> </ul> <p>The package to install for <a href="../commands/npm-exec.html"><code>npm exec</code></a></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package-lock"><code>package-lock</code></h4> <ul> <li>Default: true</li> @@ -903,6 +1068,8 @@ will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save< <p>When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use <code>npm prune</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="package-lock-only"><code>package-lock-only</code></h4> <ul> <li>Default: false</li> @@ -914,6 +1081,8 @@ ignoring <code>node_modules</code>.</p> instead of checking <code>node_modules</code> and downloading dependencies.</p> <p>For <code>list</code> this means the output will be based on the tree described by the <code>package-lock.json</code>, rather than the contents of <code>node_modules</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="parseable"><code>parseable</code></h4> <ul> <li>Default: false</li> @@ -921,6 +1090,8 @@ instead of checking <code>node_modules</code> and downloading dependencies.</p> </ul> <p>Output parseable results from commands that write to standard output. For <code>npm search</code>, this will be tab-separated table format.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="prefer-offline"><code>prefer-offline</code></h4> <ul> <li>Default: false</li> @@ -929,6 +1100,8 @@ instead of checking <code>node_modules</code> and downloading dependencies.</p> <p>If true, staleness checks for cached data will be bypassed, but missing data will be requested from the server. To force full offline mode, use <code>--offline</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="prefer-online"><code>prefer-online</code></h4> <ul> <li>Default: false</li> @@ -936,6 +1109,8 @@ will be requested from the server. To force full offline mode, use </ul> <p>If true, staleness checks for cached data will be forced, making the CLI look for updates immediately even for fresh package data.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="prefix"><code>prefix</code></h4> <ul> <li>Default: In global mode, the folder where the node executable is installed. @@ -945,6 +1120,8 @@ file or a node_modules folder.</li> </ul> <p>The location to install global items. If set on the command line, then it forces non-global commands to run in the specified folder.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="preid"><code>preid</code></h4> <ul> <li>Default: “”</li> @@ -952,6 +1129,8 @@ forces non-global commands to run in the specified folder.</p> </ul> <p>The “prerelease identifier” to use as a prefix for the “prerelease” part of a semver. Like the <code>rc</code> in <code>1.2.0-rc.8</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="progress"><code>progress</code></h4> <ul> <li>Default: <code>true</code> unless running in a known CI system</li> @@ -960,6 +1139,8 @@ a semver. Like the <code>rc</code> in <code>1.2.0-rc.8</code>.</p> <p>When set to <code>true</code>, npm will display a progress bar during time intensive operations, if <code>process.stderr</code> is a TTY.</p> <p>Set to <code>false</code> to suppress the progress bar.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="proxy"><code>proxy</code></h4> <ul> <li>Default: null</li> @@ -968,6 +1149,8 @@ operations, if <code>process.stderr</code> is a TTY.</p> <p>A proxy to use for outgoing http requests. If the <code>HTTP_PROXY</code> or <code>http_proxy</code> environment variables are set, proxy settings will be honored by the underlying <code>request</code> library.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="read-only"><code>read-only</code></h4> <ul> <li>Default: false</li> @@ -975,18 +1158,24 @@ by the underlying <code>request</code> library.</p> </ul> <p>This is used to mark a token as unable to publish when configuring limited access tokens with the <code>npm token create</code> command.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="rebuild-bundle"><code>rebuild-bundle</code></h4> <ul> <li>Default: true</li> <li>Type: Boolean</li> </ul> <p>Rebuild bundled dependencies after installation.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="registry"><code>registry</code></h4> <ul> <li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li> <li>Type: URL</li> </ul> <p>The base URL of the npm registry.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save"><code>save</code></h4> <ul> <li>Default: true</li> @@ -995,6 +1184,8 @@ access tokens with the <code>npm token create</code> command.</p> <p>Save installed packages to a package.json file as dependencies.</p> <p>When used with the <code>npm rm</code> command, removes the dependency from package.json.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save-bundle"><code>save-bundle</code></h4> <ul> <li>Default: false</li> @@ -1004,12 +1195,16 @@ package.json.</p> <code>--save-dev</code>, or <code>--save-optional</code>, then also put it in the <code>bundleDependencies</code> list.</p> <p>Ignore if <code>--save-peer</code> is set, since peerDependencies cannot be bundled.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save-dev"><code>save-dev</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Save installed packages to a package.json file as <code>devDependencies</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save-exact"><code>save-exact</code></h4> <ul> <li>Default: false</li> @@ -1017,18 +1212,24 @@ package.json.</p> </ul> <p>Dependencies saved to package.json will be configured with an exact version rather than using npm’s default semver range operator.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save-optional"><code>save-optional</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Save installed packages to a package.json file as <code>optionalDependencies</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save-peer"><code>save-peer</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Save installed packages. to a package.json file as <code>peerDependencies</code></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save-prefix"><code>save-prefix</code></h4> <ul> <li>Default: “^”</li> @@ -1039,6 +1240,8 @@ rather than using npm’s default semver range operator.</p> <p>For example if a package has version <code>1.2.3</code>, by default its version is set to <code>^1.2.3</code> which allows minor upgrades for that package, but after <code>npm config set save-prefix='~'</code> it would be set to <code>~1.2.3</code> which only allows patch upgrades.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="save-prod"><code>save-prod</code></h4> <ul> <li>Default: false</li> @@ -1049,6 +1252,8 @@ a package already exists in <code>devDependencies</code> or <code>optionalDepend you want to move it to be a non-optional production dependency.</p> <p>This is the default behavior if <code>--save</code> is true, and neither <code>--save-dev</code> or <code>--save-optional</code> are true.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="scope"><code>scope</code></h4> <ul> <li>Default: the scope of the current project, if any, or “”</li> @@ -1070,18 +1275,24 @@ installation of packages specified according to the pattern # instead of just named "whatever" npm init --scope=@foo --yes </code></pre> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="script-shell"><code>script-shell</code></h4> <ul> <li>Default: ‘/bin/sh’ on POSIX systems, ‘cmd.exe’ on Windows</li> <li>Type: null or String</li> </ul> <p>The shell to use for scripts run with the <code>npm exec</code>, <code>npm run</code> and <code>npm init <pkg></code> commands.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="searchexclude"><code>searchexclude</code></h4> <ul> <li>Default: “”</li> <li>Type: String</li> </ul> <p>Space-separated options that limit the results from search.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="searchlimit"><code>searchlimit</code></h4> <ul> <li>Default: 20</li> @@ -1089,12 +1300,16 @@ npm init --scope=@foo --yes </ul> <p>Number of items to limit search results to. Will not apply at all to legacy searches.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="searchopts"><code>searchopts</code></h4> <ul> <li>Default: “”</li> <li>Type: String</li> </ul> <p>Space-separated options that are always passed to search.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="searchstaleness"><code>searchstaleness</code></h4> <ul> <li>Default: 900</li> @@ -1102,6 +1317,8 @@ searches.</p> </ul> <p>The age of the cache, in seconds, before another registry request is made if using legacy search endpoint.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="shell"><code>shell</code></h4> <ul> <li>Default: SHELL environment variable, or “bash” on Posix, or “cmd.exe” on @@ -1109,6 +1326,8 @@ Windows</li> <li>Type: String</li> </ul> <p>The shell to run for the <code>npm explore</code> command.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="sign-git-commit"><code>sign-git-commit</code></h4> <ul> <li>Default: false</li> @@ -1118,6 +1337,8 @@ Windows</li> version using <code>-S</code> to add a signature.</p> <p>Note that git requires you to have set up GPG keys in your git configs for this to work properly.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="sign-git-tag"><code>sign-git-tag</code></h4> <ul> <li>Default: false</li> @@ -1127,6 +1348,8 @@ this to work properly.</p> <code>-s</code> to add a signature.</p> <p>Note that git requires you to have set up GPG keys in your git configs for this to work properly.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4> <ul> <li>Default: false</li> @@ -1143,6 +1366,8 @@ the range set in their package’s <code>peerDependencies</code> object.</p> <p>When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then this warning is treated as a failure.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="strict-ssl"><code>strict-ssl</code></h4> <ul> <li>Default: true</li> @@ -1151,6 +1376,8 @@ this warning is treated as a failure.</p> <p>Whether or not to do SSL key validation when making requests to the registry via https.</p> <p>See also the <code>ca</code> config.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="tag"><code>tag</code></h4> <ul> <li>Default: “latest”</li> @@ -1162,6 +1389,8 @@ then it will install the specified tag.</p> command, if no explicit tag is given.</p> <p>When used by the <code>npm diff</code> command, this is the tag used to fetch the tarball that will be compared with the local files by default.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="tag-version-prefix"><code>tag-version-prefix</code></h4> <ul> <li>Default: “v”</li> @@ -1173,6 +1402,8 @@ it to the empty string: <code>""</code>.</p> <p>Because other tools may rely on the convention that npm version tags look like <code>v1.0.0</code>, <em>only use this property if it is absolutely necessary</em>. In particular, use care when overriding this setting for public packages.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="timing"><code>timing</code></h4> <ul> <li>Default: false</li> @@ -1183,6 +1414,8 @@ particular, use care when overriding this setting for public packages.</p> successfully. <code>_timing.json</code> is a newline delimited list of JSON objects.</p> <p>You can quickly view it with this <a href="https://npm.im/json">json</a> command line: <code>npm exec -- json -g < ~/.npm/_timing.json</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="umask"><code>umask</code></h4> <ul> <li>Default: 0</li> @@ -1199,6 +1432,8 @@ rather adds the <code>--umask</code> config to it.</p> <p>Thus, the effective default umask value on most POSIX systems is 0o22, meaning that folders and executables are created with a mode of 0o755 and other files are created with a mode of 0o644.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="unicode"><code>unicode</code></h4> <ul> <li>Default: false on windows, true on mac/unix systems with a unicode locale, @@ -1207,6 +1442,8 @@ as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</cod </ul> <p>When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="update-notifier"><code>update-notifier</code></h4> <ul> <li>Default: true</li> @@ -1214,12 +1451,16 @@ false, it uses ascii characters instead of unicode glyphs.</p> </ul> <p>Set to false to suppress the update notification when using an older version of npm than the latest.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="usage"><code>usage</code></h4> <ul> <li>Default: false</li> <li>Type: Boolean</li> </ul> <p>Show short usage output about the command specified.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="user-agent"><code>user-agent</code></h4> <ul> <li>Default: “npm/{npm-version} node/{node-version} {platform} {arch} @@ -1238,6 +1479,8 @@ are set.</li> <li><code>{ci}</code> - The value of the <code>ci-name</code> config, if set, prefixed with <code>ci/</code>, or an empty string if <code>ci-name</code> is empty.</li> </ul> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="userconfig"><code>userconfig</code></h4> <ul> <li>Default: “~/.npmrc”</li> @@ -1247,6 +1490,8 @@ an empty string if <code>ci-name</code> is empty.</li> <p>This may be overridden by the <code>npm_config_userconfig</code> environment variable or the <code>--userconfig</code> command line option, but may <em>not</em> be overridden by settings in the <code>globalconfig</code> file.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="version"><code>version</code></h4> <ul> <li>Default: false</li> @@ -1254,6 +1499,8 @@ settings in the <code>globalconfig</code> file.</p> </ul> <p>If true, output the npm version and exit successfully.</p> <p>Only relevant when specified explicitly on the command line.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="versions"><code>versions</code></h4> <ul> <li>Default: false</li> @@ -1263,6 +1510,8 @@ settings in the <code>globalconfig</code> file.</p> the version in the current working directory’s <code>package.json</code> file if one exists, and exit successfully.</p> <p>Only relevant when specified explicitly on the command line.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="viewer"><code>viewer</code></h4> <ul> <li>Default: “man” on Posix, “browser” on Windows</li> @@ -1270,12 +1519,16 @@ exists, and exit successfully.</p> </ul> <p>The program to use to view help content.</p> <p>Set to <code>"browser"</code> to view html help content in the default web browser.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="which"><code>which</code></h4> <ul> <li>Default: null</li> <li>Type: null or Number</li> </ul> <p>If there are multiple funding sources, which 1-indexed source URL to open.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspace"><code>workspace</code></h4> <ul> <li>Default:</li> @@ -1295,6 +1548,8 @@ nested workspaces)</li> workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="workspaces"><code>workspaces</code></h4> <ul> <li>Default: false</li> @@ -1303,6 +1558,8 @@ brand new workspace within the project.</p> <p>Enable running a command in the context of <strong>all</strong> the configured workspaces.</p> <p>This value is not exported to the environment for child processes.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="yes"><code>yes</code></h4> <ul> <li>Default: null</li> @@ -1310,6 +1567,8 @@ workspaces.</p> </ul> <p>Automatically answer “yes” to any prompts that npm might print on the command line.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="also"><code>also</code></h4> <ul> <li>Default: null</li> @@ -1317,6 +1576,8 @@ command line.</p> <li>DEPRECATED: Please use –include=dev instead.</li> </ul> <p>When set to <code>dev</code> or <code>development</code>, this is an alias for <code>--include=dev</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="auth-type"><code>auth-type</code></h4> <ul> <li>Default: “legacy”</li> @@ -1325,6 +1586,8 @@ command line.</p> in a future version of npm in favor of web-based login.</li> </ul> <p>What authentication strategy to use with <code>adduser</code>/<code>login</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="cache-max"><code>cache-max</code></h4> <ul> <li>Default: Infinity</li> @@ -1332,6 +1595,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: This option has been deprecated in favor of <code>--prefer-online</code></li> </ul> <p><code>--cache-max=0</code> is an alias for <code>--prefer-online</code></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="cache-min"><code>cache-min</code></h4> <ul> <li>Default: 0</li> @@ -1339,6 +1604,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: This option has been deprecated in favor of <code>--prefer-offline</code>.</li> </ul> <p><code>--cache-min=9999 (or bigger)</code> is an alias for <code>--prefer-offline</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="dev"><code>dev</code></h4> <ul> <li>Default: false</li> @@ -1346,6 +1613,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: Please use –include=dev instead.</li> </ul> <p>Alias for <code>--include=dev</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="initauthoremail"><code>init.author.email</code></h4> <ul> <li>Default: “”</li> @@ -1353,6 +1622,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: Use <code>--init-author-email</code> instead.</li> </ul> <p>Alias for <code>--init-author-email</code></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="initauthorname"><code>init.author.name</code></h4> <ul> <li>Default: “”</li> @@ -1360,6 +1631,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: Use <code>--init-author-name</code> instead.</li> </ul> <p>Alias for <code>--init-author-name</code></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="initauthorurl"><code>init.author.url</code></h4> <ul> <li>Default: “”</li> @@ -1367,6 +1640,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: Use <code>--init-author-url</code> instead.</li> </ul> <p>Alias for <code>--init-author-url</code></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="initlicense"><code>init.license</code></h4> <ul> <li>Default: “ISC”</li> @@ -1374,6 +1649,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: Use <code>--init-license</code> instead.</li> </ul> <p>Alias for <code>--init-license</code></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="initmodule"><code>init.module</code></h4> <ul> <li>Default: “~/.npm-init.js”</li> @@ -1381,6 +1658,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: Use <code>--init-module</code> instead.</li> </ul> <p>Alias for <code>--init-module</code></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="initversion"><code>init.version</code></h4> <ul> <li>Default: “1.0.0”</li> @@ -1388,6 +1667,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: Use <code>--init-version</code> instead.</li> </ul> <p>Alias for <code>--init-version</code></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="only"><code>only</code></h4> <ul> <li>Default: null</li> @@ -1395,6 +1676,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: Use <code>--omit=dev</code> to omit dev dependencies from the install.</li> </ul> <p>When set to <code>prod</code> or <code>production</code>, this is an alias for <code>--omit=dev</code>.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="optional"><code>optional</code></h4> <ul> <li>Default: null</li> @@ -1404,6 +1687,8 @@ in a future version of npm in favor of web-based login.</li> </ul> <p>Default value does install optional deps unless otherwise omitted.</p> <p>Alias for –include=optional or –omit=optional</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="production"><code>production</code></h4> <ul> <li>Default: null</li> @@ -1411,6 +1696,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: Use <code>--omit=dev</code> instead.</li> </ul> <p>Alias for <code>--omit=dev</code></p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="shrinkwrap"><code>shrinkwrap</code></h4> <ul> <li>Default: true</li> @@ -1418,6 +1705,8 @@ in a future version of npm in favor of web-based login.</li> <li>DEPRECATED: Use the –package-lock setting instead.</li> </ul> <p>Alias for –package-lock</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="sso-poll-frequency"><code>sso-poll-frequency</code></h4> <ul> <li>Default: 500</li> @@ -1427,6 +1716,8 @@ future version of npm in favor of web-based login.</li> </ul> <p>When used with SSO-enabled <code>auth-type</code>s, configures how regularly the registry should be polled while the user is completing authentication.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="sso-type"><code>sso-type</code></h4> <ul> <li>Default: “oauth”</li> @@ -1435,6 +1726,8 @@ registry should be polled while the user is completing authentication.</p> future version of npm in favor of web-based login.</li> </ul> <p>If <code>--auth-type=sso</code>, the type of SSO type to use.</p> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h4 id="tmp"><code>tmp</code></h4> <ul> <li>Default: The value returned by the Node.js <code>os.tmpdir()</code> method @@ -1447,6 +1740,8 @@ special location in the cache, and they are managed by <p>Historically, the location where temporary files were stored. No longer relevant.</p> <!-- raw HTML omitted --> +<!-- raw HTML omitted --> +<!-- raw HTML omitted --> <h3 id="see-also">See also</h3> <ul> <li><a href="../commands/npm-config.html">npm config</a></li> |