Skip to content

Commit 2b96821

Browse files
committed
chore: Guard markdown blocks
perl -pi -e 's/^(\`\`\`[a-z]+)/$1\n/' Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
1 parent 88c5143 commit 2b96821

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+198
-0
lines changed

docs/lib/content/commands/npm-audit.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ To ensure the integrity of packages you download from the public npm registry, o
3535
Registry signatures can be verified using the following `audit` command:
3636

3737
```bash
38+
3839
$ npm audit signatures
3940
```
4041

@@ -47,6 +48,7 @@ The npm CLI supports registry signatures and signing keys provided by any regist
4748
1. Signatures are provided in the package's `packument` in each published version within the `dist` object:
4849

4950
```json
51+
5052
"dist":{
5153
"..omitted..": "..omitted..",
5254
"signatures": [{
@@ -153,48 +155,56 @@ If vulnerabilities were found the exit code will depend on the
153155
Scan your project for vulnerabilities and automatically install any compatible updates to vulnerable dependencies:
154156

155157
```bash
158+
156159
$ npm audit fix
157160
```
158161

159162
Run `audit fix` without modifying `node_modules`, but still updating the pkglock:
160163

161164
```bash
165+
162166
$ npm audit fix --package-lock-only
163167
```
164168

165169
Skip updating `devDependencies`:
166170

167171
```bash
172+
168173
$ npm audit fix --only=prod
169174
```
170175

171176
Have `audit fix` install SemVer-major updates to toplevel dependencies, not just SemVer-compatible ones:
172177

173178
```bash
179+
174180
$ npm audit fix --force
175181
```
176182

177183
Do a dry run to get an idea of what `audit fix` will do, and _also_ output install information in JSON format:
178184

179185
```bash
186+
180187
$ npm audit fix --dry-run --json
181188
```
182189

183190
Scan your project for vulnerabilities and just show the details, without fixing anything:
184191

185192
```bash
193+
186194
$ npm audit
187195
```
188196

189197
Get the detailed audit report in JSON format:
190198

191199
```bash
200+
192201
$ npm audit --json
193202
```
194203

195204
Fail an audit only if the results include a vulnerability with a level of moderate or higher:
196205

197206
```bash
207+
198208
$ npm audit --audit-level=moderate
199209
```
200210

docs/lib/content/commands/npm-ci.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ An easy way to do this is to run, for example,
3838
Make sure you have a package-lock and an up-to-date install:
3939

4040
```bash
41+
4142
$ cd ./my/npm/project
4243
$ npm install
4344
added 154 packages in 10s
@@ -47,13 +48,15 @@ $ ls | grep package-lock
4748
Run `npm ci` in that project
4849

4950
```bash
51+
5052
$ npm ci
5153
added 154 packages in 5s
5254
```
5355

5456
Configure Travis CI to build using `npm ci` instead of `npm install`:
5557

5658
```bash
59+
5760
# .travis.yml
5861
install:
5962
- npm ci

docs/lib/content/commands/npm-completion.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The synopsis above loads the completions into your current shell.
1616
Adding it to your ~/.bashrc or ~/.zshrc will make the completions available everywhere:
1717

1818
```bash
19+
1920
npm completion >> ~/.bashrc
2021
npm completion >> ~/.zshrc
2122
```

docs/lib/content/commands/npm-config.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Config supports the following sub-commands:
2525
#### set
2626

2727
```bash
28+
2829
npm config set key=value [key=value...]
2930
npm set key=value [key=value...]
3031
```
@@ -39,6 +40,7 @@ Note: for backwards compatibility, `npm config set key value` is supported as an
3940
#### get
4041

4142
```bash
43+
4244
npm config get [key ...]
4345
npm get [key ...]
4446
```
@@ -52,6 +54,7 @@ If no keys are provided, then this command behaves the same as `npm config list`
5254
#### list
5355

5456
```bash
57+
5558
npm config list
5659
```
5760

@@ -63,6 +66,7 @@ to show the settings in json format.
6366
#### delete
6467

6568
```bash
69+
6670
npm config delete key [key ...]
6771
```
6872

@@ -71,6 +75,7 @@ Deletes the specified keys from all configuration files.
7175
#### edit
7276

7377
```bash
78+
7479
npm config edit
7580
```
7681

@@ -80,6 +85,7 @@ Opens the config file in an editor.
8085
#### fix
8186

8287
```bash
88+
8389
npm config fix
8490
```
8591

docs/lib/content/commands/npm-dedupe.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ a
2525
In this case, `npm dedupe` will transform the tree to:
2626

2727
```bash
28+
2829
a
2930
+-- b
3031
+-- d

docs/lib/content/commands/npm-deprecate.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This command will update the npm registry entry for a package, providing a depre
1515
It works on [version ranges](https://semver.npmjs.com/) as well as specific versions, so you can do something like this:
1616

1717
```bash
18+
1819
npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
1920
```
2021

@@ -23,6 +24,7 @@ include prerelease versions.
2324
For example:
2425

2526
```bash
27+
2628
npm deprecate my-thing@1.x "1.x is no longer supported"
2729
```
2830

docs/lib/content/commands/npm-dist-tag.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,14 @@ This is the default action if none is specified.
3232
A tag can be used when installing packages as a reference to a version instead of using a specific version number:
3333

3434
```bash
35+
3536
npm install <name>@<tag>
3637
```
3738

3839
When installing dependencies, a preferred tagged version may be specified:
3940

4041
```bash
42+
4143
npm install --tag <tag>
4244
```
4345

docs/lib/content/commands/npm-explain.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The package spec can also refer to a folder within `./node_modules`
1919
For example, running `npm explain glob` within npm's source tree will show:
2020

2121
```bash
22+
2223
glob@7.1.6
2324
node_modules/glob
2425
glob@"^7.1.4" from the root project
@@ -36,6 +37,7 @@ To explain just the package residing at a specific folder, pass that as the argu
3637
This can be useful when trying to figure out exactly why a given dependency is being duplicated to satisfy conflicting version requirements within the project.
3738

3839
```bash
40+
3941
$ npm explain node_modules/nyc/node_modules/find-up
4042
find-up@3.0.0 dev
4143
node_modules/nyc/node_modules/find-up

docs/lib/content/commands/npm-explore.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ If a command is specified, then it is run in the subshell, which then immediatel
1717
This is particularly handy in the case of git submodules in the `node_modules` folder:
1818

1919
```bash
20+
2021
npm explore some-dependency -- git pull origin master
2122
```
2223

docs/lib/content/commands/npm-fund.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ It's possible to filter the results to only include a single workspace and its d
3131
Here's an example running `npm fund` in a project with a configured workspace `a`:
3232

3333
```bash
34+
3435
$ npm fund
3536
test-workspaces-fund@1.0.0
3637
+-- https://example.com/a
@@ -46,6 +47,7 @@ test-workspaces-fund@1.0.0
4647
And here is an example of the expected result when filtering only by a specific workspace `a` in the same project:
4748

4849
```bash
50+
4951
$ npm fund -w a
5052
test-workspaces-fund@1.0.0
5153
`-- https://example.com/a

0 commit comments

Comments
 (0)