From 7d50d6783d20cc9cd3820aa95077c494d7a85b26 Mon Sep 17 00:00:00 2001 From: isaacs Date: Mon, 16 Aug 2021 11:30:13 -0700 Subject: [PATCH] fixup! chore(docs): add more 'autogenerated' comments --- .../lib/utils/config/describe-all.js.test.cjs | 426 ++++++++++++++++++ 1 file changed, 426 insertions(+) diff --git a/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs b/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs index 8487b45174cc3..d83e0f11021bb 100644 --- a/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs +++ b/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs @@ -17,6 +17,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\`. + + + #### \`access\` * Default: 'restricted' for scoped packages, 'public' for unscoped packages @@ -27,6 +30,9 @@ 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\`. + + + #### \`all\` * Default: false @@ -36,6 +42,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. + + + #### \`allow-same-version\` * Default: false @@ -44,6 +53,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. + + + #### \`audit\` * Default: true @@ -54,6 +66,9 @@ default registry and all registries configured for scopes. See the documentation for [\`npm audit\`](/commands/npm-audit) for details on what is submitted. + + + #### \`audit-level\` * Default: null @@ -62,6 +77,9 @@ submitted. The minimum level of vulnerability for \`npm audit\` to exit with a non-zero exit code. + + + #### \`before\` * Default: null @@ -77,6 +95,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\`. + + + #### \`bin-links\` * Default: true @@ -89,6 +110,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. + + + #### \`browser\` * Default: OS X: \`"open"\`, Windows: \`"start"\`, Others: \`"xdg-open"\` @@ -101,6 +125,9 @@ terminal. Set to \`true\` to use default system URL opener. + + + #### \`ca\` * Default: null @@ -127,6 +154,9 @@ ca[]="..." See also the \`strict-ssl\` config. + + + #### \`cache\` * Default: Windows: \`%LocalAppData%\\npm-cache\`, Posix: \`~/.npm\` @@ -135,6 +165,9 @@ See also the \`strict-ssl\` config. The location of npm's cache directory. See [\`npm cache\`](/commands/npm-cache) + + + #### \`cafile\` * Default: null @@ -144,6 +177,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. + + + #### \`call\` * Default: "" @@ -157,6 +193,9 @@ npm exec --package yo --package generator-node --call "yo node" \`\`\` + + + #### \`cert\` * Default: null @@ -173,6 +212,9 @@ cert="-----BEGIN CERTIFICATE-----\\nXXXX\\nXXXX\\n-----END CERTIFICATE-----" It is _not_ the path to a certificate file (and there is no "certfile" option). + + + #### \`ci-name\` * Default: The name of the current CI system, or \`null\` when not on a known CI @@ -183,6 +225,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. + + + #### \`cidr\` * Default: null @@ -191,6 +236,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. + + + #### \`color\` * Default: true unless the NO_COLOR environ is set to something other than '0' @@ -199,6 +247,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. + + + #### \`commit-hooks\` * Default: true @@ -206,6 +257,9 @@ true, then only prints color codes for tty file descriptors. Run git commit hooks when using the \`npm version\` command. + + + #### \`depth\` * Default: \`Infinity\` if \`--all\` is set, otherwise \`1\` @@ -216,6 +270,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. + + + #### \`description\` * Default: true @@ -223,6 +280,9 @@ project. If \`--all\` is set, then npm will show all dependencies by default. Show the description in \`npm search\` + + + #### \`diff\` * Default: @@ -230,6 +290,9 @@ Show the description in \`npm search\` Define arguments to compare in \`npm diff\`. + + + #### \`diff-dst-prefix\` * Default: "b/" @@ -237,6 +300,9 @@ Define arguments to compare in \`npm diff\`. Destination prefix to be used in \`npm diff\` output. + + + #### \`diff-ignore-all-space\` * Default: false @@ -244,6 +310,9 @@ Destination prefix to be used in \`npm diff\` output. Ignore whitespace when comparing lines in \`npm diff\`. + + + #### \`diff-name-only\` * Default: false @@ -251,6 +320,9 @@ Ignore whitespace when comparing lines in \`npm diff\`. Prints only filenames when using \`npm diff\`. + + + #### \`diff-no-prefix\` * Default: false @@ -261,6 +333,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. + + + #### \`diff-src-prefix\` * Default: "a/" @@ -268,6 +343,9 @@ Note: this causes \`npm diff\` to ignore the \`--diff-src-prefix\` and Source prefix to be used in \`npm diff\` output. + + + #### \`diff-text\` * Default: false @@ -275,6 +353,9 @@ Source prefix to be used in \`npm diff\` output. Treat all files as text in \`npm diff\`. + + + #### \`diff-unified\` * Default: 3 @@ -282,6 +363,9 @@ Treat all files as text in \`npm diff\`. The number of lines of context to print in \`npm diff\`. + + + #### \`dry-run\` * Default: false @@ -295,6 +379,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. + + + #### \`editor\` * Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on @@ -303,6 +390,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\`. + + + #### \`engine-strict\` * Default: false @@ -314,6 +404,9 @@ Node.js version. This can be overridden by setting the \`--force\` flag. + + + #### \`fetch-retries\` * Default: 2 @@ -325,6 +418,9 @@ from the registry. npm will retry idempotent read requests to the registry in the case of network failures or 5xx HTTP errors. + + + #### \`fetch-retry-factor\` * Default: 10 @@ -332,6 +428,9 @@ network failures or 5xx HTTP errors. The "factor" config for the \`retry\` module to use when fetching packages. + + + #### \`fetch-retry-maxtimeout\` * Default: 60000 (1 minute) @@ -340,6 +439,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. + + + #### \`fetch-retry-mintimeout\` * Default: 10000 (10 seconds) @@ -348,6 +450,9 @@ packages. The "minTimeout" config for the \`retry\` module to use when fetching packages. + + + #### \`fetch-timeout\` * Default: 300000 (5 minutes) @@ -355,6 +460,9 @@ packages. The maximum amount of time to wait for HTTP requests to complete. + + + #### \`force\` * Default: false @@ -380,6 +488,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! + + + #### \`foreground-scripts\` * Default: false @@ -392,6 +503,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. + + + #### \`format-package-lock\` * Default: true @@ -400,6 +514,9 @@ but can be useful for debugging. Format \`package-lock.json\` or \`npm-shrinkwrap.json\` as a human readable file. + + + #### \`fund\` * Default: true @@ -409,6 +526,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. + + + #### \`git\` * Default: "git" @@ -417,6 +537,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. + + + #### \`git-tag-version\` * Default: true @@ -424,6 +547,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. + + + #### \`global\` * Default: false @@ -438,6 +564,9 @@ folder instead of the current working directory. See * bin files are linked to \`{prefix}/bin\` * man pages are linked to \`{prefix}/share/man\` + + + #### \`global-style\` * Default: false @@ -450,6 +579,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. + + + #### \`globalconfig\` * Default: The global --prefix setting plus 'etc/npmrc'. For example, @@ -458,6 +590,9 @@ will be preferred. The config file to read for global config options. + + + #### \`heading\` * Default: "npm" @@ -465,6 +600,9 @@ The config file to read for global config options. The string that starts all the debugging log output. + + + #### \`https-proxy\` * Default: null @@ -475,6 +613,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. + + + #### \`if-present\` * Default: false @@ -487,6 +628,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. + + + #### \`ignore-scripts\` * Default: false @@ -499,6 +643,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. + + + #### \`include\` * Default: @@ -511,6 +658,9 @@ This is the inverse of \`--omit=\`. Dependency types specified in \`--include\` will not be omitted, regardless of the order in which omit/include are specified on the command-line. + + + #### \`include-staged\` * Default: false @@ -521,6 +671,9 @@ Allow installing "staged" published packages, as defined by [npm RFC PR This is experimental, and not implemented by the npm public registry. + + + #### \`init-author-email\` * Default: "" @@ -528,6 +681,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. + + + #### \`init-author-name\` * Default: "" @@ -535,6 +691,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. + + + #### \`init-author-url\` * Default: "" @@ -543,6 +702,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. + + + #### \`init-license\` * Default: "ISC" @@ -550,6 +712,9 @@ homepage. The value \`npm init\` should use by default for the package license. + + + #### \`init-module\` * Default: "~/.npm-init.js" @@ -560,6 +725,9 @@ documentation for the [init-package-json](https://github.com/npm/init-package-json) module for more information, or [npm init](/commands/npm-init). + + + #### \`init-version\` * Default: "1.0.0" @@ -568,6 +736,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. + + + #### \`json\` * Default: false @@ -580,6 +751,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. + + + #### \`key\` * Default: null @@ -594,6 +768,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). + + + #### \`legacy-bundling\` * Default: false @@ -604,6 +781,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. + + + #### \`legacy-peer-deps\` * Default: false @@ -622,6 +802,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. + + + #### \`link\` * Default: false @@ -629,6 +812,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. + + + #### \`local-address\` * Default: null @@ -637,6 +823,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. + + + #### \`location\` * Default: "user" unless \`--global\` is passed, which will also set this value @@ -645,6 +834,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. + + + #### \`loglevel\` * Default: "notice" @@ -659,6 +851,9 @@ Any logs of a higher level than the setting are shown. The default is See also the \`foreground-scripts\` config. + + + #### \`logs-max\` * Default: 10 @@ -666,6 +861,9 @@ See also the \`foreground-scripts\` config. The maximum number of log files to store. + + + #### \`long\` * Default: false @@ -673,6 +871,9 @@ The maximum number of log files to store. Show extended information in \`ls\`, \`search\`, and \`help-search\`. + + + #### \`maxsockets\` * Default: 15 @@ -681,6 +882,9 @@ Show extended information in \`ls\`, \`search\`, and \`help-search\`. The maximum number of connections to use per origin (protocol/host/port combination). + + + #### \`message\` * Default: "%s" @@ -690,6 +894,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. + + + #### \`node-options\` * Default: null @@ -699,6 +906,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. + + + #### \`node-version\` * Default: Node.js \`process.version\` value @@ -706,6 +916,9 @@ how lifecycle scripts are called. The node version to use when checking a package's \`engines\` setting. + + + #### \`noproxy\` * Default: The value of the NO_PROXY environment variable @@ -715,6 +928,9 @@ Domain extensions that should bypass any proxies. Also accepts a comma-delimited string. + + + #### \`npm-version\` * Default: Output of \`npm --version\` @@ -722,6 +938,9 @@ Also accepts a comma-delimited string. The npm version to use when checking a package's \`engines\` setting. + + + #### \`offline\` * Default: false @@ -730,6 +949,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\`. + + + #### \`omit\` * Default: 'dev' if the \`NODE_ENV\` environment variable is set to @@ -748,6 +970,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. + + + #### \`otp\` * Default: null @@ -759,6 +984,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. + + + #### \`pack-destination\` * Default: "." @@ -766,6 +994,9 @@ password, npm will prompt on the command line for one. Directory in which \`npm pack\` will save tarballs. + + + #### \`package\` * Default: @@ -773,6 +1004,9 @@ Directory in which \`npm pack\` will save tarballs. The package to install for [\`npm exec\`](/commands/npm-exec) + + + #### \`package-lock\` * Default: true @@ -785,6 +1019,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\`. + + + #### \`package-lock-only\` * Default: false @@ -799,6 +1036,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\`. + + + #### \`parseable\` * Default: false @@ -807,6 +1047,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. + + + #### \`prefer-offline\` * Default: false @@ -816,6 +1059,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\`. + + + #### \`prefer-online\` * Default: false @@ -824,6 +1070,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. + + + #### \`prefix\` * Default: In global mode, the folder where the node executable is installed. @@ -834,6 +1083,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. + + + #### \`preid\` * Default: "" @@ -842,6 +1094,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\`. + + + #### \`progress\` * Default: \`true\` unless running in a known CI system @@ -852,6 +1107,9 @@ operations, if \`process.stderr\` is a TTY. Set to \`false\` to suppress the progress bar. + + + #### \`proxy\` * Default: null @@ -861,6 +1119,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. + + + #### \`read-only\` * Default: false @@ -869,6 +1130,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. + + + #### \`rebuild-bundle\` * Default: true @@ -876,6 +1140,9 @@ access tokens with the \`npm token create\` command. Rebuild bundled dependencies after installation. + + + #### \`registry\` * Default: "https://registry.npmjs.org/" @@ -883,6 +1150,9 @@ Rebuild bundled dependencies after installation. The base URL of the npm registry. + + + #### \`save\` * Default: true @@ -893,6 +1163,9 @@ Save installed packages to a package.json file as dependencies. When used with the \`npm rm\` command, removes the dependency from package.json. + + + #### \`save-bundle\` * Default: false @@ -904,6 +1177,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. + + + #### \`save-dev\` * Default: false @@ -911,6 +1187,9 @@ Ignore if \`--save-peer\` is set, since peerDependencies cannot be bundled. Save installed packages to a package.json file as \`devDependencies\`. + + + #### \`save-exact\` * Default: false @@ -919,6 +1198,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. + + + #### \`save-optional\` * Default: false @@ -926,6 +1208,9 @@ rather than using npm's default semver range operator. Save installed packages to a package.json file as \`optionalDependencies\`. + + + #### \`save-peer\` * Default: false @@ -933,6 +1218,9 @@ Save installed packages to a package.json file as \`optionalDependencies\`. Save installed packages. to a package.json file as \`peerDependencies\` + + + #### \`save-prefix\` * Default: "^" @@ -946,6 +1234,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. + + + #### \`save-prod\` * Default: false @@ -958,6 +1249,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. + + + #### \`scope\` * Default: the scope of the current project, if any, or "" @@ -988,6 +1282,9 @@ npm init --scope=@foo --yes \`\`\` + + + #### \`script-shell\` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -996,6 +1293,9 @@ npm init --scope=@foo --yes The shell to use for scripts run with the \`npm exec\`, \`npm run\` and \`npm init \` commands. + + + #### \`searchexclude\` * Default: "" @@ -1003,6 +1303,9 @@ init \` commands. Space-separated options that limit the results from search. + + + #### \`searchlimit\` * Default: 20 @@ -1011,6 +1314,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. + + + #### \`searchopts\` * Default: "" @@ -1018,6 +1324,9 @@ searches. Space-separated options that are always passed to search. + + + #### \`searchstaleness\` * Default: 900 @@ -1026,6 +1335,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. + + + #### \`shell\` * Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on @@ -1034,6 +1346,9 @@ using legacy search endpoint. The shell to run for the \`npm explore\` command. + + + #### \`sign-git-commit\` * Default: false @@ -1045,6 +1360,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. + + + #### \`sign-git-tag\` * Default: false @@ -1056,6 +1374,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. + + + #### \`strict-peer-deps\` * Default: false @@ -1075,6 +1396,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. + + + #### \`strict-ssl\` * Default: true @@ -1085,6 +1409,9 @@ via https. See also the \`ca\` config. + + + #### \`tag\` * Default: "latest" @@ -1099,6 +1426,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. + + + #### \`tag-version-prefix\` * Default: "v" @@ -1112,6 +1442,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. + + + #### \`timing\` * Default: false @@ -1124,6 +1457,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\`. + + + #### \`umask\` * Default: 0 @@ -1144,6 +1480,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. + + + #### \`unicode\` * Default: false on windows, true on mac/unix systems with a unicode locale, @@ -1153,6 +1492,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. + + + #### \`update-notifier\` * Default: true @@ -1161,6 +1503,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. + + + #### \`usage\` * Default: false @@ -1168,6 +1513,9 @@ of npm than the latest. Show short usage output about the command specified. + + + #### \`user-agent\` * Default: "npm/{npm-version} node/{node-version} {platform} {arch} @@ -1186,6 +1534,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. + + + #### \`userconfig\` * Default: "~/.npmrc" @@ -1197,6 +1548,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. + + + #### \`version\` * Default: false @@ -1206,6 +1560,9 @@ If true, output the npm version and exit successfully. Only relevant when specified explicitly on the command line. + + + #### \`versions\` * Default: false @@ -1217,6 +1574,9 @@ exists, and exit successfully. Only relevant when specified explicitly on the command line. + + + #### \`viewer\` * Default: "man" on Posix, "browser" on Windows @@ -1226,6 +1586,9 @@ The program to use to view help content. Set to \`"browser"\` to view html help content in the default web browser. + + + #### \`which\` * Default: null @@ -1233,6 +1596,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. + + + #### \`workspace\` * Default: @@ -1255,6 +1621,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### \`workspaces\` * Default: false @@ -1265,6 +1634,9 @@ workspaces. This value is not exported to the environment for child processes. + + + #### \`yes\` * Default: null @@ -1273,6 +1645,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. + + + #### \`also\` * Default: null @@ -1281,6 +1656,9 @@ command line. When set to \`dev\` or \`development\`, this is an alias for \`--include=dev\`. + + + #### \`auth-type\` * Default: "legacy" @@ -1290,6 +1668,9 @@ When set to \`dev\` or \`development\`, this is an alias for \`--include=dev\`. What authentication strategy to use with \`adduser\`/\`login\`. + + + #### \`cache-max\` * Default: Infinity @@ -1298,6 +1679,9 @@ What authentication strategy to use with \`adduser\`/\`login\`. \`--cache-max=0\` is an alias for \`--prefer-online\` + + + #### \`cache-min\` * Default: 0 @@ -1306,6 +1690,9 @@ What authentication strategy to use with \`adduser\`/\`login\`. \`--cache-min=9999 (or bigger)\` is an alias for \`--prefer-offline\`. + + + #### \`dev\` * Default: false @@ -1314,6 +1701,9 @@ What authentication strategy to use with \`adduser\`/\`login\`. Alias for \`--include=dev\`. + + + #### \`init.author.email\` * Default: "" @@ -1322,6 +1712,9 @@ Alias for \`--include=dev\`. Alias for \`--init-author-email\` + + + #### \`init.author.name\` * Default: "" @@ -1330,6 +1723,9 @@ Alias for \`--init-author-email\` Alias for \`--init-author-name\` + + + #### \`init.author.url\` * Default: "" @@ -1338,6 +1734,9 @@ Alias for \`--init-author-name\` Alias for \`--init-author-url\` + + + #### \`init.license\` * Default: "ISC" @@ -1346,6 +1745,9 @@ Alias for \`--init-author-url\` Alias for \`--init-license\` + + + #### \`init.module\` * Default: "~/.npm-init.js" @@ -1354,6 +1756,9 @@ Alias for \`--init-license\` Alias for \`--init-module\` + + + #### \`init.version\` * Default: "1.0.0" @@ -1362,6 +1767,9 @@ Alias for \`--init-module\` Alias for \`--init-version\` + + + #### \`only\` * Default: null @@ -1370,6 +1778,9 @@ Alias for \`--init-version\` When set to \`prod\` or \`production\`, this is an alias for \`--omit=dev\`. + + + #### \`optional\` * Default: null @@ -1381,6 +1792,9 @@ Default value does install optional deps unless otherwise omitted. Alias for --include=optional or --omit=optional + + + #### \`production\` * Default: null @@ -1389,6 +1803,9 @@ Alias for --include=optional or --omit=optional Alias for \`--omit=dev\` + + + #### \`shrinkwrap\` * Default: true @@ -1397,6 +1814,9 @@ Alias for \`--omit=dev\` Alias for --package-lock + + + #### \`sso-poll-frequency\` * Default: 500 @@ -1407,6 +1827,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. + + + #### \`sso-type\` * Default: "oauth" @@ -1416,6 +1839,9 @@ registry should be polled while the user is completing authentication. If \`--auth-type=sso\`, the type of SSO type to use. + + + #### \`tmp\` * Default: The value returned by the Node.js \`os.tmpdir()\` method