Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos #6479

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix typos #6479

wants to merge 3 commits into from

Conversation

NathanBaulch
Copy link

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.
  • I will check that all automated PR checks pass before the PR gets reviewed.

@NathanBaulch
Copy link
Author

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

@clemyan
Copy link
Member

clemyan commented Sep 15, 2024

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

@NathanBaulch
Copy link
Author

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
Copy link
Author

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.

@clemyan
Copy link
Member

clemyan commented Sep 16, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants