starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

[PR #4799] [MERGED] ci: run spell check in CI, fix remaining issues #25957

New Issue
Open
opened 2026-01-31 09:12:54 +00:00 by claunia · 0 comments
claunia commented 2026-01-31 09:12:54 +00:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/microsoft/terminal/pull/4799
Author: @jsoref
Created: 3/4/2020
Status: ✅ Merged
Merged: 3/25/2020
Merged by: @DHowett-MSFT

Base: master ← Head: spell-check

📝 Commits (10+)

📊 Changes

67 files changed (+483055 additions, -77 deletions)

View changed files

➕ .github/actions/spell-check/dictionary/README.md (+20 -0)
➕ .github/actions/spell-check/dictionary/chinese.txt (+5 -0)
➕ .github/actions/spell-check/dictionary/dictionary.txt (+479826 -0)
➕ .github/actions/spell-check/dictionary/fonts.txt (+8 -0)
➕ .github/actions/spell-check/dictionary/japanese.txt (+4 -0)
➕ .github/actions/spell-check/dictionary/microsoft.txt (+6 -0)
➕ .github/actions/spell-check/dictionary/names.txt (+52 -0)
➕ .github/actions/spell-check/excludes.txt (+61 -0)
➕ .github/actions/spell-check/patterns/0_n.txt (+2 -0)
➕ .github/actions/spell-check/patterns/0_r.txt (+8 -0)
➕ .github/actions/spell-check/patterns/0_t.txt (+13 -0)
➕ .github/actions/spell-check/patterns/README.md (+16 -0)
➕ .github/actions/spell-check/patterns/patterns.txt (+7 -0)
➕ .github/actions/spell-check/whitelist/README.md (+7 -0)
➕ .github/actions/spell-check/whitelist/alphabet.txt (+34 -0)
➕ .github/actions/spell-check/whitelist/web.txt (+3 -0)
➕ .github/actions/spell-check/whitelist/whitelist.txt (+2882 -0)
➕ .github/workflows/spelling.yml (+24 -0)
📝 .gitignore (+2 -2)
📝 doc/specs/#605 - Search/spec.md (+1 -1)

...and 47 more files

📄 Description

Summary of the Pull Request

This adds an action (currently pinned to my latest release 0.0.10-alpha) which performs spell checking.

Spell checking can occur:

  • on commits (pushing to a branch)
  • on PRs (creating a pull request)
  • on commits in repository forks if the forked repository enables Actions (this does not happen by default)
  • asynchronously for PRs created from foreign repositories (this addresses the former)

References

PR Checklist

Detailed Description of the Pull Request / Additional comments

Comments are added to commits/pull requests

such as:
31d73b06ad (commitcomment-37624165)

Unrecognized words will be annotated

When a new commit is added while the action is active, as in:
54bcdf07ae

Whitelisting words

The details in the comment provide commands one can run to update the whitelist for the cases where a word should be accepted.

Excluding files

The excludes.txt file allows one to exclude files by directory, extension, or other patterns -- each line in the file is a perl regular expression.

Scheduled runs

Due to GitHub constraints, PRs from forks don't have permission to comment/annotate, so instead, I'm trying using a schedule to check pull requests. -- Currently configured to look for PRs that have changed in the last hour (running hourly).

Quirks

Roughly doubled action runs

The use of both push and pull_request generally means that for commits w/in a repository, one will get at least duplicate annotations. The comments should appear in two different places (one should end up on the PR and the other should end up on the commit).

I haven't figured out the best way to address this, as while one is working on a branch, immediate feedback is best. -- But if one has a PR, I think it's best to be able to see the output in the PR...

Miscellaneous

I've included a couple of additional spelling commits. If the changes are wrong, we can either whitelist the words or add the files to excludes.

Adjustment

I'm happy to take feedback and make adjustments :-)

Validation Steps Performed

This is an alpha release, and this repository would be an early adopter.
We're using a version of this and I'm slowly seeding it to projects.

You can test this code by applying it to your own fork in GitHub and then adding a new commit with a word that isn't in the dictionary ...

cc: @miniksa, @DHowett-MSFT

🔄 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/4799 **Author:** [@jsoref](https://github.com/jsoref) **Created:** 3/4/2020 **Status:** ✅ Merged **Merged:** 3/25/2020 **Merged by:** [@DHowett-MSFT](https://github.com/DHowett-MSFT) **Base:** `master` ← **Head:** `spell-check` --- ### 📝 Commits (10+) - [`321d00b`](https://github.com/microsoft/terminal/commit/321d00bab5fa58da91c038a0b6d5a8132d986e33) spelling: excerpt - [`34dc0d6`](https://github.com/microsoft/terminal/commit/34dc0d6ea65a244e2fbe1edb04705aa8c875c1ea) spelling: fallthrough - [`b03cf9f`](https://github.com/microsoft/terminal/commit/b03cf9fd3b85c474255b46afda184ad5dd6369bc) spelling: provided - [`92560bd`](https://github.com/microsoft/terminal/commit/92560bda8e07e0a8dea6bf8e4c38e39531324f0f) spelling: rendered - [`908435e`](https://github.com/microsoft/terminal/commit/908435e2e140ad9eb3dda850bc06163e9a20cf68) spelling: resetting - [`c79dc59`](https://github.com/microsoft/terminal/commit/c79dc5933513ffa0f47ad7b68ed2412638d83cf4) spelling: successfully - [`b747a11`](https://github.com/microsoft/terminal/commit/b747a116798e0308b12ea22add24b16cb81734a5) spelling: transferred - [`db51e6f`](https://github.com/microsoft/terminal/commit/db51e6fc56564127a4c89c2e2f24cc4710da7583) spelling: adheres - [`f2df622`](https://github.com/microsoft/terminal/commit/f2df62268e567e72350c50e545bee3344a6fbd6b) spelling: breaks - [`d8cbd29`](https://github.com/microsoft/terminal/commit/d8cbd2916683ae60b709b8ed9dde0eaed6e6d31d) spelling: previous ### 📊 Changes **67 files changed** (+483055 additions, -77 deletions) <details> <summary>View changed files</summary> ➕ `.github/actions/spell-check/dictionary/README.md` (+20 -0) ➕ `.github/actions/spell-check/dictionary/chinese.txt` (+5 -0) ➕ `.github/actions/spell-check/dictionary/dictionary.txt` (+479826 -0) ➕ `.github/actions/spell-check/dictionary/fonts.txt` (+8 -0) ➕ `.github/actions/spell-check/dictionary/japanese.txt` (+4 -0) ➕ `.github/actions/spell-check/dictionary/microsoft.txt` (+6 -0) ➕ `.github/actions/spell-check/dictionary/names.txt` (+52 -0) ➕ `.github/actions/spell-check/excludes.txt` (+61 -0) ➕ `.github/actions/spell-check/patterns/0_n.txt` (+2 -0) ➕ `.github/actions/spell-check/patterns/0_r.txt` (+8 -0) ➕ `.github/actions/spell-check/patterns/0_t.txt` (+13 -0) ➕ `.github/actions/spell-check/patterns/README.md` (+16 -0) ➕ `.github/actions/spell-check/patterns/patterns.txt` (+7 -0) ➕ `.github/actions/spell-check/whitelist/README.md` (+7 -0) ➕ `.github/actions/spell-check/whitelist/alphabet.txt` (+34 -0) ➕ `.github/actions/spell-check/whitelist/web.txt` (+3 -0) ➕ `.github/actions/spell-check/whitelist/whitelist.txt` (+2882 -0) ➕ `.github/workflows/spelling.yml` (+24 -0) 📝 `.gitignore` (+2 -2) 📝 `doc/specs/#605 - Search/spec.md` (+1 -1) _...and 47 more files_ </details> ### 📄 Description ## Summary of the Pull Request This adds an action (currently pinned to my latest release 0.0.10-alpha) which performs spell checking. Spell checking can occur: * on commits (pushing to a branch) * on PRs (creating a pull request) * on commits in repository forks _if_ the forked repository enables Actions (this does not happen by default) * asynchronously for PRs created from foreign repositories (this addresses the former) ## References ## PR Checklist * [x] Closes #4473 * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [ ] Tests added/passed * [ ] Requires documentation to be updated * [x] 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: #4473 ## Detailed Description of the Pull Request / Additional comments ### Comments are added to commits/pull requests such as: https://github.com/jsoref/terminal/commit/31d73b06adbfd322919d7ea19a6a0f71ddb891d3#commitcomment-37624165 ### Unrecognized words will be annotated When a new commit is added while the action is active, as in: https://github.com/check-spelling/examples-testing/commit/54bcdf07ae7bf3ebec093659db53ae4b31805576 ### Whitelisting words The details in the comment provide commands one can run to update the whitelist for the cases where a word should be accepted. ### Excluding files The `excludes.txt` file allows one to exclude files by directory, extension, or other patterns -- each line in the file is a perl regular expression. ### Scheduled runs Due to GitHub constraints, PRs from forks don't have permission to comment/annotate, so instead, I'm trying using a schedule to check pull requests. -- Currently configured to look for PRs that have changed in the last hour (running hourly). ### Quirks #### Roughly doubled action runs The use of both `push` and `pull_request` generally means that for commits w/in a repository, one will get at least duplicate annotations. The comments should appear in two different places (one should end up on the PR and the other should end up on the commit). I haven't figured out the best way to address this, as while one is working on a branch, immediate feedback is best. -- But if one has a PR, I think it's best to be able to see the output in the PR... ### Miscellaneous I've included a couple of additional spelling commits. If the changes are wrong, we can either whitelist the words or add the files to excludes. ### Adjustment I'm happy to take feedback and make adjustments :-) ## Validation Steps Performed This is an alpha release, and this repository would be an early adopter. We're using a version of this and I'm slowly seeding it to projects. You can test this code by applying it to your own fork in GitHub and then adding a new commit with a word that isn't in the dictionary ... --- cc: @miniksa, @DHowett-MSFT --- <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:12:54 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#25957
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?