CLI documentation update from CI
CI User committed
Feb 18, 2022 at 02:28 UTC
10dd46c3e02d117973aac3ba22c67ac1c3c27399
3 files changed
+17
-12
cli/v8
+1
-1
@@ -1 +1 @@
1
-Subproject commit 20c83fae76ff4a051e4f6542a328f1c00cf071bb
1
+Subproject commit dd63e21a0e192f5a7e797d6c89595fd09dbfd7b9
content/cli/v8/commands/npm-ping.md
+6
-3
@@ -28,11 +28,14 @@ Ping the configured or given npm registry and verify authentication.
28
If it works it will output something like:
29
30
```bash
31
-Ping success: {*Details about registry*}
31
+npm notice PING https://registry.npmjs.org/
32
+npm notice PONG 255ms
33
```
33
-otherwise you will get:
34
+otherwise you will get an error:
35
```bash
35
-Ping error: {*Detail about error}
36
+npm notice PING http://foo.com/
37
+npm ERR! code E404
38
+npm ERR! 404 Not Found - GET http://www.foo.com/-/ping?write=true
39
```
40
41
### Configuration
content/cli/v8/using-npm/workspaces.md
+10
-8
@@ -38,24 +38,25 @@ Workspaces are usually defined via the `workspaces` property of the
38
{
39
"name": "my-workspaces-powered-project",
40
"workspaces": [
41
- "workspace-a"
41
+ "packages/a"
42
]
43
}
44
```
45
46
Given the above `package.json` example living at a current working
47
-directory `.` that contains a folder named `workspace-a` that itself contains
47
+directory `.` that contains a folder named `packages/a` that itself contains
48
a `package.json` inside it, defining a Node.js package, e.g:
49
50
```
51
.
52
+-- package.json
53
-`-- workspace-a
54
- `-- package.json
53
+`-- packages
54
+ +-- a
55
+ | `-- package.json
56
```
57
58
The expected result once running `npm install` in this current working
58
-directory `.` is that the folder `workspace-a` will get symlinked to the
59
+directory `.` is that the folder `packages/a` will get symlinked to the
60
`node_modules` folder of the current working dir.
61
62
Below is a post `npm install` example, given that same previous example
@@ -64,11 +65,12 @@ structure of files and folders:
65
```
66
.
67
+-- node_modules
67
-| `-- workspace-a -> ../workspace-a
68
+| `-- packages/a -> ../packages/a
69
+-- package-lock.json
70
+-- package.json
70
-`-- workspace-a
71
- `-- package.json
71
+`-- packages
72
+ +-- a
73
+ | `-- package.json
74
```
75
76
### Getting started with workspaces