Skip to content

Commit 580f593

Browse files
authored
docs(plugin-essentials): Improve install command formatting (#6127)
**What's the problem this PR addresses?** <!-- Describe the rationale of your PR. --> <!-- Link all issues that it closes. (Closes/Resolves #xxxx.) --> Improve doc formatting ... **How did you fix it?** <!-- A detailed description of your implementation. --> Format it ... **Checklist** <!--- Don't worry if you miss something, chores are automatically tested. --> <!--- This checklist exists to help you remember doing the chores when you submit a PR. --> <!--- Put an `x` in all the boxes that apply. --> - [x] I have read the [Contributing Guide](https://yarnpkg.com/advanced/contributing). <!-- See https://yarnpkg.com/advanced/contributing#preparing-your-pr-to-be-released for more details. --> <!-- Check with `yarn version check` and fix with `yarn version check -i` --> - [x] I have set the packages that need to be released for my changes to be effective. <!-- The "Testing chores" workflow validates that your PR follows our guidelines. --> <!-- If it doesn't pass, click on it to see details as to what your PR might be missing. --> - [x] I will check that all automated PR checks pass before the PR gets reviewed.
1 parent 943a9f0 commit 580f593

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

Diff for: .yarn/versions/845b0c90.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
releases:
2+
"@yarnpkg/plugin-essentials": patch
3+
4+
declined:
5+
- "@yarnpkg/plugin-interactive-tools"
6+
- "@yarnpkg/plugin-typescript"
7+
- "@yarnpkg/cli"

Diff for: packages/plugin-essentials/sources/commands/install.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ export default class YarnCommand extends BaseCommand {
4141
4242
- **Fetch:** Then we download all the dependencies if needed, and make sure that they're all stored within our cache (check the value of \`cacheFolder\` in \`yarn config\` to see where the cache files are stored).
4343
44-
- **Link:** Then we send the dependency tree information to internal plugins tasked with writing them on the disk in some form (for example by generating the .pnp.cjs file you might know).
44+
- **Link:** Then we send the dependency tree information to internal plugins tasked with writing them on the disk in some form (for example by generating the \`.pnp.cjs\` file you might know).
4545
4646
- **Build:** Once the dependency tree has been written on the disk, the package manager will now be free to run the build scripts for all packages that might need it, in a topological order compatible with the way they depend on one another. See https://yarnpkg.com/advanced/lifecycle-scripts for detail.
4747
48-
Note that running this command is not part of the recommended workflow. Yarn supports zero-installs, which means that as long as you store your cache and your .pnp.cjs file inside your repository, everything will work without requiring any install right after cloning your repository or switching branches.
48+
Note that running this command is not part of the recommended workflow. Yarn supports zero-installs, which means that as long as you store your cache and your \`.pnp.cjs\` file inside your repository, everything will work without requiring any install right after cloning your repository or switching branches.
4949
5050
If the \`--immutable\` option is set (defaults to true on CI), Yarn will abort with an error exit code if the lockfile was to be modified (other paths can be added using the \`immutablePatterns\` configuration setting). For backward compatibility we offer an alias under the name of \`--frozen-lockfile\`, but it will be removed in a later release.
5151

0 commit comments

Comments
 (0)