Check spelling 0.0.22 #16127

jsoref · 2023-10-11T07:11:49Z

Summary of the Pull Request

Upgrades check-spelling to v0.0.22

References and Relevant Issues

Detailed Description of the Pull Request / Additional comments

refreshes workflow
- enables dependabot PRs to trigger CI (so that in the future you'll be able to see breaking changes to the dictionary paths)
refreshes metadata
built-in handling of \n/\r/\t is removed -- This means that the patterns/0_*.txt files can be removed.
this specific PR includes some shim content, in allow/check-spelling-0.0.21.txt -- once it this PR merges, it can be removed on a branch and the next CI will clean out items from expect.txt relating to the \r stuff and suggest replacement content.
talking to the bot is enabled for forks (but not the master repository)
SARIF reporting is enabled for PRs w/in a single repository (not across forks)
In job reports, there's a summary table (space permitting) linking to instances (this is a poor man's SARIF report)
When a pattern splits a thing that results in check-spelling finding an unrecognized token, that's reported with a distinct category
When there are items in expect that not longer match anything but more specific items do (e.g. microsoft vs. Microsoft), there's now a specific category with help/advice
Fancier excludes suggestions (excluding directories, file types, ...)
Refreshed dictionaries
The comment now links to the job summary (which includes SARIF link if available, the details view, and a generated commit that people can use if they're ok w/ the expect changes and don't want to run perl)

Validation Steps Performed

the branch was developed in https://github.com/check-spelling-sandbox/terminal/actions?query=branch%3Acheck-spelling-0.0.22
ensuring compatibility with 0.0.21 was done in Check spelling 0.0.22 check-spelling-sandbox/terminal#3
this version has been in development for a year and has quite a few improvements, we've been actively dogfooding it throughout this period 😄

PR Checklist

Closes #xxx
Tests added/passed
Documentation updated
- If checked, please file a pull request on our docs repo and link it here: #xxx
Schema updated (if necessary)

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

jsoref · 2023-10-11T07:13:34Z

.github/actions/spelling/advice.md

@@ -6,8 +6,6 @@

 By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

-:warning: The command is written for posix shells. If it doesn't work for you, you can manually _add_ (one word per line) / _remove_ items to `expect.txt` and the `excludes.txt` files.


the command should now work on Windows shells

jsoref · 2023-10-11T07:16:21Z

.github/actions/spelling/candidate.patterns

 # the negative lookahead here is to allow catching 'templatesz' as a misspelling
 # but to otherwise recognize a Windows path with \templates\foo.template or similar:
-\\(?:necessary|r(?:eport|esolve[dr]?|esult)|t(?:arget|emplates?))(?![a-z])
+#\\(?:necessary|r(?:eport|esolve[dr]?|esult)|t(?:arget|emplates?))(?![a-z])


this is no longer necessary in 0.0.22 as I removed the built-in \n/\r/\t handling

jsoref · 2023-10-11T07:17:14Z

.github/actions/spelling/excludes.txt

 \.zip$
 ^\.github/actions/spelling/
-^\.github/fabricbot.json$


apparently fabricbot is gone

jsoref · 2023-10-11T07:20:10Z

.github/actions/spelling/allow/check-spelling-0.0.21.txt

This file can be removed once this PR merges, it's here to make the v0.0.21 engine happy. (I meant to include it in the initial PR, but missed a push...)

(GitHub's definition of outdated is buggy, there's a github discussion where people complain about this poor behavior -- this comment is not outdated)

jsoref · 2023-10-11T07:22:41Z

.github/workflows/spelling2.yml

-    tags-ignore:
-    - "**"


this was never supported by pull_request_target as it / pull_request never applied to tags.

jsoref · 2023-10-11T07:37:44Z

.github/actions/spelling/reject.txt

@@ -1,6 +1,7 @@
 ^attache$
 ^attacher$
 ^attachers$
+^bellow$


another archaic word I ran across... -- it's unlikely you'll want to reference stoking fires quite like this.

UGH THANK YOU

jsoref · 2023-10-11T07:38:29Z

.github/actions/spelling/patterns/patterns.txt

-# latex
-\\(?:n(?:ew|ormal|osub)|r(?:enew)|t(?:able(?:of|)|he|itle))(?=[a-z]+)


as check-spelling no longer special cases \n/\r/\t, the workaround can be removed :)

jsoref · 2023-10-11T07:38:46Z

.github/actions/spelling/patterns/0_n.txt

as check-spelling no longer special cases \n/\r/\t, the workaround can be removed :)

jsoref · 2023-10-11T07:38:55Z

.github/actions/spelling/patterns/0_r.txt

as check-spelling no longer special cases \n/\r/\t, the workaround can be removed :)

jsoref · 2023-10-11T07:38:59Z

.github/actions/spelling/patterns/0_t.txt

as check-spelling no longer special cases \n/\r/\t, the workaround can be removed :)

DHowett · 2023-10-19T00:49:09Z

AHH, I'm so excited!

We might-could need to revert the changes under dep/ and oss/. I'll noodle on that.

Thank you for doing this!

oss/stb/stb_rect_pack.h

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

This file can be deleted after this branch is merged.

DHowett · 2023-12-05T21:14:09Z

Okay, wow, I 100% didn't notice that you had done the oss/ and dep/ things. Dang it github! Force pushes are pushes too!

I'll review and summarily merge

DHowett · 2023-12-05T21:19:55Z

doc/specs/drafts/#3327 - Application Theming/#3327 - Application Theming.md

-not a XAML resource that controls this, nor is this something that's exposed by
+no XAML resource that controls this, nor is this something that's exposed by


Oh, I like that pattern!

DHowett · 2023-12-05T21:20:31Z

Ugh, I shouldnae've merged main.

@jsoref

As noted by @jsoref in #16127, we could eventually remove this and also check-spelling would make suggestions on what patterns to use.

jsoref added 4 commits October 10, 2023 09:26

spelling: coarse-grained

1873031

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

spelling: fine-grained

ade4145

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

spelling: github

dfb4db1

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

spelling: macos

67a42dc

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

This comment has been minimized.

Sign in to view

jsoref force-pushed the check-spelling-0.0.22 branch from 0096300 to abbfedb Compare October 11, 2023 07:30

jsoref commented Oct 11, 2023

View reviewed changes

lhecker reviewed Oct 31, 2023

View reviewed changes

oss/stb/stb_rect_pack.h Outdated Show resolved Hide resolved

jsoref added 5 commits October 31, 2023 11:23

spelling: no

2e20b70

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

spelling: shouldn't

9267c52

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

spelling: the

320aa90

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

Update to check-spelling v0.0.22

fc9d245

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

Temporarily make check-spelling v0.0.21 happy

f97210c

This file can be deleted after this branch is merged.

jsoref force-pushed the check-spelling-0.0.22 branch from abbfedb to f97210c Compare October 31, 2023 15:34

lhecker approved these changes Nov 1, 2023

View reviewed changes

Merge branch 'main' into check-spelling-0.0.22

267b6eb

This comment has been minimized.

Sign in to view

DHowett approved these changes Dec 5, 2023

View reviewed changes

Fix spelling issues in the similarIssues workflow

2565569

DHowett merged commit dc986e4 into microsoft:main Dec 5, 2023
6 of 11 checks passed

DHowett mentioned this pull request Dec 5, 2023

ci: remove the check-spelling-0.0.21 shim #16424

Merged

zadjii-msft pushed a commit that referenced this pull request Dec 6, 2023

ci: remove the check-spelling-0.0.21 shim (#16424)

306f31a

As noted by @jsoref in #16127, we could eventually remove this and also check-spelling would make suggestions on what patterns to use.

jsoref deleted the check-spelling-0.0.22 branch December 6, 2023 12:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Check spelling 0.0.22 #16127

Check spelling 0.0.22 #16127

jsoref commented Oct 11, 2023

This comment has been minimized.

jsoref Oct 11, 2023

jsoref Oct 11, 2023

jsoref Oct 11, 2023

jsoref Oct 11, 2023

jsoref Oct 11, 2023

jsoref Oct 11, 2023

jsoref Oct 11, 2023

DHowett Dec 5, 2023

jsoref Oct 11, 2023

jsoref Oct 11, 2023

jsoref Oct 11, 2023

jsoref Oct 11, 2023

DHowett commented Oct 19, 2023

DHowett commented Dec 5, 2023

This comment has been minimized.

DHowett Dec 5, 2023

DHowett commented Dec 5, 2023

		@@ -6,8 +6,6 @@

		By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

		:warning: The command is written for posix shells. If it doesn't work for you, you can manually _add_ (one word per line) / _remove_ items to `expect.txt` and the `excludes.txt` files.

		# latex
		\\(?:n(?:ew\|ormal\|osub)\|r(?:enew)\|t(?:able(?:of\|)\|he\|itle))(?=[a-z]+)

		not a XAML resource that controls this, nor is this something that's exposed by
		no XAML resource that controls this, nor is this something that's exposed by

Check spelling 0.0.22 #16127

Check spelling 0.0.22 #16127

Conversation

jsoref commented Oct 11, 2023

Summary of the Pull Request

References and Relevant Issues

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

PR Checklist

This comment has been minimized.

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

DHowett commented Oct 19, 2023

DHowett commented Dec 5, 2023

This comment has been minimized.

Choose a reason for hiding this comment

DHowett commented Dec 5, 2023