CLI documentation update from CI
CI User committed
May 7, 2021 at 02:54 UTC
f6a334613cde893e9abbcf35373eda9f7ae8c457
16 files changed
+29
-32
cli/v7
+1
-1
@@ -1 +1 @@
1
-Subproject commit 7912cb9abe20c6b62bcccddef61b712e7be9005d
1
+Subproject commit 049166bbc96b6e223a436dd849f3bf3daac37164
content/cli/v7/commands/npm-cache.md
+5
-5
@@ -17,10 +17,10 @@ github_path: docs/content/commands/npm-cache.md
17
### Synopsis
18
19
```bash
20
-npm cache add <tarball file>
21
-npm cache add <folder>
22
-npm cache add <tarball url>
23
-npm cache add <name>@<version>
20
+npm cache add <tarball file>...
21
+npm cache add <folder>...
22
+npm cache add <tarball url>...
23
+npm cache add <name>@<version>...
24
25
npm cache clean
26
aliases: npm cache clear, npm cache rm
@@ -35,7 +35,7 @@ Note: This command is unaware of workspaces.
35
Used to add, list, or clean the npm cache folder.
36
37
* add:
38
- Add the specified package to the local cache. This command is primarily
38
+ Add the specified packages to the local cache. This command is primarily
39
intended to be used internally by npm, but it can provide a way to
40
add data to the local installation cache explicitly.
41
content/cli/v7/commands/npm-ci.md
+1
-1
@@ -22,7 +22,7 @@ npm ci
22
23
### Description
24
25
-This command is similar to [`npm install`](/cli-commands/install), except
25
+This command is similar to [`npm install`](/cli/v7/commands/npm-install), except
26
it's meant to be used in automated environments such as test platforms,
27
continuous integration, and deployment -- or any situation where you want
28
to make sure you're doing a clean install of your dependencies.
content/cli/v7/commands/npm-dedupe.md
+4
-4
@@ -84,7 +84,7 @@ Using `npm find-dupes` will run the command in `--dry-run` mode.
84
85
### See Also
86
87
-* [npm find-dupes](/cli-commands/find-dupes)
88
-* [npm ls](/cli-commands/ls)
89
-* [npm update](/cli-commands/update)
90
-* [npm install](/cli-commands/install)
87
+* [npm find-dupes](/cli/v7/commands/npm-find-dupes)
88
+* [npm ls](/cli/v7/commands/npm-ls)
89
+* [npm update](/cli/v7/commands/npm-update)
90
+* [npm install](/cli/v7/commands/npm-install)
content/cli/v7/commands/npm-deprecate.md
+2
-2
@@ -54,5 +54,5 @@ format an empty string.
54
55
* [npm publish](/cli/v7/commands/npm-publish)
56
* [npm registry](/cli/v7/using-npm/registry)
57
-* [npm owner](/cli-commands/owner)
58
-* [npm owner](/cli-commands/adduser)
57
+* [npm owner](/cli/v7/commands/npm-owner)
58
+* [npm owner](/cli/v7/commands/npm-adduser)
content/cli/v7/commands/npm-explore.md
-1
@@ -54,5 +54,4 @@ The shell to run for the `npm explore` command.
54
* [npm folders](/cli/v7/configuring-npm/folders)
55
* [npm edit](/cli/v7/commands/npm-edit)
56
* [npm rebuild](/cli/v7/commands/npm-rebuild)
57
-* [npm build](/cli/v7/commands/npm-build)
57
* [npm install](/cli/v7/commands/npm-install)
content/cli/v7/commands/npm-find-dupes.md
+4
-4
@@ -27,8 +27,8 @@ duplications, without actually changing the package tree.
27
28
### See Also
29
30
-* [npm dedupe](/cli-commands/dedupe)
31
-* [npm ls](/cli-commands/ls)
32
-* [npm update](/cli-commands/update)
33
-* [npm install](/cli-commands/install)
30
+* [npm dedupe](/cli/v7/commands/npm-dedupe)
31
+* [npm ls](/cli/v7/commands/npm-ls)
32
+* [npm update](/cli/v7/commands/npm-update)
33
+* [npm install](/cli/v7/commands/npm-install)
34
content/cli/v7/commands/npm-install.md
-1
@@ -549,7 +549,6 @@ the specific folder structures that npm creates.
549
* [npm link](/cli/v7/commands/npm-link)
550
* [npm rebuild](/cli/v7/commands/npm-rebuild)
551
* [npm scripts](/cli/v7/using-npm/scripts)
552
-* [npm build](/cli/v7/commands/npm-build)
552
* [npm config](/cli/v7/commands/npm-config)
553
* [npmrc](/cli/v7/configuring-npm/npmrc)
554
* [npm registry](/cli/v7/using-npm/registry)
content/cli/v7/commands/npm-unpublish.md
+2
-2
@@ -44,7 +44,7 @@ This removes a package version from the registry, deleting its entry and
44
removing the tarball.
45
46
The npm registry will return an error if you are not [logged
47
-in](/cli/v7/commands/npm-login).
47
+in](/cli/v7/commands/npm-adduser).
48
49
If you do not specify a version or if you remove all of a package's
50
versions then the registry will remove the root package entry entirely.
@@ -62,4 +62,4 @@ passed.
62
* [npm registry](/cli/v7/using-npm/registry)
63
* [npm adduser](/cli/v7/commands/npm-adduser)
64
* [npm owner](/cli/v7/commands/npm-owner)
65
-* [npm login](/cli/v7/commands/npm-login)
65
+* [npm login](/cli/v7/commands/npm-adduser)
content/cli/v7/commands/npm-view.md
+1
-1
@@ -83,7 +83,7 @@ npm view express contributors.name contributors.email
83
84
"Person" fields are shown as a string if they would be shown as an
85
object. So, for example, this will show the list of `npm` contributors in
86
-the shortened string format. (See [`package.json`](/cli/v7/configuring-npm/package.json) for more on this.)
86
+the shortened string format. (See [`package.json`](/cli/v7/configuring-npm/package-json) for more on this.)
87
88
```bash
89
npm view npm contributors
content/cli/v7/commands/npm.md
+1
-1
@@ -116,7 +116,7 @@ following help topics:
116
Create an account or log in. When you do this, npm will store
117
credentials in the user config file config file.
118
* publish:
119
- Use the [`npm publish`](/cli/v7/commands/npm-publish`) command to upload your
119
+ Use the [`npm publish`](/cli/v7/commands/npm-publish) command to upload your
120
code to the registry.
121
122
#### Configuration
content/cli/v7/configuring-npm/folders.md
+1
-1
@@ -213,7 +213,7 @@ not be included in the package tarball.
213
214
This allows a package maintainer to install all of their dependencies
215
(and dev dependencies) locally, but only re-publish those items that
216
-cannot be found elsewhere. See [`package.json`](/cli/v7/configuring-npm/package.json) for more information.
216
+cannot be found elsewhere. See [`package.json`](/cli/v7/configuring-npm/package-json) for more information.
217
218
### See also
219
content/cli/v7/configuring-npm/package-json.md
+1
-1
@@ -576,7 +576,7 @@ tarball or git URL.
576
**Please do not put test harnesses or transpilers or other "development"
577
time tools in your `dependencies` object.** See `devDependencies`, below.
578
579
-See [semver](/cli/v7/using-npm/semver#versions) for more details about specifying version ranges.
579
+See [semver](https://github.com/npm/node-semver#versions) for more details about specifying version ranges.
580
581
* `version` Must match `version` exactly
582
* `>version` Must be greater than `version`
content/cli/v7/using-npm/config.md
+4
-1
@@ -1261,7 +1261,8 @@ Show short usage output about the command specified.
1261
1262
#### `user-agent`
1263
1264
-* Default: "npm/{npm-version} node/{node-version} {platform} {arch} {ci}"
1264
+* Default: "npm/{npm-version} node/{node-version} {platform} {arch}
1265
+ workspaces/{workspaces} {ci}"
1266
* Type: String
1267
1268
Sets the User-Agent request header. The following fields are replaced with
@@ -1271,6 +1272,8 @@ their actual counterparts:
1272
* `{node-version}` - The Node.js version in use
1273
* `{platform}` - The value of `process.platform`
1274
* `{arch}` - The value of `process.arch`
1275
+* `{workspaces}` - Set to `true` if the `workspaces` or `workspace` options
1276
+ are set.
1277
* `{ci}` - The value of the `ci-name` config, if set, prefixed with `ci/`, or
1278
an empty string if `ci-name` is empty.
1279
content/cli/v7/using-npm/scripts.md
+1
-6
@@ -126,11 +126,6 @@ The advantage of doing these things at `prepublish` time is that they can be don
126
127
* `prepare`
128
129
-#### [`npm env`](/cli/v7/commands/npm-env)
130
-
131
-* `env` (You can override the default behavior of `npm env` by defining
132
- a custom `env` entry in your `scripts` object)
133
-
129
#### [`npm install`](/cli/v7/commands/npm-install)
130
131
These also run when you run `npm install -g <pkg-name>`
@@ -187,7 +182,7 @@ If there is a `restart` script defined, these events are run, otherwise
182
* `restart`
183
* `postrestart`
184
190
-#### [`npm run <user defined>`](/cli/v7/commands/npm-run)
185
+#### [`npm run <user defined>`](/cli/v7/commands/npm-run-script)
186
187
* `pre<user-defined>`
188
* `<user-defined>`
package-lock.json
+1
@@ -32813,6 +32813,7 @@
32813
"details-element-polyfill": "2.4.0",
32814
"jest-axe": "3.2.0",
32815
"polished": "3.5.2",
32816
+ "react": "^16.10.2",
32817
"react-is": "16.10.2",
32818
"styled-system": "5.1.2"
32819
},