[PR #9014] [MERGED] ci: update to Spell check to 0.0.17a #27385

Open
opened 2026-01-31 09:21:40 +00:00 by claunia · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/microsoft/terminal/pull/9014
Author: @jsoref
Created: 2/3/2021
Status: ✅ Merged
Merged: 2/3/2021
Merged by: @DHowett

Base: main ← Head: spell-check


📝 Commits (4)

  • 9229257 ci: spelling: update to 0.0.17a
  • 1e5b446 ci: spelling: fold expect files together
  • 94737ac ci: spelling: make capture relative
  • aea05b6 ci: spelling: suggest updating excludes for binary files

📊 Changes

28 files changed (+67 additions, -56 deletions)

View changed files

➖ .github/actions/spell-check/dictionary/api.txt (+0 -0)
➖ .github/actions/spell-check/expect/5757ec679b03a4240130c3c53766c91bbc5cd6a7.txt (+0 -1)
➖ .github/actions/spell-check/expect/655f007265b351e140d20b3976792523ad689241.txt (+0 -7)
➖ .github/actions/spell-check/expect/a129ff14ec985d6b7bf09e296a831c955d41040b.txt (+0 -14)
📝 .github/actions/spelling/advice.txt (+11 -9)
📝 .github/actions/spelling/dictionary/README.md (+0 -0)
📝 .github/actions/spelling/dictionary/apis.txt (+0 -0)
📝 .github/actions/spelling/dictionary/chinese.txt (+0 -0)
📝 .github/actions/spelling/dictionary/colors.txt (+0 -0)
📝 .github/actions/spelling/dictionary/dictionary.txt (+8 -0)
📝 .github/actions/spelling/dictionary/fonts.txt (+1 -0)
📝 .github/actions/spelling/dictionary/japanese.txt (+0 -0)
📝 .github/actions/spelling/dictionary/math.txt (+0 -0)
📝 .github/actions/spelling/dictionary/microsoft.txt (+8 -0)
📝 .github/actions/spelling/dictionary/names.txt (+1 -0)
📝 .github/actions/spelling/excludes.txt (+1 -1)
📝 .github/actions/spelling/expect/README.md (+0 -0)
📝 .github/actions/spelling/expect/alphabet.txt (+0 -0)
📝 .github/actions/spelling/expect/expect.txt (+31 -13)
📝 .github/actions/spelling/expect/web.txt (+0 -0)

...and 8 more files

📄 Description

Summary of the Pull Request

Upgrade the spell checking action

References

https://github.com/microsoft/terminal/pull/9004#issuecomment-771825083

PR Checklist

  • Closes #xxx
  • CLA signed. If not, go over here and sign the CLA
  • Tests added/passed
  • Documentation updated. If checked, please file a pull request on our docs repo and link it here: #xxx
  • Schema updated.
  • I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx

Detailed Description of the Pull Request / Additional comments

Plurals and paste tenses

In the past, plurals foo+s and past tenses foo+ed were automatically tolerated. This turned out to be a bad design choice on my part.

The basic example is that potatos would sometimes be treated as a mistake and sometimes not (depending on the presence of potato).

You can see in this PR, that this logic resulted in Applys being accepted as a word along with AppContainered -- there's nothing intrinsically wrong w/ the latter, but unfortunately in order to screen out the former, my shortcut just couldn't stick around. This means that the dictionary/expect files will grow perhaps by a tiny bit, but as you can see, not really by much.

This is also why thereses (a user) was accepted as a word in the past (therese is in the base dictionary, so therese + s was acceptable).

Pull requests

When GitHub initially introduced GitHub Actions, the event for pull_request was created without enough permission for a tool like this to work properly. I worked around that by using the schedule event. In 2020, they introduced a replacement event pull_request_target which has enough permission. This means that I can stop relying on the schedule event.

Miscellaneous

  • I've folded together some expect/ files since now is as good a time as any.
  • I've included a hint about excludes.txt (I added a similar one for our primary repo recently, and it came up this week in microsoft/terminal -- @zadjii-msft)
  • I've standardized on a default of .github/actions/spelling to make the out of the box experience easier for new adopters, so I'm applying that change here -- if you're attached to the old directory name, specifying it is still supported. -- note the directory rename may cause a merge conflict for people with open PRs and changes to the contents, this shouldn't be a big problem.

Validation Steps Performed

I've created a temporary repo which is using this as its default branch.

There's a sample PR here:
https://github.com/check-spelling/terminal/pull/1

If people want, they're welcome to create PRs into that repo to test (you can also test in your own forks -- just be sure that you enable or re-enable the workflow -- GitHub has disabled workflows with schedule in inactive repositories to save CPU cycles).


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/microsoft/terminal/pull/9014 **Author:** [@jsoref](https://github.com/jsoref) **Created:** 2/3/2021 **Status:** ✅ Merged **Merged:** 2/3/2021 **Merged by:** [@DHowett](https://github.com/DHowett) **Base:** `main` ← **Head:** `spell-check` --- ### 📝 Commits (4) - [`9229257`](https://github.com/microsoft/terminal/commit/92292579c5f23ba597a8588f6c6cfd018dd13cc8) ci: spelling: update to 0.0.17a - [`1e5b446`](https://github.com/microsoft/terminal/commit/1e5b44631c59211135b3b1e3a73330b415d4f3a8) ci: spelling: fold expect files together - [`94737ac`](https://github.com/microsoft/terminal/commit/94737ac14a7e65b2176553ea6e40f4ae593cf85a) ci: spelling: make capture relative - [`aea05b6`](https://github.com/microsoft/terminal/commit/aea05b649c0743f4d81fdeb94cc878d1cd5caa16) ci: spelling: suggest updating excludes for binary files ### 📊 Changes **28 files changed** (+67 additions, -56 deletions) <details> <summary>View changed files</summary> ➖ `.github/actions/spell-check/dictionary/api.txt` (+0 -0) ➖ `.github/actions/spell-check/expect/5757ec679b03a4240130c3c53766c91bbc5cd6a7.txt` (+0 -1) ➖ `.github/actions/spell-check/expect/655f007265b351e140d20b3976792523ad689241.txt` (+0 -7) ➖ `.github/actions/spell-check/expect/a129ff14ec985d6b7bf09e296a831c955d41040b.txt` (+0 -14) 📝 `.github/actions/spelling/advice.txt` (+11 -9) 📝 `.github/actions/spelling/dictionary/README.md` (+0 -0) 📝 `.github/actions/spelling/dictionary/apis.txt` (+0 -0) 📝 `.github/actions/spelling/dictionary/chinese.txt` (+0 -0) 📝 `.github/actions/spelling/dictionary/colors.txt` (+0 -0) 📝 `.github/actions/spelling/dictionary/dictionary.txt` (+8 -0) 📝 `.github/actions/spelling/dictionary/fonts.txt` (+1 -0) 📝 `.github/actions/spelling/dictionary/japanese.txt` (+0 -0) 📝 `.github/actions/spelling/dictionary/math.txt` (+0 -0) 📝 `.github/actions/spelling/dictionary/microsoft.txt` (+8 -0) 📝 `.github/actions/spelling/dictionary/names.txt` (+1 -0) 📝 `.github/actions/spelling/excludes.txt` (+1 -1) 📝 `.github/actions/spelling/expect/README.md` (+0 -0) 📝 `.github/actions/spelling/expect/alphabet.txt` (+0 -0) 📝 `.github/actions/spelling/expect/expect.txt` (+31 -13) 📝 `.github/actions/spelling/expect/web.txt` (+0 -0) _...and 8 more files_ </details> ### 📄 Description <!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? --> ## Summary of the Pull Request Upgrade the spell checking action <!-- Other than the issue solved, is this relevant to any other issues/existing PRs? --> ## References https://github.com/microsoft/terminal/pull/9004#issuecomment-771825083 <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist * [ ] Closes #xxx * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [x] Tests added/passed * [ ] Documentation updated. If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: #xxx * [ ] Schema updated. * [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx <!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here --> ## Detailed Description of the Pull Request / Additional comments ### Plurals and paste tenses In the past, plurals `foo`+`s` and past tenses `foo`+`ed` were automatically tolerated. This turned out to be a bad design choice on my part. The basic example is that `potatos` would sometimes be treated as a mistake and sometimes not (depending on the presence of `potato`). You can see in this PR, that this logic resulted in `Applys` being accepted as a word along with `AppContainered` -- there's nothing intrinsically wrong w/ the latter, but unfortunately in order to screen out the former, my shortcut just couldn't stick around. This means that the `dictionary`/`expect` files will grow perhaps by a tiny bit, but as you can see, not really by much. This is also why `thereses` (a user) was accepted as a word in the past ([therese](https://en.wikipedia.org/wiki/Th%C3%A9r%C3%A8se_of_Lisieux) is in the base dictionary, so `therese` + `s` was acceptable). ### Pull requests When GitHub initially introduced GitHub Actions, the event for `pull_request` was created without enough permission for a tool like this to work properly. I worked around that by using the `schedule` event. In 2020, they introduced a replacement event `pull_request_target` which has enough permission. This means that I can stop relying on the `schedule` event. ### Miscellaneous * I've folded together some `expect/` files since now is as good a time as any. * I've included a hint about `excludes.txt` (I added a similar one for our primary repo recently, and it came up this week in `microsoft/terminal` -- @zadjii-msft) * I've standardized on a default of `.github/actions/spelling` to make the out of the box experience easier for new adopters, so I'm applying that change here -- if you're attached to the old directory name, specifying it is still supported. -- note the directory rename may cause a merge conflict for people with open PRs and changes to the contents, this shouldn't be a big problem. <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed I've created a temporary repo which is using this as its default branch. There's a sample PR here: https://github.com/check-spelling/terminal/pull/1 If people want, they're welcome to create PRs into that repo to test (you can also test in your own forks -- just be sure that you enable or re-enable the workflow -- GitHub has disabled workflows with `schedule` in inactive repositories to save CPU cycles). --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-31 09:21:40 +00:00
Sign in to join this conversation.
No Label pull-request
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#27385