berry icon indicating copy to clipboard operation
berry copied to clipboard

Fix typos

Open NathanBaulch opened this issue 1 year ago • 5 comments

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

  • [ ] 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.

NathanBaulch avatar Sep 01 '24 21:09 NathanBaulch

Should I mark all releases "declined" given this PR is purely cosmetic typo fixes?

NathanBaulch avatar Sep 02 '24 02:09 NathanBaulch

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-essential is a patch-level change, because changing a command's description affects the --help output
  • plugin-exec is 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 understandable
  • yarnpkg-pnpify should 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-pack should be marked as "declined". Renaming a variable does not affect runtime behavior

clemyan avatar Sep 15 '24 15:09 clemyan

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?

NathanBaulch avatar Sep 15 '24 21:09 NathanBaulch

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.

NathanBaulch avatar Sep 15 '24 23:09 NathanBaulch

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-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.

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.

clemyan avatar Sep 16 '24 04:09 clemyan