diff options
| author | Gar <gar+gh@danger.computer> | 2022-06-22 23:45:41 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-22 23:45:41 +0300 |
| commit | 69b5a9674e8c03219c3da088b35b8ec6dea69770 (patch) | |
| tree | e6799096e6a86cdd1d14bae35e4fcbf45b59fb80 /docs/content/commands/npm-install-test.md | |
| parent | f2340f816f5a137038945229bf8a0d30160e76e8 (diff) | |
docs: consolidate docs and help for package spec (#5048)
Many of our commands parse their args via
[npm-package-arg](https://npm.im/npm-package-arg), which is a good
standard way of parsing a "package" argument. However the docs
surrounding these args are not very consistent. This can lead to
confusion in commands such as `npm publish` where the behavior is
slightly different than in the past due to this.
This adds a new help command `npm help package-spec` that describes what
this argument is, and can be, and also updates all the commands that
interpret their args this with to refer to them as `<package-spec>`. It
also adds a link to the new help page on their docs pages.
Diffstat (limited to 'docs/content/commands/npm-install-test.md')
| -rw-r--r-- | docs/content/commands/npm-install-test.md | 11 |
1 files changed, 1 insertions, 10 deletions
diff --git a/docs/content/commands/npm-install-test.md b/docs/content/commands/npm-install-test.md index 3dd860ea5..d27686e73 100644 --- a/docs/content/commands/npm-install-test.md +++ b/docs/content/commands/npm-install-test.md @@ -11,16 +11,7 @@ description: Install package(s) and run tests <!-- see lib/commands/install-test.js --> ```bash -npm install-test [<@scope>/]<pkg> -npm install-test [<@scope>/]<pkg>@<tag> -npm install-test [<@scope>/]<pkg>@<version> -npm install-test [<@scope>/]<pkg>@<version range> -npm install-test <alias>@npm:<name> -npm install-test <folder> -npm install-test <tarball file> -npm install-test <tarball url> -npm install-test <git:// url> -npm install-test <github username>/<github project> +npm install-test [<package-spec> ...] alias: it ``` |