Upgrade check-spelling to v0.0.21 #2728

jsoref · 2022-11-29T12:23:03Z

Have you signed the Contributor License Agreement?
Are you working against an Issue?

Upgrades check-spelling to v0.0.21

The command to apply changes should now work on Windows (it requires Perl, but I believe that's more or less present most of the time, and it should walk you through the rest of the required tools).

There are a bunch of new features, the most important here are probably being able to update the metadata from Windows. (If it doesn't work, please @ me).

Also, candidate.patterns will automatically suggest patterns. You can see them in patterns.txt, e.g.:

# hit-count: 4 file-count: 4
# Non-English
[a-zA-Z]*[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3}[a-zA-ZÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]*

The metadata bits (the hit count/file count) don't have to be retained (I hope they'll be useful in deciding whether/or not to add a pattern, i.e. "how applicable is it?"), the comment hinting at what the pattern does is probably worth retaining.

Extra cleanup

There are too many release branches pointing to the previous version, so I'm leaving a stub for it present as I did before.

Microsoft Reviewers: Open in CodeFlow

jsoref · 2022-11-29T12:23:59Z

NOTICE

@@ -23,7 +23,6 @@ Castle.Core 4.4.0 - Apache-2.0
 (c) 2008 VeriSign, Inc.
 Copyright 2004-2016 Castle Project
 Copyright (c) 2004-2019 Castle Project
-GCopyright (c) 2004-2019 Castle Project


This line appears to be damage from an errant sed command.

It's ok to make the change in this pr at the moment, but this NOTICE is auto generated, it will be overridden whenever we have new components added. I think we should add this notice to exclude list if spell checking is not happy.

If the file is generated from other things beyond your control, then excluding it is probably the right thing to do.

Do you know where this item comes from? I'd like to fix it at the source...

This is generated for each build in the build pipeline. For example, for this pr build, the notice is generated here https://dev.azure.com/ms/winget-cli/_componentGovernance/156969?_a=components&typeId=14063008&alerts-view-option=active
This is from internal Component Governance Devops feature owned by internal compliance team.

Can you pass them a note suggesting that their data record for this item is probably buggy?

Sure, I'll file a bug for the right team to take a look.

jsoref · 2022-11-29T12:25:56Z

NOTICE.txt

@@ -1157,7 +1156,7 @@ Copyright (c) 2006-2013 Alexander Chemeris
 Copyright (c) The Internet Society (2005).
 Copyright (c) The Internet Society (2006).
 copyright 2009-2013 Christopher M. Kohlhoff
-Copyright (c) 2016, Akamai Technolgies, Inc.


This appears to be a typo (Google finds fewer than 500 hits for this spelling, although, admittedly at least one is in a proxy statement to the SEC, but even there the correct spelling is also present...).

jsoref · 2022-11-29T12:27:48Z

.github/actions/spelling/line_forbidden.patterns

@@ -19,6 +24,12 @@
 # s.b. greater than
 \bgreater then\b

+# s.b. into
+#\sin to\s


As this is not always right, I'm not leaving it active.

jsoref · 2022-11-29T12:28:39Z

.github/actions/spelling/line_forbidden.patterns

+[Rr]e[- ]entrant
+
+# s.b. workaround(s)
+#\bwork[- ]arounds?\b


Similarly, I'm leaving this out. It's right some of the time (including once below).

azure-pipelines.loc.yml

src/AppInstallerCLICore/Workflows/SettingsFlow.cpp

jsoref · 2022-11-29T12:32:55Z

src/AppInstallerCLIE2ETests/UninstallCommand.cs

-            var testreuslt = TestCommon.RunAICLICommand("install", $"{packageId}");
+            var testResult = TestCommon.RunAICLICommand("install", $"{packageId}");


this is worrisome as it appears to be unused.

I'll let one of the engineers review this to see if it's used in some back-end tests.

src/Xlang/UndockedRegFreeWinRT/src/UndockedRegFreeWinRT/Catch/catch.hpp

src/Xlang/UndockedRegFreeWinRT/src/UndockedRegFreeWinRT/Nuget/readme.txt

src/Xlang/UndockedRegFreeWinRT/src/UndockedRegFreeWinRT/detours/disasm.cpp

jsoref · 2022-11-29T12:38:38Z

.github/actions/spelling/line_forbidden.patterns

+# s.b. opt-in
+#\sopt in\s


Similarly, this isn't always right, and in fact the one case I ran into here was a bad example... (Some heuristics are really not good enough to leave lying around, and instead handling the associated cases should be left to a grammar checker that can be truly context aware...)

denelon · 2022-11-29T16:40:32Z

@jsoref thanks for raising the PR. I'll have the engineering team review and merge.

yao-msft · 2022-11-29T20:02:51Z

/azp run

azure-pipelines · 2022-11-29T20:03:06Z

Azure Pipelines successfully started running 1 pipeline(s).

Trenly · 2022-11-30T04:27:26Z

@jsoref - Would you mind updating the action at winget-pkgs also?

jsoref · 2022-12-02T04:54:02Z

(For the record: microsoft/winget-pkgs#90103 (review))

yao-msft · 2022-12-02T05:03:00Z

Files under src/purelib are subtree from https://github.com/ronomon/pure
Files under src/XLang are subtree from https://github.com/microsoft/xlang

Please revert the changes in these files and exclude the 2 projects from spell checking.

And thank you @jsoref for bringing the v0.0.21, we can finally reenable the spell check again.

Signed-off-by: Josh Soref <[email protected]>

yao-msft · 2022-12-02T05:45:17Z

/azp run

azure-pipelines · 2022-12-02T05:45:28Z

Azure Pipelines successfully started running 1 pipeline(s).

jsoref requested a review from a team as a code owner November 29, 2022 12:23

jsoref force-pushed the check-spelling-v0.0.21 branch from 9c765a2 to 3a86bef Compare November 29, 2022 12:31

jsoref commented Nov 29, 2022

View reviewed changes

jsoref force-pushed the check-spelling-v0.0.21 branch from 3a86bef to 45099f0 Compare November 29, 2022 12:36

jsoref commented Nov 29, 2022

View reviewed changes

jsoref added 10 commits December 2, 2022 00:24

spelling: async

6319b25

Signed-off-by: Josh Soref <[email protected]>

spelling: behavior

65c4b55

Signed-off-by: Josh Soref <[email protected]>

spelling: error

7d44ffe

Signed-off-by: Josh Soref <[email protected]>

spelling: into

364f18f

Signed-off-by: Josh Soref <[email protected]>

spelling: preempted

73794cb

Signed-off-by: Josh Soref <[email protected]>

spelling: result

5b1f794

Signed-off-by: Josh Soref <[email protected]>

spelling: technologies

94dcf11

Signed-off-by: Josh Soref <[email protected]>

spelling: workaround

0c7d8c7

Signed-off-by: Josh Soref <[email protected]>

Use check-spelling/[email protected]

81d2939

Leave spelling2.yml blocked

04585b9

jsoref force-pushed the check-spelling-v0.0.21 branch from 45099f0 to 04585b9 Compare December 2, 2022 05:41

yao-msft approved these changes Dec 2, 2022

View reviewed changes

yao-msft merged commit 4b8e189 into microsoft:master Dec 2, 2022

jsoref deleted the check-spelling-v0.0.21 branch December 3, 2022 22:41

jsoref mentioned this pull request Dec 3, 2022

spelling: installation #2739

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade check-spelling to v0.0.21 #2728

Upgrade check-spelling to v0.0.21 #2728

jsoref commented Nov 29, 2022 •

edited by ghost

Loading

jsoref Nov 29, 2022

yao-msft Dec 2, 2022

jsoref Dec 2, 2022

jsoref Dec 2, 2022

yao-msft Dec 2, 2022

jsoref Dec 2, 2022

yao-msft Dec 2, 2022

jsoref Nov 29, 2022

jsoref Nov 29, 2022

jsoref Nov 29, 2022

jsoref Nov 29, 2022

denelon Nov 29, 2022

jsoref Nov 29, 2022

denelon commented Nov 29, 2022

yao-msft commented Nov 29, 2022

azure-pipelines bot commented Nov 29, 2022

Trenly commented Nov 30, 2022

jsoref commented Dec 2, 2022

yao-msft commented Dec 2, 2022

yao-msft commented Dec 2, 2022

azure-pipelines bot commented Dec 2, 2022

		var testreuslt = TestCommon.RunAICLICommand("install", $"{packageId}");
		var testResult = TestCommon.RunAICLICommand("install", $"{packageId}");

Upgrade check-spelling to v0.0.21 #2728

Upgrade check-spelling to v0.0.21 #2728

Conversation

jsoref commented Nov 29, 2022 • edited by ghost Loading

Extra cleanup

Microsoft Reviewers: Open in CodeFlow

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

denelon commented Nov 29, 2022

yao-msft commented Nov 29, 2022

azure-pipelines bot commented Nov 29, 2022

Trenly commented Nov 30, 2022

jsoref commented Dec 2, 2022

yao-msft commented Dec 2, 2022

yao-msft commented Dec 2, 2022

azure-pipelines bot commented Dec 2, 2022

jsoref commented Nov 29, 2022 •

edited by ghost

Loading