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

Upgrade to check-spelling 0.0.20alpha7 #19127

Merged
merged 17 commits into from
Jul 1, 2022

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Jun 30, 2022

Summary of the Pull Request

  • Upgrades to check-spelling 0.0.20alpha7
  • Upgrades the workflow to include comment collapsing, see add a typo check-spelling-sandbox/PowerToys#8 for an example
  • Adds duplicate word detection (controlled via line_forbidden.patterns) -- you can see a number of examples in this PR
  • Adds some not quite word flags (e.g. pre-existing, MicroSoft, and Github) -- this complained about Github -- if this is a problem, that item can be removed from line_forbidden.patterns
  • Removes words from the core dictionary (via reject.txt) -- this caught wether which is an archaic word that was originally reported by the terminal folks
  • Moves wil to allow.txt (which is a way to add items to the dictionary -- the opposite of reject.txt)
  • Adds a README.md file to the spelling directory (to explain these files)

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

jsoref added 15 commits June 30, 2022 17:23
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Config based on:
https://github.com/check-spelling/spell-check-this/tree/a5001170a754da309ca324ce7eed8a076af2f4ac

* Adding duplicate detection to patterns.txt
* Adding line_forbidden.patterns
* Adding reject.txt
* Updated excludes (and sorted)
* Switching to unified workflow

* moving `wil` to allow.txt to clarify that it's a term of art
  (https://github.com/microsoft/wil), whereas often it's a typo for `will`.
Copy link
Contributor Author

@jsoref jsoref left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The forbidden items flagged here shouldn't appear once the PR merges, as they aren't present here:
https://github.com/jsoref/PowerToys/runs/7140523891?check_suite_focus=true

I'm not quite certain why the 0.0.20alpha3 version is complaining about the patterns.

* When you add new strings make sure you have add add all translations for it.
* When you add new strings make sure you have added all translations for it.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is notable in that it isn't the obvious change

/// The time stamp stamp for this message, equivalent to what GetMessageTime would return for this message.
/// The time stamp for this message, equivalent to what GetMessageTime would return for this message.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm on the fence on what change to make here, e.g. using timestamp.

public void DedupFunctionWhenCalledMustNotRemovelnkWhichdoesNotHaveExe()
public void DedupFunctionWhenCalledMustNotRemovelnkWhichDoesNotHaveExe()
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure this is an auto thing, and there didn't seem to be any reason not to do:

-Whichdoes
+WhichDoes

Comment on lines -29 to +31
public string GithubRepo {
public string GitHubRepo {
get {
return ((string)(this["GithubRepo"]));
return ((string)(this["GitHubRepo"]));
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This commit is probably the most notable.

src/runner/main.cpp Outdated Show resolved Hide resolved
@Jay-o-Way Jay-o-Way added the Area-GitHub workflow Issues regarding the GitHub workflow and automation label Jul 1, 2022
jaimecbernardo and others added 2 commits July 1, 2022 14:18
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Copy link
Collaborator

@jaimecbernardo jaimecbernardo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixes look great to me. Thanks a lot for the contribution!

@jaimecbernardo jaimecbernardo merged commit 3cb0638 into microsoft:main Jul 1, 2022
@jsoref jsoref deleted the check-spelling-0-0-20-a7 branch July 1, 2022 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-GitHub workflow Issues regarding the GitHub workflow and automation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants