Skip to content

Commit 0469c5e

Browse files
authored
docs: rewrap markdown (#8639)
1 parent 9ceb9c1 commit 0469c5e

Some content is hidden

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

46 files changed

+194
-413
lines changed

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ Used to set access controls on private packages.
1515
For all of the subcommands, `npm access` will perform actions on the packages in the current working directory if no package name is passed to the subcommand.
1616

1717
* grant / revoke:
18-
Add or remove the ability of users and teams to have read-only or read-write
19-
access to a package.
18+
Add or remove the ability of users and teams to have read-only or read-write access to a package.
2019

2120
### Details
2221

@@ -30,8 +29,7 @@ You must have privileges to set the access of a package:
3029

3130
* You are an owner of an unscoped or scoped package.
3231
* You are a member of the team that owns a scope.
33-
* You have been given read-write privileges for a package, either as a member
34-
of a team or directly as an owner.
32+
* You have been given read-write privileges for a package, either as a member of a team or directly as an owner.
3533

3634
If you have two-factor authentication enabled then you'll be prompted to provide a second factor, or may use the `--otp=...` option to specify it on the command line.
3735

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,7 @@ If remediations do not require changes to the dependency ranges, then all vulner
145145
The `npm audit` command will exit with a 0 exit code if no vulnerabilities were found.
146146
The `npm audit fix` command will exit with 0 exit code if no vulnerabilities are found _or_ if the remediation is able to successfully fix all vulnerabilities.
147147

148-
If vulnerabilities were found the exit code will depend on the
149-
[`audit-level` config](/using-npm/config#audit-level).
148+
If vulnerabilities were found the exit code will depend on the [`audit-level` config](/using-npm/config#audit-level).
150149

151150
### Examples
152151

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

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,20 @@ description: Clean install a project
1010

1111
### Description
1212

13-
This command is similar to [`npm install`](/commands/npm-install), except it's meant to be used in automated environments such as test platforms,
14-
continuous integration, and deployment -- or any situation where you want to make sure you're doing a clean install of your dependencies.
13+
This command is similar to [`npm install`](/commands/npm-install), except it's meant to be used in automated environments such as test platforms, continuous integration, and deployment -- or any situation where you want to make sure you're doing a clean install of your dependencies.
1514

1615
The main differences between using `npm install` and `npm ci` are:
1716

1817
* The project **must** have an existing `package-lock.json` or
1918
`npm-shrinkwrap.json`.
2019
* If dependencies in the package lock do not match those in `package.json`,
2120
`npm ci` will exit with an error, instead of updating the package lock.
22-
* `npm ci` can only install entire projects at a time: individual
23-
dependencies cannot be added with this command.
24-
* If a `node_modules` is already present, it will be automatically removed
25-
before `npm ci` begins its install.
21+
* `npm ci` can only install entire projects at a time: individual dependencies cannot be added with this command.
22+
* If a `node_modules` is already present, it will be automatically removed before `npm ci` begins its install.
2623
* It will never write to `package.json` or any of the package-locks:
2724
installs are essentially frozen.
2825

29-
NOTE: If you create your `package-lock.json` file by running `npm install`
30-
with flags that can affect the shape of your dependency tree, such as
26+
NOTE: If you create your `package-lock.json` file by running `npm install` with flags that can affect the shape of your dependency tree, such as
3127
`--legacy-peer-deps` or `--install-links`, you _must_ provide the same flags to `npm ci` or you are likely to encounter errors.
3228
An easy way to do this is to run, for example,
3329
`npm config set legacy-peer-deps=true --location=project` and commit the

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,7 @@ npm config list
5757

5858
Show all the config settings.
5959
Use `-l` to also show defaults.
60-
Use `--json`
61-
to show the settings in json format.
60+
Use `--json` to show the settings in json format.
6261

6362
#### delete
6463

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ a
4444
```
4545
4646
During the installation process, the `[email protected]` dependency for `b` was placed in the root of the tree.
47-
Though `d`'s dependency on `[email protected]` could have been satisfied by `[email protected]`, the newer `[email protected]` dependency was used,
48-
because npm favors updates by default, even when doing so causes duplication.
47+
Though `d`'s dependency on `[email protected]` could have been satisfied by `[email protected]`, the newer `[email protected]` dependency was used, because npm favors updates by default, even when doing so causes duplication.
4948

5049
Running `npm dedupe` will cause npm to note the duplication and re-evaluate, deleting the nested `c` module, because the one in the root is sufficient.
5150

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ It works on [version ranges](https://semver.npmjs.com/) as well as specific vers
1818
npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
1919
```
2020

21-
SemVer ranges passed to this command are interpreted such that they *do*
22-
include prerelease versions.
21+
SemVer ranges passed to this command are interpreted such that they *do* include prerelease versions.
2322
For example:
2423

2524
```bash
@@ -31,8 +30,7 @@ In this case, a version `[email protected]` will also be deprecated.
3130
You must be the package owner to deprecate something.
3231
See the `owner` and `adduser` help topics.
3332

34-
To un-deprecate a package, specify an empty string (`""`) for the `message`
35-
argument.
33+
To un-deprecate a package, specify an empty string (`""`) for the `message` argument.
3634
Note that you must use double quotes with no space between them to format an empty string.
3735

3836
### Configuration

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ description: Open documentation for a package in a web browser
1010

1111
### Description
1212

13-
This command tries to guess at the likely location of a package's documentation URL, and then tries to open it using the
14-
[`--browser` config](/using-npm/config#browser) param.
13+
This command tries to guess at the likely location of a package's documentation URL, and then tries to open it using the [`--browser` config](/using-npm/config#browser) param.
1514
You can pass multiple package names at once.
1615
If no package name is provided, it will search for a `package.json` in the current folder and use the `name` property.
1716

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

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,12 @@ description: Check the health of your npm environment
1414
npm is mostly a standalone tool, but it does have some basic requirements that must be met:
1515

1616
+ Node.js and git must be executable by npm.
17-
+ The primary npm registry, `registry.npmjs.com`, or another service that
18-
uses the registry API, is available.
19-
+ The directories that npm uses, `node_modules` (both locally and
20-
globally), exist and can be written by the current user.
17+
+ The primary npm registry, `registry.npmjs.com`, or another service that uses the registry API, is available.
18+
+ The directories that npm uses, `node_modules` (both locally and globally), exist and can be written by the current user.
2119
+ The npm cache exists, and the package tarballs within it aren't corrupt.
2220

2321
Without all of these working properly, npm may not work properly.
24-
Many issues are often attributable to things that are outside npm's code base,
25-
so `npm doctor` confirms that the npm installation is in a good state.
22+
Many issues are often attributable to things that are outside npm's code base, so `npm doctor` confirms that the npm installation is in a good state.
2623

2724
Also, in addition to this, there are also very many issue reports due to using old versions of npm.
2825
Since npm is constantly improving, running `npm@latest` is better than an old version.
@@ -37,11 +34,9 @@ By default, npm installs from the primary npm registry,
3734
`registry.npmjs.org`.
3835
`npm doctor` hits a special connection testing endpoint within the registry.
3936
This can also be checked with `npm ping`.
40-
If this check fails, you may be using a proxy that needs to be configured, or may need to talk to your IT staff to get access over
41-
HTTPS to `registry.npmjs.org`.
37+
If this check fails, you may be using a proxy that needs to be configured, or may need to talk to your IT staff to get access over HTTPS to `registry.npmjs.org`.
4238

43-
This check is done against whichever registry you've configured (you can see what that is by running `npm config get registry`), and if you're using
44-
a private registry that doesn't support the `/whoami` endpoint supported by the primary registry, this check may fail.
39+
This check is done against whichever registry you've configured (you can see what that is by running `npm config get registry`), and if you're using a private registry that doesn't support the `/whoami` endpoint supported by the primary registry, this check may fail.
4540

4641
#### `Checking npm version`
4742

@@ -52,8 +47,7 @@ The team believes that the latest tested version of npm is almost always likely
5247
#### `Checking node version`
5348

5449
For most users, in most circumstances, the best version of Node will be the latest long-term support (LTS) release.
55-
Those of you who want access to new
56-
ECMAscript features or bleeding-edge changes to Node's standard library may be running a newer version, and some may be required to run an older version of Node because of enterprise change control policies.
50+
Those of you who want access to new ECMAscript features or bleeding-edge changes to Node's standard library may be running a newer version, and some may be required to run an older version of Node because of enterprise change control policies.
5751
That's OK!
5852
But in general, the npm team recommends that most users run Node.js LTS.
5953

@@ -66,18 +60,15 @@ This part of `npm doctor` just lets you, and maybe whoever's helping you with su
6660

6761
#### `Checking for git executable in PATH`
6862

69-
While it's documented in the README, it may not be obvious that npm needs
70-
Git installed to do many of the things that it does.
71-
Also, in some cases
72-
– especially on Windows – you may have Git set up in such a way that it's not accessible via your `PATH` so that npm can find it.
63+
While it's documented in the README, it may not be obvious that npm needs Git installed to do many of the things that it does.
64+
Also, in some cases – especially on Windows – you may have Git set up in such a way that it's not accessible via your `PATH` so that npm can find it.
7365
This check ensures that Git is available.
7466

7567
#### Permissions checks
7668

7769
* Your cache must be readable and writable by the user running npm.
7870
* Global package binaries must be writable by the user running npm.
79-
* Your local `node_modules` path, if you're running `npm doctor` with a
80-
project directory, must be readable and writable by the user running npm.
71+
* Your local `node_modules` path, if you're running `npm doctor` with a project directory, must be readable and writable by the user running npm.
8172

8273
#### Validate the checksums of cached packages
8374

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ description: Edit an installed package
1010

1111
### Description
1212

13-
Selects a dependency in the current project and opens the package folder in the default editor (or whatever you've configured as the npm `editor`
14-
config -- see [`npm-config`](npm-config).)
13+
Selects a dependency in the current project and opens the package folder in the default editor (or whatever you've configured as the npm `editor` config -- see [`npm-config`](npm-config).)
1514

1615
After it has been edited, the package is rebuilt so as to pick up any changes in compiled packages.
1716

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ description: Retrieve funding information
1212

1313
This command retrieves information on how to fund the dependencies of a given project.
1414
If no package name is provided, it will list all dependencies that are looking for funding in a tree structure, listing the type of funding and the url to visit.
15-
If a package name is provided then it tries to open its funding url using the
16-
[`--browser` config](/using-npm/config#browser) param; if there are multiple funding sources for the package, the user will be instructed to pass the
15+
If a package name is provided then it tries to open its funding url using the [`--browser` config](/using-npm/config#browser) param; if there are multiple funding sources for the package, the user will be instructed to pass the
1716
`--which` option to disambiguate.
1817

1918
The list will avoid duplicated entries and will stack all packages that share the same url as a single entry.
@@ -23,8 +22,7 @@ Thus, the list does not have the same shape of the output from `npm ls`.
2322

2423
### Workspaces support
2524

26-
It's possible to filter the results to only include a single workspace and its dependencies using the
27-
[`workspace` config](/using-npm/config#workspace) option.
25+
It's possible to filter the results to only include a single workspace and its dependencies using the [`workspace` config](/using-npm/config#workspace) option.
2826

2927
#### Example:
3028

0 commit comments

Comments
 (0)