Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove redundant trailing spaces and newlines #535

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/cli/cat-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@ Prints the contents of a file based on the hash value stored in the index file.
```
pnpm cat-file sha512-mvavhfVcEREI7d8dfvfvIkuBLnx7+rrkHHnPi8mpEDUlNpY4CUY+CvJ5mrrLl18iQYo1odFwBV7z/cOypG7xxQ==
```

1 change: 0 additions & 1 deletion docs/cli/cat-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@ Prints the index file of a specific package from the store. The package is speci
```
pnpm cat-index <pkg name>@<pkg version>
```

1 change: 0 additions & 1 deletion docs/cli/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,3 @@ When set to `global`, the performance is the same as setting the `--global` opti
### --json

Show all the config settings in JSON format.

1 change: 0 additions & 1 deletion docs/cli/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ Create a project from a `create-*` or `@foo/create-*` starter kit.
```
pnpm create react-app my-app
```

1 change: 0 additions & 1 deletion docs/cli/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,3 @@ Packages in `devDependencies` won't be installed.
## Files included in the deployed project

By default, all the files of the project are copied during deployment. The project's `package.json` may contain a "files" field to list the files and directories that should be copied.

2 changes: 1 addition & 1 deletion docs/cli/dlx.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ pnpm --package=yo --package=generator-webapp dlx yo webapp --skip-install

Runs the command inside of a shell. Uses `/bin/sh` on UNIX and `\cmd.exe` on Windows.

Example:
Example:

```
pnpm --package cowsay --package lolcatjs -c dlx 'echo "hi pnpm" | cowsay | lolcatjs'
Expand Down
1 change: 0 additions & 1 deletion docs/cli/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,3 @@ pnpm env list --remote 16
### --global, -g

The changes are made systemwide.

1 change: 0 additions & 1 deletion docs/cli/find-hash.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,3 @@ Lists the packages that include the file with the specified hash. For example:
```
pnpm find-hash sha512-mvavhfVcEREI7d8dfvfvIkuBLnx7+rrkHHnPi8mpEDUlNpY4CUY+CvJ5mrrLl18iQYo1odFwBV7z/cOypG7xxQ==
```

4 changes: 2 additions & 2 deletions docs/cli/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ will be requested from the server. To force full offline mode, use `--offline`.
If set, pnpm will ignore `NODE_ENV` and instead use this boolean value for
determining the environment.

If `true`, pnpm will not install any package listed in `devDependencies` and will remove
If `true`, pnpm will not install any package listed in `devDependencies` and will remove
those insofar they were already installed.
If `false`, pnpm will install all packages listed in `devDependencies` and `dependencies`.

### --dev, -D

Only `devDependencies` are installed and `dependencies` are removed insofar they
Only `devDependencies` are installed and `dependencies` are removed insofar they
were already installed, regardless of the `NODE_ENV`.

### --no-optional
Expand Down
1 change: 0 additions & 1 deletion docs/cli/link.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,3 @@ When dealing with **peer dependencies** it is recommended to use the `file:` pro
| Reflects source code modifications | Yes | Yes |
| Installs dependencies of the linked package | No (manual installation required) | Yes (overrides `node_modules` of the linked package)|
| Use different package manager for dependency | Possible (e.g., use `npm` for linked pkg) | No, it will use pnpm |

1 change: 0 additions & 1 deletion docs/cli/pack.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ Specifying custom compression level.
* `prepack`
* `prepare`
* `postpack`

1 change: 0 additions & 1 deletion docs/cli/prune.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ Remove the packages specified in `optionalDependencies`.
The prune command does not support recursive execution on a monorepo currently. To only install production-dependencies in a monorepo `node_modules` folders can be deleted and then re-installed with `pnpm install --prod`.

:::

1 change: 0 additions & 1 deletion docs/cli/publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,3 @@ publish-branch=production
* `postpack`
* `publish`
* `postpublish`

1 change: 0 additions & 1 deletion docs/cli/root.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ Prints the effective modules directory.
### --global, -g

The global package's modules directory is printed.

2 changes: 1 addition & 1 deletion docs/cli/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ Setup does the following actions:
* adds the pnpm home directory to the `PATH` by updating the shell configuration file
* copies the pnpm executable to the pnpm home directory

[https://get.pnpm.io/install.sh]: https://get.pnpm.io/install.sh
[https://get.pnpm.io/install.sh]: https://get.pnpm.io/install.sh
2 changes: 1 addition & 1 deletion docs/cli/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: pnpm test
Aliases: `run test`, `t`, `tst`

Runs an arbitrary command specified in the package's `test` property of its
`scripts` object.
`scripts` object.

The intended usage of the property is to specify a command that runs unit or
integration testing for your program.
2 changes: 1 addition & 1 deletion docs/cli/unlink.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ removing the external link.

:::info

If you want to remove a link made with `pnpm link --global <package>`, you should use `pnpm uninstall --global <package>`.
If you want to remove a link made with `pnpm link --global <package>`, you should use `pnpm uninstall --global <package>`.
`pnpm unlink` only removes the links in your current directory.

:::
Expand Down
6 changes: 3 additions & 3 deletions docs/continuous-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,12 +234,12 @@ You can use pnpm for installing and caching your dependencies:
pipeline {
agent {
docker {
image 'node:lts-bullseye-slim'
args '-p 3000:3000'
image 'node:lts-bullseye-slim'
args '-p 3000:3000'
}
}
stages {
stage('Build') {
stage('Build') {
steps {
sh 'corepack enable'
sh 'corepack prepare pnpm@latest-9 --activate'
Expand Down
1 change: 0 additions & 1 deletion docs/feature-comparison.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,3 @@ title: Feature Comparison
| Dynamic package execution | ✔️ - Via `pnpm dlx` | ✔️ - Via `yarn dlx` | ✔️ - Via `npx` |
| Side-effects cache | ✔️ | ❌ | ❌ |
| Listing licenses | ✔️ - Via `pnpm licenses list` | ✔️ - Via a plugin | ❌ |

2 changes: 1 addition & 1 deletion docs/git_branch_lockfiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ After that, all git branch lockfiles will be merged into one `pnpm-lock.yaml`

pnpm allows you to specify `--merge-git-branch-lockfiles` by matching the current branch name.

For instance, by the following setting in `.npmrc` file, `pnpm install` will merge all git branch lockfiles when
For instance, by the following setting in `.npmrc` file, `pnpm install` will merge all git branch lockfiles when
running in the `main` branch and the branch name starts with `release`.

```ini
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Once done, install pnpm again and it should work as expected.

## Using a shorter alias

`pnpm` might be hard to type, so you may use a shorter alias like `pn` instead.
`pnpm` might be hard to type, so you may use a shorter alias like `pn` instead.

#### Adding a permanent alias on POSIX systems

Expand Down
14 changes: 7 additions & 7 deletions docs/npmrc.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,10 +264,10 @@ Add the full URL to the package's tarball to every entry in `pnpm-lock.yaml`.
* Default: **false**
* Type: **Boolean**

When set to `true`, the generated lockfile name after installation will be named
When set to `true`, the generated lockfile name after installation will be named
based on the current branch name to completely avoid merge conflicts. For example,
if the current branch name is `feature-foo`, the corresponding lockfile name will
be `pnpm-lock.feature-foo.yaml` instead of `pnpm-lock.yaml`. It is typically used
be `pnpm-lock.feature-foo.yaml` instead of `pnpm-lock.yaml`. It is typically used
in conjunction with the command line argument `--merge-git-branch-lockfiles` or by
setting `merge-git-branch-lockfiles-branch-pattern` in the `.npmrc` file.

Expand All @@ -276,9 +276,9 @@ setting `merge-git-branch-lockfiles-branch-pattern` in the `.npmrc` file.
* Default: **null**
* Type: **Array or null**

This configuration matches the current branch name to determine whether to merge
all git branch lockfile files. By default, you need to manually pass the
`--merge-git-branch-lockfiles` command line parameter. This configuration allows
This configuration matches the current branch name to determine whether to merge
all git branch lockfile files. By default, you need to manually pass the
`--merge-git-branch-lockfiles` command line parameter. This configuration allows
this process to be automatically completed.

For instance:
Expand Down Expand Up @@ -313,7 +313,7 @@ Define the authentication bearer token to use when accessing the specified
registry. For example:

```sh
//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

You may also use an environment variable. For example:
Expand All @@ -325,7 +325,7 @@ You may also use an environment variable. For example:
Or you may just use an environment variable directly, without changing `.npmrc` at all:

```
npm_config_//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
npm_config_//registry.npmjs.org/:_authToken=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

### &lt;URL&gt;&#58;tokenHelper
Expand Down
1 change: 0 additions & 1 deletion docs/package_json.md
Original file line number Diff line number Diff line change
Expand Up @@ -644,4 +644,3 @@ Functionally identical to [`pnpm.overrides`], this field is intended to make it

[pnpm patch-commit]: ./cli/patch-commit.md
[`pnpm.overrides`]: #pnpmoverrides

4 changes: 2 additions & 2 deletions docs/pnpmfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ function readPackage(pkg, context) {
}
context.log('bar@1 => bar@2 in dependencies of foo')
}

// This will change any packages using [email protected] to use [email protected]
if (pkg.dependencies.baz) {
pkg.dependencies.baz = '1.2.3';
}

return pkg
}

Expand Down
2 changes: 1 addition & 1 deletion docs/production.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ the global store, so it will not make any requests to the registry. This is
recommended **ONLY** for environments where external access to the registry is
unavailable for whatever reason.

[store location option]: npmrc#store-dir
[store location option]: npmrc#store-dir
1 change: 0 additions & 1 deletion docs/uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,3 @@ rm -rf $(pnpm store path)

If you used pnpm in non-primary disks, then you must run the above command in every disk, where pnpm was used.
pnpm creates one store per disk.

2 changes: 1 addition & 1 deletion docs/using-changesets.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The action will detect when changeset files arrive in the `main` branch, and the

### Publishing

Add a new script `ci:publish` which executes `pnpm publish -r`.
Add a new script `ci:publish` which executes `pnpm publish -r`.
It will publish to the registry once the PR is opened by `changeset version`.

**package.json**
Expand Down
1 change: 0 additions & 1 deletion docs/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,4 +163,3 @@ Here are a few of the most popular open source projects that use the workspace f
| [Rollup plugins](https://github.com/rollup/plugins) | ![](https://img.shields.io/github/stars/rollup/plugins) | 2021-09-21 | `53fb18c0c2852598200c547a0b1d745d15b5b487` |
| [icestark](https://github.com/ice-lab/icestark) | ![](https://img.shields.io/github/stars/ice-lab/icestark) | 2021-12-16 | `4862326a8de53d02f617e7b1986774fd7540fccd` |
| [ByteMD](https://github.com/bytedance/bytemd) | ![](https://img.shields.io/github/stars/bytedance/bytemd) | 2021-02-18 | `36ef25f1ea1cd0b08752df5f8c832302017bb7fb` |

Loading