chore: add a CI check for typos - #33377
Merged
Merged
Conversation
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
🚀 Deploying Preview to Cloudflare 🚀Preview URL: https://ci-typos-check.previews.developers.cloudflare.com (commit 987e1e1)This URL reflects your latest Preview deploymentPreview Deployments by commit
|
Contributor
|
Preview URL: https://987e1e1b.preview.developers.cloudflare.com |
mvvmm
approved these changes
Sep 10, 2026
Collaborator
|
sweet |
zeke
force-pushed
the
ci/typos-check
branch
from
September 10, 2026 21:38
3826234 to
987e1e1
Compare
Member
Author
|
#33375 just landed, so the production branch should now be typo-free. Rebasing this. Let's see if it turns green. 🤞🏼 |
zeke
marked this pull request as ready for review
September 10, 2026 22:04
zeke
requested review from
a team,
MohamedH1998,
ahaywood and
colbywhite
as code owners
September 10, 2026 22:04
Contributor
Review✅ No issues found in commit Code ReviewThis code review is in beta and may not always be helpful — use your judgment. No code review issues found. ConventionsNo convention issues found. Style Guide ReviewNo style-guide issues found. CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a new job to CI to check for typos.
Tooling
https://github.com/crate-ci/typos is a Rust CLI built for source trees that mix prose and code.
teh→the,recieve→receive) rather than "is this a real English word." It doesn't need a huge custom dictionary of product names and jargon to be useable.camelCase,snake_case, andkebab-caseinto sub-words before checking, so code identifiers likegetAttrdon't get flagged as a whole.Configuration
I ran this locally against the whole content tree first: 505 raw hits. Most were noise — 43% came from one directory of third-party OSS license text alone (
legal/3rdparty.*), plus base64/JWT example tokens, hex hashes, foreign-language UI string examples, and real acronyms (HELO,EDE,HPE)._typos.tomlexcludes the license directory, ignores long base64/hex runs by regex, and allowlists about 45 specific words/identifiers I confirmed by hand aren't typos. After that tuning, it's now down to zero findings on the production branch.Here's a companion PR with the actual typos it found: #33375 -- once that's merged, this PR should turn green. 🍏
✋🏼 This PR conforms to the contribution guidelines.