Spell check by jsoref · Pull Request #645 · microsoft/winget-cli

Josh Soref (jsoref) · 2020-11-14T23:52:49Z

closes #559

This enables https://github.com/marketplace/actions/check-spelling

Microsoft Reviewers: Open in CodeFlow

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

Josh Soref (jsoref)

It's possible to split the spelling fixes from the spell-check action, but it's important to land the spell-checker w/o letting there be too much drift between its PR base and master -- it's bad to land it if there have been typos introduced since its base (as all new PRs from its landing will have confusing failures).

For reference, this PR gets a ✅ : jsoref@4ad3543

Josh Soref (jsoref) · 2020-11-15T00:26:20Z

  <data name="SourceListField" xml:space="preserve">
    <value>Veld</value>
-    <comment>The name of a peice of information about a source.</comment>
+    <comment>The name of a piece of information about a source.</comment>


It's possible I should drop the localization comment changes (I never know what the policy is)

Certainly the localization comments can be updated; they will just be overwritten by future changes if needed.

Josh Soref (jsoref) · 2020-11-15T00:28:01Z


    CompletionTestCommand command;
-    command.SubCommandNames = { "car", "cart", "cartesion", "carpet" };
+    command.SubCommandNames = { "car", "cart", "cartesian", "carpet" };


This change is probably the biggest

Josh Soref (jsoref) · 2020-11-15T00:29:11Z

 {
    // If moved to C++20, this can be replaced with standard library implementations.
-    void OutputTimepoint(std::ostream& stream, const std::chrono::system_clock::time_point& time)
+    void OutputTimePoint(std::ostream& stream, const std::chrono::system_clock::time_point& time)


Given that the underlying type is time_point, it made sense to me to use this capitalization

Josh Soref (jsoref) · 2020-11-15T00:29:34Z

                return "winget upgrade --all completed with failures";
            default:
-                return "Uknown Error Code";
+                return "Unknown Error Code";


This could be a cli api change

Josh Soref (jsoref) · 2020-11-15T00:30:10Z

                        if (!availablePackage)
                        {
-                            AICLI_LOG(Repo, Warning, << "  Appropriate available package could not be determined, setting availablility state to unknown");
+                            AICLI_LOG(Repo, Warning, << "  Appropriate available package could not be determined, setting availability state to unknown");


This may be a cli api change

Josh Soref (jsoref) · 2020-11-15T00:30:29Z

        //  DisplayVersion
        //  Version
-        //  MajorVerison, MinorVersion
+        //  MajorVersion, MinorVersion


Google Sheets suggested Verizon

Major Verizon

A lot of these changes are my extremely common typos that I failed to correct. I'm sure that some sort of ML (or just analysis of qwerty) could probably figure out that one of my fingers jumps the gun on the others occasionally.

Add JsonCppLib

Revert spelling changes to JsonCppLib.

JohnMcPMS · 2020-11-16T19:56:06Z

+    - uses: actions/checkout@v2.0.0
+      with:
+        fetch-depth: 5
+    - uses: check-spelling/check-spelling@0.0.16-alpha


check-spelling/check-spelling@0.0.16-alpha [](start = 12, length = 42)

I'm not familiar with GitHub Actions.

Will we need to update this version manually to keep up with new releases?

Do we need to do something to manage the secrets.GITHUB_TOKEN? Or is that automatically done by the Actions infrastructure?

Generally, are there any other actions we need to take to manage this (beyond excludes, patterns, etc. for new changes)?

Thanks for your work here.

In theory Dependabot (@dependabot) can tell you about updates, but for the near term, I'll probably make the PR myself.

The GITHUB_TOKEN is automatic https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#about-the-github_token-secret

Beyond that and trying to avoid merging things with spelling errors (if the main branch is unhappy, anyone who branches from that point will be unhappy / confused), no.

There is the option to add an advice.txt file which is included in the message the bot leaves, but that's totally tunable and that's really something you'll work through as a project.

Technically GitHub has a budget for actions, it's theoretically possible for someone to run into this limit, I suspect that Microsoft has a reasonably large budget and you won't notice (certainly microsoft/terminal hasn't complained) -- if someone publicly runs into this, I'd love to hear about it. (Generally other actions are more expensive than this one -- which runs at about 1 minute and is thus billed as 1-2 units.) Most likely if a project like yours hits something like this, it means you have a bunch of files that should be ignored that you aren't ignoring (one project I'm looking at takes ~20 minutes to scan). -- If this becomes a problem for some other project in the future, I'll probably write some code so that it tries to scan only changed files instead of the whole repository.

Thanks for the info, I agree that only checking changed files seems like a good optimization opportunity.

JohnMcPMS · 2020-11-16T21:47:00Z

/azp run

azure-pipelines · 2020-11-16T21:47:11Z

Azure Pipelines successfully started running 1 pipeline(s).

Josh Soref (jsoref) added 30 commits November 14, 2020 18:16

spelling: availability

f22c4cf

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: available

5a76b01

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: boundary

afc70c8

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: character

017b5a8

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: comparison

fbaa90c

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: determines

81175ad

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: diagnostic

3e0f72e

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: experimental

5e95dea

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: failed

77b1df9

spelling: hexadecimal

9a7b974

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: hresult-s

1ac041e

spelling: indices

3ec3e19

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: individual

d6de9c4

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: interactive

b4ae83f

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: initializes

5deeaca

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: meaning

5f33c85

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: named

ff97936

spelling: piece

5455d72

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: provide

ce4ea4b

spelling: release

0654ffe

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: semantic

526ffa6

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: time-point

b60aebd

spelling: unknown

89f8919

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: bumping

0f9ba46

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: cartesian

3c87827

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: input

fe9cb91

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: insensitive

20419fe

spelling: setup

a817ee9

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: source

a029eb4

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: successfully

ab00736

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

Josh Soref (jsoref) added 2 commits November 14, 2020 18:45

spelling: version

45eaec1

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

Set up spell-checking action

4ad3543

Josh Soref (jsoref) requested a review from a team as a code owner November 14, 2020 23:52

ghost added the Issue-Docs It's a documentation issue that really should be on MicrosoftDocs label Nov 14, 2020

Josh Soref (jsoref) commented Nov 15, 2020

View reviewed changes

Demitrius Nelon (denelon) requested a review from JohnMcPMS November 16, 2020 16:59

JohnMcPMS reviewed Nov 16, 2020

View reviewed changes

Comment thread .github/actions/spelling/excludes.txt Resolved

JohnMcPMS added 2 commits November 16, 2020 11:43

Update excludes.txt

8c45b2e

Add JsonCppLib

Update jsoncpp.cpp

44bd6f2

Revert spelling changes to JsonCppLib.

JohnMcPMS reviewed Nov 16, 2020

View reviewed changes

JohnMcPMS approved these changes Nov 16, 2020

View reviewed changes

JohnMcPMS merged commit 0e1e0b4 into microsoft:master Nov 16, 2020

Conversation

Josh Soref (jsoref) commented Nov 14, 2020 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Microsoft Reviewers: Open in CodeFlow

Uh oh!

Josh Soref (jsoref) left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JohnMcPMS commented Nov 16, 2020

Uh oh!

azure-pipelines Bot commented Nov 16, 2020

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Josh Soref (jsoref) commented Nov 14, 2020 •

edited by ghost

Loading