Harmonize package manager install / add instructions #5765
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
Instructions for installing cypress and other npm modules are shown inconsistently throughout the website for npm, pnpm and Yarn package managers.
The examples vary; sometimes using a short-form optional flag and sometimes an equivalent long-form:
Similarly varied is the positioning of an optional flag:
Although the different variations are correct, it can be confusing to have examples which are arbitrarily different.
Changes
The long-form is used for optional flags, e.g.
--save-dev
. This makes for better comprehension for readers unfamiliar with the meaning of the alternative short-form optional flag, e.g.The positioning of optional flags is aligned to the package manager documentation, e.g.
Historical entries in the Changelog are left unchanged.
References
npm-install
showing-D, --save-dev
andsave-dev
yarn add
showingyarn add <package...> [--dev/-D]
pnpm add
showing--save-dev, -D