Fix typos
Just thought I'd contribute some typo fixes I stumbled upon. Nothing controversial (hopefully).
Use the following command to get a quick and dirty summary of the specific corrections made:
git diff HEAD^! --word-diff-regex='\w+' -U0 \
| grep -E '\[\-.*\-\]\{\+.*\+\}' \
| sed -r 's/.*\[\-(.*)\-\]\{\+(.*)\+\}.*/\1 \2/' \
| sort | uniq -c | sort -n
FWIW, the top typos are:
- geometrys (5)
- pathes (4)
- trimed (4)
- particel (3)
- overriden (3)
- mergable (3)
- wether (3)
- immediatly (3)
- advices (2)
- checksumed (2)
- accurancy (2)
Checklist
- [x] I have read the Contributing Guide.
- [ ] I have set the packages that need to be released for my changes to be effective.
- [x] I will check that all automated PR checks pass before the PR gets reviewed.
Should I mark all releases "declined" given this PR is purely cosmetic typo fixes?
So, about the releases. Obviously these are not minor-level changes, so each package is either "patch" or "declined". And which package should be marked as which is a matter of: "would a user of the package see a difference?" For example:
plugin-essentialis a patch-level change, because changing a command's description affects the--helpoutputplugin-execis a patch-level change, because the README is a human-readable part of a package. So fixing a typo there makes it ever so slightly more understandableyarnpkg-pnpifyshould be marked as "declined". The JSDoc isn't distributed with the package and doesn't affect runtime behavior. The changes are visible from the API reference on the website but those are built directly from the master branch source code so releasing a new version is not necessary.plugin-packshould be marked as "declined". Renaming a variable does not affect runtime behavior
Excellent explanation @clemyan , thanks for taking the time. The only other scenario I'm wondering about is the error message fix in yarnpkg-pnp - I assume this is a user facing patch-level change?
Another question - should plugin-typescript be released because it has a peer dependency on yarnpkg/plugin-essentials which has a CLI output change? I ask because the interactive version check tool didn't prompt for that one.
The only other scenario I'm wondering about is the error message fix in
yarnpkg-pnp- I assume this is a user facing patch-level change?
Yes, error messages are part of the runtime behavior.
Another question - should
plugin-typescriptbe released because it has a peer dependency onyarnpkg/plugin-essentialswhich has a CLI output change? I ask because the interactive version check tool didn't prompt for that one.
No. The peer dependency means anything that depends on plugin-typescript should also depend on plugin-essentials. Thus users can upgrade plugin-essentials independent of plugin-typescript.