diff --git a/docs/cli/cat-file.md b/docs/cli/cat-file.md index 0071eb0c2869..eb8e259ce066 100644 --- a/docs/cli/cat-file.md +++ b/docs/cli/cat-file.md @@ -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== ``` - diff --git a/docs/cli/cat-index.md b/docs/cli/cat-index.md index 05c31d7a3e52..e95871a8ea10 100644 --- a/docs/cli/cat-index.md +++ b/docs/cli/cat-index.md @@ -8,4 +8,3 @@ Prints the index file of a specific package from the store. The package is speci ``` pnpm cat-index @ ``` - diff --git a/docs/cli/config.md b/docs/cli/config.md index 31a65a17a01e..d01558b514cc 100644 --- a/docs/cli/config.md +++ b/docs/cli/config.md @@ -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. - diff --git a/docs/cli/create.md b/docs/cli/create.md index a22b6afc1140..1f55d479800b 100644 --- a/docs/cli/create.md +++ b/docs/cli/create.md @@ -10,4 +10,3 @@ Create a project from a `create-*` or `@foo/create-*` starter kit. ``` pnpm create react-app my-app ``` - diff --git a/docs/cli/deploy.md b/docs/cli/deploy.md index eec6cd10dd84..73bcb904147f 100644 --- a/docs/cli/deploy.md +++ b/docs/cli/deploy.md @@ -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. - diff --git a/docs/cli/dlx.md b/docs/cli/dlx.md index b82d5b8ec44d..9e7e5e9bed1e 100644 --- a/docs/cli/dlx.md +++ b/docs/cli/dlx.md @@ -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' diff --git a/docs/cli/env.md b/docs/cli/env.md index afda20c679ab..de14c65fe323 100644 --- a/docs/cli/env.md +++ b/docs/cli/env.md @@ -103,4 +103,3 @@ pnpm env list --remote 16 ### --global, -g The changes are made systemwide. - diff --git a/docs/cli/find-hash.md b/docs/cli/find-hash.md index d51b58d42266..d81245e5a03e 100644 --- a/docs/cli/find-hash.md +++ b/docs/cli/find-hash.md @@ -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== ``` - diff --git a/docs/cli/install.md b/docs/cli/install.md index 58e69139681f..27c8d2e0437a 100644 --- a/docs/cli/install.md +++ b/docs/cli/install.md @@ -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 diff --git a/docs/cli/link.md b/docs/cli/link.md index 663105577009..016d3e64d969 100644 --- a/docs/cli/link.md +++ b/docs/cli/link.md @@ -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 | - diff --git a/docs/cli/pack.md b/docs/cli/pack.md index ef0b4dae2b63..018d2697f592 100644 --- a/docs/cli/pack.md +++ b/docs/cli/pack.md @@ -20,4 +20,3 @@ Specifying custom compression level. * `prepack` * `prepare` * `postpack` - diff --git a/docs/cli/prune.md b/docs/cli/prune.md index 1d9e8de83c63..b3ec6737aa09 100644 --- a/docs/cli/prune.md +++ b/docs/cli/prune.md @@ -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`. ::: - diff --git a/docs/cli/publish.md b/docs/cli/publish.md index ed5ebf3df174..9ef6a2411a44 100644 --- a/docs/cli/publish.md +++ b/docs/cli/publish.md @@ -121,4 +121,3 @@ publish-branch=production * `postpack` * `publish` * `postpublish` - diff --git a/docs/cli/root.md b/docs/cli/root.md index 05d516905aba..4d649ab73f1b 100644 --- a/docs/cli/root.md +++ b/docs/cli/root.md @@ -10,4 +10,3 @@ Prints the effective modules directory. ### --global, -g The global package's modules directory is printed. - diff --git a/docs/cli/setup.md b/docs/cli/setup.md index 14e809e31e49..46f775a9e4a0 100644 --- a/docs/cli/setup.md +++ b/docs/cli/setup.md @@ -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 \ No newline at end of file +[https://get.pnpm.io/install.sh]: https://get.pnpm.io/install.sh diff --git a/docs/cli/test.md b/docs/cli/test.md index 057274cf67d5..b374ab9892da 100644 --- a/docs/cli/test.md +++ b/docs/cli/test.md @@ -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. diff --git a/docs/cli/unlink.md b/docs/cli/unlink.md index 74e74f91bd26..bd91f3cff554 100644 --- a/docs/cli/unlink.md +++ b/docs/cli/unlink.md @@ -13,7 +13,7 @@ removing the external link. :::info -If you want to remove a link made with `pnpm link --global `, you should use `pnpm uninstall --global `. +If you want to remove a link made with `pnpm link --global `, you should use `pnpm uninstall --global `. `pnpm unlink` only removes the links in your current directory. ::: diff --git a/docs/continuous-integration.md b/docs/continuous-integration.md index c2fd1832920c..41e2b286a43c 100644 --- a/docs/continuous-integration.md +++ b/docs/continuous-integration.md @@ -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' diff --git a/docs/feature-comparison.md b/docs/feature-comparison.md index 7f4082620d58..e4d49f819f56 100644 --- a/docs/feature-comparison.md +++ b/docs/feature-comparison.md @@ -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 | ❌ | - diff --git a/docs/git_branch_lockfiles.md b/docs/git_branch_lockfiles.md index f56ffeb7bcde..a4924c55e4aa 100644 --- a/docs/git_branch_lockfiles.md +++ b/docs/git_branch_lockfiles.md @@ -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 diff --git a/docs/installation.md b/docs/installation.md index 392af36be026..4c23944b8c40 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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 diff --git a/docs/npmrc.md b/docs/npmrc.md index a1096d760d35..9972219b2c60 100644 --- a/docs/npmrc.md +++ b/docs/npmrc.md @@ -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. @@ -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: @@ -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: @@ -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 ``` ### <URL>:tokenHelper diff --git a/docs/package_json.md b/docs/package_json.md index d1819579673e..605b9a1b0559 100644 --- a/docs/package_json.md +++ b/docs/package_json.md @@ -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 - diff --git a/docs/pnpmfile.md b/docs/pnpmfile.md index dd9ede1fc5fe..6234bc6b5673 100644 --- a/docs/pnpmfile.md +++ b/docs/pnpmfile.md @@ -57,12 +57,12 @@ function readPackage(pkg, context) { } context.log('bar@1 => bar@2 in dependencies of foo') } - + // This will change any packages using baz@x.x.x to use baz@1.2.3 if (pkg.dependencies.baz) { pkg.dependencies.baz = '1.2.3'; } - + return pkg } diff --git a/docs/production.md b/docs/production.md index 474a89156bb0..47b428dfcf08 100644 --- a/docs/production.md +++ b/docs/production.md @@ -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 diff --git a/docs/uninstall.md b/docs/uninstall.md index cac8d3ce092b..f3a43f1f3769 100644 --- a/docs/uninstall.md +++ b/docs/uninstall.md @@ -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. - diff --git a/docs/using-changesets.md b/docs/using-changesets.md index b0344f890acd..5bd1af0ff050 100644 --- a/docs/using-changesets.md +++ b/docs/using-changesets.md @@ -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** diff --git a/docs/workspaces.md b/docs/workspaces.md index 739451917cb6..089410525faa 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -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` | -