diff options
| author | isaacs <i@izs.me> | 2021-08-16 21:03:29 +0300 |
|---|---|---|
| committer | Gar <gar+gh@danger.computer> | 2021-08-17 19:01:47 +0300 |
| commit | 22f3bbb2a0bf22280e0656852b9bb20795463ec5 (patch) | |
| tree | ad20fa64322083f54179d844346648501d337b16 /docs/content/commands | |
| parent | 4314490f96b3af4ce0dcbd37802874e59e5601d1 (diff) | |
chore(docs): add more 'autogenerated' comments
This should prevent the kind of thing we've seen where people edit the
generated docs, as in #3654 and #3630, and provide them with a helpful
pointer so they put the config documentation changes in the right place.
Diffstat (limited to 'docs/content/commands')
61 files changed, 871 insertions, 0 deletions
diff --git a/docs/content/commands/npm-access.md b/docs/content/commands/npm-access.md index 6d73d6a5e..1f661c911 100644 --- a/docs/content/commands/npm-access.md +++ b/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/docs/content/commands/npm-adduser.md b/docs/content/commands/npm-adduser.md index f25d3ccd8..21a31ca94 100644 --- a/docs/content/commands/npm-adduser.md +++ b/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/docs/content/commands/npm-audit.md b/docs/content/commands/npm-audit.md index 94b16b27b..9fa8c0fcc 100644 --- a/docs/content/commands/npm-audit.md +++ b/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/docs/content/commands/npm-bin.md b/docs/content/commands/npm-bin.md index 12984da1d..2d7c1d5b8 100644 --- a/docs/content/commands/npm-bin.md +++ b/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/docs/content/commands/npm-bugs.md b/docs/content/commands/npm-bugs.md index b8778324b..f92241a14 100644 --- a/docs/content/commands/npm-bugs.md +++ b/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/docs/content/commands/npm-cache.md b/docs/content/commands/npm-cache.md index e371f196d..6497a3988 100644 --- a/docs/content/commands/npm-cache.md +++ b/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/docs/content/commands/npm-ci.md b/docs/content/commands/npm-ci.md index 31c92b13c..1ce50c66d 100644 --- a/docs/content/commands/npm-ci.md +++ b/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/docs/content/commands/npm-config.md b/docs/content/commands/npm-config.md index 9e76a2367..2d77f045c 100644 --- a/docs/content/commands/npm-config.md +++ b/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/docs/content/commands/npm-dedupe.md b/docs/content/commands/npm-dedupe.md index 324e6a71b..dcb2a98fe 100644 --- a/docs/content/commands/npm-dedupe.md +++ b/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/docs/content/commands/npm-deprecate.md b/docs/content/commands/npm-deprecate.md index b5c0e6714..4888e42e8 100644 --- a/docs/content/commands/npm-deprecate.md +++ b/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/docs/content/commands/npm-diff.md b/docs/content/commands/npm-diff.md index 479cb63b1..cf0bbec15 100644 --- a/docs/content/commands/npm-diff.md +++ b/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/docs/content/commands/npm-dist-tag.md b/docs/content/commands/npm-dist-tag.md index 0e4e0ce56..4ad68ff56 100644 --- a/docs/content/commands/npm-dist-tag.md +++ b/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/docs/content/commands/npm-docs.md b/docs/content/commands/npm-docs.md index 7f4c86083..9f1387dae 100644 --- a/docs/content/commands/npm-docs.md +++ b/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/docs/content/commands/npm-doctor.md b/docs/content/commands/npm-doctor.md index 839f4261b..0cce60c7b 100644 --- a/docs/content/commands/npm-doctor.md +++ b/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/docs/content/commands/npm-edit.md b/docs/content/commands/npm-edit.md index 6930844bc..5ae7f2481 100644 --- a/docs/content/commands/npm-edit.md +++ b/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/docs/content/commands/npm-exec.md b/docs/content/commands/npm-exec.md index d4ea94371..82908d65e 100644 --- a/docs/content/commands/npm-exec.md +++ b/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/docs/content/commands/npm-explain.md b/docs/content/commands/npm-explain.md index 3a87ee8e4..4a8af2f70 100644 --- a/docs/content/commands/npm-explain.md +++ b/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/docs/content/commands/npm-explore.md b/docs/content/commands/npm-explore.md index c4a40cf72..3979da957 100644 --- a/docs/content/commands/npm-explore.md +++ b/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/docs/content/commands/npm-find-dupes.md b/docs/content/commands/npm-find-dupes.md index 3b28f6443..e9dbac6d1 100644 --- a/docs/content/commands/npm-find-dupes.md +++ b/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/docs/content/commands/npm-fund.md b/docs/content/commands/npm-fund.md index ec5f5a37f..83c0b13d8 100644 --- a/docs/content/commands/npm-fund.md +++ b/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/docs/content/commands/npm-help-search.md b/docs/content/commands/npm-help-search.md index 70f4f182d..78553a14e 100644 --- a/docs/content/commands/npm-help-search.md +++ b/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/docs/content/commands/npm-help.md b/docs/content/commands/npm-help.md index 81f55db33..a8002eef1 100644 --- a/docs/content/commands/npm-help.md +++ b/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/docs/content/commands/npm-hook.md b/docs/content/commands/npm-hook.md index 2917375ea..c91bce307 100644 --- a/docs/content/commands/npm-hook.md +++ b/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/docs/content/commands/npm-init.md b/docs/content/commands/npm-init.md index 54c3bdb4b..7355c7588 100644 --- a/docs/content/commands/npm-init.md +++ b/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/docs/content/commands/npm-install-ci-test.md b/docs/content/commands/npm-install-ci-test.md index 2640311cf..5c37ed8f5 100644 --- a/docs/content/commands/npm-install-ci-test.md +++ b/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/docs/content/commands/npm-install-test.md b/docs/content/commands/npm-install-test.md index c8533cafe..c2f9ab3d2 100644 --- a/docs/content/commands/npm-install-test.md +++ b/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/docs/content/commands/npm-install.md b/docs/content/commands/npm-install.md index 70d4c0d46..de7378718 100644 --- a/docs/content/commands/npm-install.md +++ b/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/docs/content/commands/npm-link.md b/docs/content/commands/npm-link.md index c7b385009..5811a8b23 100644 --- a/docs/content/commands/npm-link.md +++ b/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/docs/content/commands/npm-logout.md b/docs/content/commands/npm-logout.md index 000b1006e..cb7c8496f 100644 --- a/docs/content/commands/npm-logout.md +++ b/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/docs/content/commands/npm-ls.md b/docs/content/commands/npm-ls.md index 350f40a99..528140bee 100644 --- a/docs/content/commands/npm-ls.md +++ b/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/docs/content/commands/npm-org.md b/docs/content/commands/npm-org.md index 269f5cc3e..2f08f6115 100644 --- a/docs/content/commands/npm-org.md +++ b/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/docs/content/commands/npm-outdated.md b/docs/content/commands/npm-outdated.md index 40e5feafd..8eb5528c3 100644 --- a/docs/content/commands/npm-outdated.md +++ b/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/docs/content/commands/npm-owner.md b/docs/content/commands/npm-owner.md index da22e899c..74e7f84af 100644 --- a/docs/content/commands/npm-owner.md +++ b/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/docs/content/commands/npm-pack.md b/docs/content/commands/npm-pack.md index cd4a17591..dda30512d 100644 --- a/docs/content/commands/npm-pack.md +++ b/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/docs/content/commands/npm-ping.md b/docs/content/commands/npm-ping.md index 7c7b66b18..6f1c4582f 100644 --- a/docs/content/commands/npm-ping.md +++ b/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/docs/content/commands/npm-pkg.md b/docs/content/commands/npm-pkg.md index bc96eb8c3..bf6a2df5d 100644 --- a/docs/content/commands/npm-pkg.md +++ b/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/docs/content/commands/npm-prefix.md b/docs/content/commands/npm-prefix.md index 0523c9e19..276a9e9e6 100644 --- a/docs/content/commands/npm-prefix.md +++ b/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/docs/content/commands/npm-profile.md b/docs/content/commands/npm-profile.md index 079440d78..cecc48518 100644 --- a/docs/content/commands/npm-profile.md +++ b/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/docs/content/commands/npm-prune.md b/docs/content/commands/npm-prune.md index d9b5b068f..7bd7ad131 100644 --- a/docs/content/commands/npm-prune.md +++ b/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/docs/content/commands/npm-publish.md b/docs/content/commands/npm-publish.md index 0d25d7d29..4eeac5fda 100644 --- a/docs/content/commands/npm-publish.md +++ b/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,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`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dry-run` * Default: false @@ -145,6 +152,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 +166,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 +191,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 +204,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/docs/content/commands/npm-rebuild.md b/docs/content/commands/npm-rebuild.md index 49c822d73..19684796f 100644 --- a/docs/content/commands/npm-rebuild.md +++ b/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/docs/content/commands/npm-repo.md b/docs/content/commands/npm-repo.md index ade08e7d9..c3c509e0b 100644 --- a/docs/content/commands/npm-repo.md +++ b/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/docs/content/commands/npm-restart.md b/docs/content/commands/npm-restart.md index 4b905c267..80f8ab77e 100644 --- a/docs/content/commands/npm-restart.md +++ b/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/docs/content/commands/npm-root.md b/docs/content/commands/npm-root.md index 2d072c16d..98d1108d3 100644 --- a/docs/content/commands/npm-root.md +++ b/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/docs/content/commands/npm-run-script.md b/docs/content/commands/npm-run-script.md index 5e3828c40..e436bc27f 100644 --- a/docs/content/commands/npm-run-script.md +++ b/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/docs/content/commands/npm-search.md b/docs/content/commands/npm-search.md index e30287635..252822e71 100644 --- a/docs/content/commands/npm-search.md +++ b/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/docs/content/commands/npm-set-script.md b/docs/content/commands/npm-set-script.md index c5d5df532..e39b7a18c 100644 --- a/docs/content/commands/npm-set-script.md +++ b/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/docs/content/commands/npm-star.md b/docs/content/commands/npm-star.md index 5af08e2da..21109c350 100644 --- a/docs/content/commands/npm-star.md +++ b/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/docs/content/commands/npm-stars.md b/docs/content/commands/npm-stars.md index edea74a0c..101559ad9 100644 --- a/docs/content/commands/npm-stars.md +++ b/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/docs/content/commands/npm-start.md b/docs/content/commands/npm-start.md index 1c532de44..50a54cb5e 100644 --- a/docs/content/commands/npm-start.md +++ b/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/docs/content/commands/npm-stop.md b/docs/content/commands/npm-stop.md index 859de54c3..d4de4caf3 100644 --- a/docs/content/commands/npm-stop.md +++ b/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/docs/content/commands/npm-team.md b/docs/content/commands/npm-team.md index c7d5defcc..6050af1df 100644 --- a/docs/content/commands/npm-team.md +++ b/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/docs/content/commands/npm-test.md b/docs/content/commands/npm-test.md index 73cdf6de8..2059f93de 100644 --- a/docs/content/commands/npm-test.md +++ b/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/docs/content/commands/npm-token.md b/docs/content/commands/npm-token.md index c586a6915..16da1f731 100644 --- a/docs/content/commands/npm-token.md +++ b/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/docs/content/commands/npm-uninstall.md b/docs/content/commands/npm-uninstall.md index b6ba31393..c04e1a7fd 100644 --- a/docs/content/commands/npm-uninstall.md +++ b/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/docs/content/commands/npm-unpublish.md b/docs/content/commands/npm-unpublish.md index b17ff4540..1678bb305 100644 --- a/docs/content/commands/npm-unpublish.md +++ b/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/docs/content/commands/npm-unstar.md b/docs/content/commands/npm-unstar.md index f1a1f7a2e..d6e362077 100644 --- a/docs/content/commands/npm-unstar.md +++ b/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/docs/content/commands/npm-update.md b/docs/content/commands/npm-update.md index c4f7694e1..57b9b91f9 100644 --- a/docs/content/commands/npm-update.md +++ b/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/docs/content/commands/npm-version.md b/docs/content/commands/npm-version.md index a3e34153a..a02bf5bb9 100644 --- a/docs/content/commands/npm-version.md +++ b/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/docs/content/commands/npm-view.md b/docs/content/commands/npm-view.md index b3d5df86e..af354deb8 100644 --- a/docs/content/commands/npm-view.md +++ b/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/docs/content/commands/npm-whoami.md b/docs/content/commands/npm-whoami.md index 09253b3b6..2cd7ffde3 100644 --- a/docs/content/commands/npm-whoami.md +++ b/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 |