From af29f62cf13689a755354d1cbc5889d05e694141 Mon Sep 17 00:00:00 2001 From: isaacs Date: Mon, 16 Aug 2021 11:03:29 -0700 Subject: [PATCH] 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. --- docs/content/commands/npm-access.md | 7 + docs/content/commands/npm-adduser.md | 7 + docs/content/commands/npm-audit.md | 25 ++ docs/content/commands/npm-bin.md | 4 + docs/content/commands/npm-bugs.md | 7 + docs/content/commands/npm-cache.md | 4 + docs/content/commands/npm-ci.md | 10 + docs/content/commands/npm-config.md | 16 + docs/content/commands/npm-dedupe.md | 37 ++ docs/content/commands/npm-deprecate.md | 7 + docs/content/commands/npm-diff.md | 37 ++ docs/content/commands/npm-dist-tag.md | 7 + docs/content/commands/npm-docs.md | 13 + docs/content/commands/npm-doctor.md | 4 + docs/content/commands/npm-edit.md | 4 + docs/content/commands/npm-exec.md | 13 + docs/content/commands/npm-explain.md | 7 + docs/content/commands/npm-explore.md | 4 + docs/content/commands/npm-find-dupes.md | 34 ++ docs/content/commands/npm-fund.md | 16 + docs/content/commands/npm-help-search.md | 4 + docs/content/commands/npm-help.md | 4 + docs/content/commands/npm-hook.md | 7 + docs/content/commands/npm-init.md | 13 + docs/content/commands/npm-install-ci-test.md | 10 + docs/content/commands/npm-install-test.md | 46 ++ docs/content/commands/npm-install.md | 46 ++ docs/content/commands/npm-link.md | 46 ++ docs/content/commands/npm-logout.md | 7 + docs/content/commands/npm-ls.md | 37 ++ docs/content/commands/npm-org.md | 13 + docs/content/commands/npm-outdated.md | 19 + docs/content/commands/npm-owner.md | 7 + docs/content/commands/npm-pack.md | 16 + docs/content/commands/npm-ping.md | 4 + docs/content/commands/npm-pkg.md | 13 + docs/content/commands/npm-prefix.md | 4 + docs/content/commands/npm-profile.md | 13 + docs/content/commands/npm-prune.md | 16 + docs/content/commands/npm-publish.md | 22 +- docs/content/commands/npm-rebuild.md | 16 + docs/content/commands/npm-repo.md | 10 + docs/content/commands/npm-restart.md | 7 + docs/content/commands/npm-root.md | 4 + docs/content/commands/npm-run-script.md | 16 + docs/content/commands/npm-search.md | 34 ++ docs/content/commands/npm-set-script.md | 7 + docs/content/commands/npm-star.md | 7 + docs/content/commands/npm-stars.md | 4 + docs/content/commands/npm-start.md | 7 + docs/content/commands/npm-stop.md | 7 + docs/content/commands/npm-team.md | 13 + docs/content/commands/npm-test.md | 7 + docs/content/commands/npm-token.md | 13 + docs/content/commands/npm-uninstall.md | 10 + docs/content/commands/npm-unpublish.md | 13 + docs/content/commands/npm-unstar.md | 10 + docs/content/commands/npm-update.md | 40 ++ docs/content/commands/npm-version.md | 25 ++ docs/content/commands/npm-view.md | 10 + docs/content/commands/npm-whoami.md | 4 + docs/content/using-npm/config.md | 432 +++++++++++++++++++ lib/utils/config/describe-all.js | 5 +- scripts/config-doc-command.js | 10 +- scripts/config-doc.js | 6 +- 65 files changed, 1318 insertions(+), 9 deletions(-) diff --git a/docs/content/commands/npm-access.md b/docs/content/commands/npm-access.md index 6d73d6a5e28ce..896cefbfd6495 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. + #### `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. + + + #### `otp` * Default: null @@ -102,6 +106,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. + + + diff --git a/docs/content/commands/npm-adduser.md b/docs/content/commands/npm-adduser.md index f25d3ccd87ab4..23ad794a76178 100644 --- a/docs/content/commands/npm-adduser.md +++ b/docs/content/commands/npm-adduser.md @@ -37,6 +37,7 @@ your existing record. + #### `registry` * Default: "https://registry.npmjs.org/" @@ -44,6 +45,9 @@ your existing record. The base URL of the npm registry. + + + #### `scope` * Default: the scope of the current project, if any, or "" @@ -73,6 +77,9 @@ This will also cause `npm init` to create a scoped package. npm init --scope=@foo --yes ``` + + + diff --git a/docs/content/commands/npm-audit.md b/docs/content/commands/npm-audit.md index 94b16b27bd7ed..56f7c956ae963 100644 --- a/docs/content/commands/npm-audit.md +++ b/docs/content/commands/npm-audit.md @@ -191,6 +191,7 @@ $ npm audit --audit-level=moderate + #### `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. + + + #### `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. + + + #### `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! + + + #### `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. + + + #### `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`. + + + #### `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. + + + #### `workspace` * Default: @@ -303,6 +322,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -312,6 +334,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-bin.md b/docs/content/commands/npm-bin.md index 12984da1d1db7..f150a9e1b70e8 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. + #### `global` * Default: false @@ -33,6 +34,9 @@ folder instead of the current working directory. See of the current working directory. * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` + + + diff --git a/docs/content/commands/npm-bugs.md b/docs/content/commands/npm-bugs.md index b8778324b8e4a..1696dec74aebf 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 + #### `browser` * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -35,12 +36,18 @@ terminal. Set to `true` to use default system URL opener. + + + #### `registry` * Default: "https://registry.npmjs.org/" * Type: URL The base URL of the npm registry. + + + diff --git a/docs/content/commands/npm-cache.md b/docs/content/commands/npm-cache.md index e371f196d7c42..21a9414133677 100644 --- a/docs/content/commands/npm-cache.md +++ b/docs/content/commands/npm-cache.md @@ -77,6 +77,7 @@ verify`. + #### `cache` * Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm` @@ -84,6 +85,9 @@ verify`. The location of npm's cache directory. See [`npm cache`](/commands/npm-cache) + + + diff --git a/docs/content/commands/npm-ci.md b/docs/content/commands/npm-ci.md index 31c92b13c5cdd..1dee793654657 100644 --- a/docs/content/commands/npm-ci.md +++ b/docs/content/commands/npm-ci.md @@ -69,6 +69,7 @@ cache: + #### `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. + + + #### `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. + + + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -98,6 +105,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 ` commands. + + + diff --git a/docs/content/commands/npm-config.md b/docs/content/commands/npm-config.md index 9e76a23671e86..7e6a912c4e952 100644 --- a/docs/content/commands/npm-config.md +++ b/docs/content/commands/npm-config.md @@ -97,6 +97,7 @@ global config. + #### `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. + + + #### `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` + + + #### `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`. + + + #### `location` * Default: "user" unless `--global` is passed, which will also set this value @@ -139,12 +149,18 @@ The command to run for `npm edit` and `npm config edit`. When passed to `npm config` this refers to which config file to use. + + + #### `long` * Default: false * Type: Boolean Show extended information in `ls`, `search`, and `help-search`. + + + diff --git a/docs/content/commands/npm-dedupe.md b/docs/content/commands/npm-dedupe.md index 324e6a71b7a3e..019d33d866d30 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. + #### `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. + + + #### `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. + + + #### `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. + + + #### `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`. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `workspace` * Default: @@ -225,6 +256,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -234,6 +268,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-deprecate.md b/docs/content/commands/npm-deprecate.md index b5c0e67144aef..3a9aafaff2fcb 100644 --- a/docs/content/commands/npm-deprecate.md +++ b/docs/content/commands/npm-deprecate.md @@ -44,6 +44,7 @@ format an empty string. + #### `registry` * Default: "https://registry.npmjs.org/" @@ -51,6 +52,9 @@ format an empty string. The base URL of the npm registry. + + + #### `otp` * Default: null @@ -61,6 +65,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. + + + diff --git a/docs/content/commands/npm-diff.md b/docs/content/commands/npm-diff.md index 479cb63b11213..e1f86881674e8 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 + #### `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`. + + + #### `diff-name-only` * Default: false @@ -169,6 +173,9 @@ Define arguments to compare in `npm diff`. Prints only filenames when using `npm diff`. + + + #### `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`. + + + #### `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`. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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`. + + + #### `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` + + + #### `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. + + + #### `workspace` * Default: @@ -264,6 +295,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -273,6 +307,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + ## See Also diff --git a/docs/content/commands/npm-dist-tag.md b/docs/content/commands/npm-dist-tag.md index 0e4e0ce56c69d..320870ec344e5 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`. + #### `workspace` * Default: @@ -114,6 +115,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -123,6 +127,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-docs.md b/docs/content/commands/npm-docs.md index 7f4c860837035..51dee1bea7817 100644 --- a/docs/content/commands/npm-docs.md +++ b/docs/content/commands/npm-docs.md @@ -24,6 +24,7 @@ the `name` property. + #### `browser` * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -36,6 +37,9 @@ terminal. Set to `true` to use default system URL opener. + + + #### `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. + + + #### `workspace` * Default: @@ -65,6 +72,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -74,6 +84,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-doctor.md b/docs/content/commands/npm-doctor.md index 839f4261bbbc2..c6f7a8f471bda 100644 --- a/docs/content/commands/npm-doctor.md +++ b/docs/content/commands/npm-doctor.md @@ -106,12 +106,16 @@ reset the cache. + #### `registry` * Default: "https://registry.npmjs.org/" * Type: URL The base URL of the npm registry. + + + diff --git a/docs/content/commands/npm-edit.md b/docs/content/commands/npm-edit.md index 6930844bcae2c..4bdd28141cb67 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. + #### `editor` * Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on @@ -36,6 +37,9 @@ changes to your locally installed copy. * Type: String The command to run for `npm edit` and `npm config edit`. + + + diff --git a/docs/content/commands/npm-exec.md b/docs/content/commands/npm-exec.md index d4ea94371a85c..f0a34bab9da8f 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 + #### `package` * Default: @@ -131,6 +132,9 @@ $ npm exec -- foo@latest bar --package=@npmcli/foo The package to install for [`npm exec`](/commands/npm-exec) + + + #### `call` * Default: "" @@ -144,6 +148,9 @@ npm exec --package yo --package generator-node --call "yo node" ``` + + + #### `workspace` * Default: @@ -166,6 +173,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -175,6 +185,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-explain.md b/docs/content/commands/npm-explain.md index 3a87ee8e438ba..75d7d97a5df05 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 + #### `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. + + + #### `workspace` * Default: @@ -89,6 +93,9 @@ workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-explore.md b/docs/content/commands/npm-explore.md index c4a40cf7229f7..ea152f1cf3969 100644 --- a/docs/content/commands/npm-explore.md +++ b/docs/content/commands/npm-explore.md @@ -33,6 +33,7 @@ sure to use `npm rebuild ` if you make any changes. + #### `shell` * Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on @@ -40,6 +41,9 @@ sure to use `npm rebuild ` if you make any changes. * Type: String The shell to run for the `npm explore` command. + + + diff --git a/docs/content/commands/npm-find-dupes.md b/docs/content/commands/npm-find-dupes.md index 3b28f6443decd..c9ec231d6de63 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. + #### `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. + + + #### `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. + + + #### `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. + + + #### `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`. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `workspace` * Default: @@ -155,6 +183,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -164,6 +195,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-fund.md b/docs/content/commands/npm-fund.md index ec5f5a37fdb71..98d65e40f3a47 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 + #### `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. + + + #### `browser` * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -90,6 +94,9 @@ terminal. Set to `true` to use default system URL opener. + + + #### `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. + + + #### `workspace` * Default: @@ -121,12 +131,18 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `which` * Default: null * Type: null or Number If there are multiple funding sources, which 1-indexed source URL to open. + + + diff --git a/docs/content/commands/npm-help-search.md b/docs/content/commands/npm-help-search.md index 70f4f182d17e3..363ce3f50ab81 100644 --- a/docs/content/commands/npm-help-search.md +++ b/docs/content/commands/npm-help-search.md @@ -27,12 +27,16 @@ directly. + #### `long` * Default: false * Type: Boolean Show extended information in `ls`, `search`, and `help-search`. + + + diff --git a/docs/content/commands/npm-help.md b/docs/content/commands/npm-help.md index 81f55db332eda..20a8d72cbc3b0 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. + #### `viewer` * Default: "man" on Posix, "browser" on Windows @@ -33,6 +34,9 @@ topic, so unique matches are equivalent to specifying a topic name. The program to use to view help content. Set to `"browser"` to view html help content in the default web browser. + + + diff --git a/docs/content/commands/npm-hook.md b/docs/content/commands/npm-hook.md index 2917375ea38cd..7b8c105bb70c8 100644 --- a/docs/content/commands/npm-hook.md +++ b/docs/content/commands/npm-hook.md @@ -87,6 +87,7 @@ $ npm hook rm id-deadbeef + #### `registry` * Default: "https://registry.npmjs.org/" @@ -94,6 +95,9 @@ $ npm hook rm id-deadbeef The base URL of the npm registry. + + + #### `otp` * Default: null @@ -104,6 +108,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. + + + diff --git a/docs/content/commands/npm-init.md b/docs/content/commands/npm-init.md index 54c3bdb4b74ab..2472997b97678 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 .`: + #### `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. + + + #### `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! + + + #### `workspace` * Default: @@ -202,6 +209,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -211,6 +221,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-install-ci-test.md b/docs/content/commands/npm-install-ci-test.md index 2640311cf94be..c00f5ccb0bd64 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`. + #### `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. + + + #### `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. + + + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -49,6 +56,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 ` commands. + + + diff --git a/docs/content/commands/npm-install-test.md b/docs/content/commands/npm-install-test.md index c8533cafedd7a..2b9cb2c6c4602 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`. + #### `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. + + + #### `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. + + + #### `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` + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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`. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `workspace` * Default: @@ -210,6 +250,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -219,6 +262,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-install.md b/docs/content/commands/npm-install.md index 70d4c0d46ffeb..e4b6cb8493597 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. + #### `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. + + + #### `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. + + + #### `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` + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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`. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `workspace` * Default: @@ -594,6 +634,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -603,6 +646,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-link.md b/docs/content/commands/npm-link.md index c7b385009519a..ccae1d94808a3 100644 --- a/docs/content/commands/npm-link.md +++ b/docs/content/commands/npm-link.md @@ -113,6 +113,7 @@ workspace(s). + #### `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. + + + #### `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. + + + #### `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` + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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`. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `workspace` * Default: @@ -294,6 +334,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -303,6 +346,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-logout.md b/docs/content/commands/npm-logout.md index 000b1006e8b35..cc299bb16af68 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. + #### `registry` * Default: "https://registry.npmjs.org/" @@ -36,6 +37,9 @@ connected to that scope, if set. The base URL of the npm registry. + + + #### `scope` * Default: the scope of the current project, if any, or "" @@ -65,6 +69,9 @@ This will also cause `npm init` to create a scoped package. npm init --scope=@foo --yes ``` + + + diff --git a/docs/content/commands/npm-ls.md b/docs/content/commands/npm-ls.md index 350f40a9991e5..74d7797acc777 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. + #### `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. + + + #### `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. + + + #### `long` * Default: false @@ -103,6 +110,9 @@ Not supported by all npm commands. Show extended information in `ls`, `search`, and `help-search`. + + + #### `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. + + + #### `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` + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `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`. + + + #### `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. + + + #### `workspace` * Default: @@ -205,6 +236,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -214,6 +248,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-org.md b/docs/content/commands/npm-org.md index 269f5cc3ee5b8..74120fb8cf032 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. + #### `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. + + + #### `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. + + + #### `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. + + + #### `parseable` * Default: false @@ -99,6 +109,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. + + + diff --git a/docs/content/commands/npm-outdated.md b/docs/content/commands/npm-outdated.md index 40e5feafd4cc6..19fb852a5ae0a 100644 --- a/docs/content/commands/npm-outdated.md +++ b/docs/content/commands/npm-outdated.md @@ -88,6 +88,7 @@ A few things to note: + #### `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. + + + #### `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. + + + #### `long` * Default: false @@ -116,6 +123,9 @@ Not supported by all npm commands. Show extended information in `ls`, `search`, and `help-search`. + + + #### `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. + + + #### `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` + + + #### `workspace` * Default: @@ -159,6 +175,9 @@ workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-owner.md b/docs/content/commands/npm-owner.md index da22e899c2ebb..b30b8e74aff7b 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`. + #### `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. + + + #### `otp` * Default: null @@ -56,6 +60,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. + + + diff --git a/docs/content/commands/npm-pack.md b/docs/content/commands/npm-pack.md index cd4a175919e7e..278b0ea5badc4 100644 --- a/docs/content/commands/npm-pack.md +++ b/docs/content/commands/npm-pack.md @@ -14,6 +14,7 @@ npm pack [[<@scope>/]...] [--dry-run] [--json] + #### `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. + + + #### `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. + + + #### `pack-destination` * Default: "." @@ -46,6 +53,9 @@ Not supported by all npm commands. Directory in which `npm pack` will save tarballs. + + + #### `workspace` * Default: @@ -68,6 +78,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -77,6 +90,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-ping.md b/docs/content/commands/npm-ping.md index 7c7b66b181b4a..5ead5ed6f8a9e 100644 --- a/docs/content/commands/npm-ping.md +++ b/docs/content/commands/npm-ping.md @@ -29,12 +29,16 @@ Ping error: {*Detail about error} + #### `registry` * Default: "https://registry.npmjs.org/" * Type: URL The base URL of the npm registry. + + + diff --git a/docs/content/commands/npm-pkg.md b/docs/content/commands/npm-pkg.md index bc96eb8c3af94..5d2e6e978b827 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 + #### `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! + + + #### `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. + + + #### `workspace` * Default: @@ -225,6 +232,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -234,6 +244,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + ## See Also diff --git a/docs/content/commands/npm-prefix.md b/docs/content/commands/npm-prefix.md index 0523c9e19513d..4f3e47b7610ad 100644 --- a/docs/content/commands/npm-prefix.md +++ b/docs/content/commands/npm-prefix.md @@ -37,6 +37,7 @@ npm prefix -g + #### `global` * Default: false @@ -50,6 +51,9 @@ folder instead of the current working directory. See of the current working directory. * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` + + + diff --git a/docs/content/commands/npm-profile.md b/docs/content/commands/npm-profile.md index 079440d785815..d37915a6a9f71 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. + #### `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. + + + #### `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. + + + #### `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. + + + #### `otp` * Default: null @@ -114,6 +124,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. + + + diff --git a/docs/content/commands/npm-prune.md b/docs/content/commands/npm-prune.md index d9b5b068f7a4b..b8489e6e66020 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. + #### `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. + + + #### `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. + + + #### `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. + + + #### `workspace` * Default: @@ -102,6 +112,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -111,6 +124,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-publish.md b/docs/content/commands/npm-publish.md index 9eb060a78be29..fed268b2c8e56 100644 --- a/docs/content/commands/npm-publish.md +++ b/docs/content/commands/npm-publish.md @@ -108,6 +108,7 @@ built. + #### `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. + + + #### `access` * Default: 'restricted' for scoped packages, 'public' for unscoped packages @@ -132,10 +136,8 @@ If you want your scoped package to be publicly viewable (and installable) set `--access=public`. The only valid values for `access` are `public` and `restricted`. Unscoped packages _always_ have an access level of `public`. -Note: Using the `--access` flag on the `npm publish` command will only set -the package access level on the initial publish of the package. Any subsequent `npm publish` -commands using the `--access` flag will not have an effect to the access level. -To make changes to the access level after the initial publish use `npm access`. + + #### `dry-run` @@ -150,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. + + + #### `otp` * Default: null @@ -161,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. + + + #### `workspace` * Default: @@ -183,6 +191,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -192,6 +203,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-rebuild.md b/docs/content/commands/npm-rebuild.md index 49c822d730526..3d3c88e46e333 100644 --- a/docs/content/commands/npm-rebuild.md +++ b/docs/content/commands/npm-rebuild.md @@ -28,6 +28,7 @@ will be rebuilt. + #### `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` + + + #### `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. + + + #### `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. + + + #### `workspace` * Default: @@ -88,6 +98,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -97,6 +110,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-repo.md b/docs/content/commands/npm-repo.md index ade08e7d938e7..8ba2a9ec1589b 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. + #### `browser` * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -33,6 +34,9 @@ terminal. Set to `true` to use default system URL opener. + + + #### `workspace` * Default: @@ -55,6 +59,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -64,6 +71,9 @@ Enable running a command in the context of **all** the configured workspaces. This value is not exported to the environment for child processes. + + + diff --git a/docs/content/commands/npm-restart.md b/docs/content/commands/npm-restart.md index 4b905c2670695..3df262bd1a015 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 + #### `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. + + + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -57,6 +61,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 ` commands. + + + diff --git a/docs/content/commands/npm-root.md b/docs/content/commands/npm-root.md index 2d072c16dec00..b84983a320fbf 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}" + #### `global` * Default: false @@ -40,6 +41,9 @@ folder instead of the current working directory. See of the current working directory. * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` + + + diff --git a/docs/content/commands/npm-run-script.md b/docs/content/commands/npm-run-script.md index 5e3828c40717d..ea7808c0bab0e 100644 --- a/docs/content/commands/npm-run-script.md +++ b/docs/content/commands/npm-run-script.md @@ -138,6 +138,7 @@ packages. + #### `workspace` * Default: @@ -160,6 +161,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. + + + #### `workspaces` * Default: false @@ -170,6 +174,9 @@ workspaces. This value is not exported to the environment for child processes. + + + #### `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. + + + #### `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. + + + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -201,6 +214,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 ` commands. + + + diff --git a/docs/content/commands/npm-search.md b/docs/content/commands/npm-search.md index e30287635b56f..ede1c3d8c1660 100644 --- a/docs/content/commands/npm-search.md +++ b/docs/content/commands/npm-search.md @@ -41,6 +41,7 @@ expression characters in most shells.) + #### `long` * Default: false @@ -48,6 +49,9 @@ expression characters in most shells.) Show extended information in `ls`, `search`, and `help-search`. + + + #### `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. + + + #### `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. + + + #### `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. + + + #### `description` * Default: true @@ -83,6 +96,9 @@ Output parseable results from commands that write to standard output. For Show the description in `npm search` + + + #### `searchopts` * Default: "" @@ -90,6 +106,9 @@ Show the description in `npm search` Space-separated options that are always passed to search. + + + #### `searchexclude` * Default: "" @@ -97,6 +116,9 @@ Space-separated options that are always passed to search. Space-separated options that limit the results from search. + + + #### `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. + + + #### `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. + + + #### `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`. + + + #### `offline` * Default: false @@ -128,6 +159,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`. + + + diff --git a/docs/content/commands/npm-set-script.md b/docs/content/commands/npm-set-script.md index c5d5df53203b1..e4e08765325b2 100644 --- a/docs/content/commands/npm-set-script.md +++ b/docs/content/commands/npm-set-script.md @@ -30,6 +30,7 @@ npm set-script [