Skip to content

chore: add a CI check for typos - #33377

Merged
zeke merged 1 commit into
productionfrom
ci/typos-check
Sep 10, 2026
Merged

zeke merged 1 commit into
productionfrom
ci/typos-check

Conversation

@zeke

@zeke zeke commented Sep 10, 2026

Copy link
Copy Markdown
Member

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.

  • Curated dictionary. It checks "is this string a known misspelling" (tehthe, recievereceive) rather than "is this a real English word." It doesn't need a huge custom dictionary of product names and jargon to be useable.
  • Identifier-aware. It splits camelCase, snake_case, and kebab-case into sub-words before checking, so code identifiers like getAttr don't get flagged as a whole.
  • Fast. Runs in about 2 seconds on my machine, so it won't add meaningful time to CI.
  • Actively maintained. Hecka GitHub stars, regular releases, and it's used across a lot of big repos.

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.toml excludes 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.

@github-actions

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/.github/ @ahaywood, @colbywhite, @MohamedH1998, @mvvmm, @cloudflare/content-engineering
* @cloudflare/product-owners

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 10, 2026

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://ci-typos-check.previews.developers.cloudflare.com (commit 987e1e1)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://0aedef5c.previews.developers.cloudflare.com 987e1e1 2026-09-10T21:56:24.776Z Visit the dashboard ↗
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://6534b16b.previews.developers.cloudflare.com 3826234 2026-09-10T17:20:05.453Z Visit the dashboard ↗

@zeke zeke changed the title chore: add typos CI check chore: add a CI check for typos Sep 10, 2026
@github-actions

github-actions Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

@mvvmm

mvvmm commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

sweet

@zeke

zeke commented Sep 10, 2026

Copy link
Copy Markdown
Member Author

#33375 just landed, so the production branch should now be typo-free.

Rebasing this. Let's see if it turns green. 🤞🏼

@zeke
zeke marked this pull request as ready for review September 10, 2026 22:04
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Review

✅ No issues found in commit 987e1e1.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

No code review issues found.

Conventions

No convention issues found.

Style Guide Review

No style-guide issues found.

Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.
/rebase Rebases the PR branch against production. On conflict, attempts to resolve automatically using AI. Stops with an explanation if confidence is not high enough.

@zeke
zeke merged commit 98beec4 into production Sep 10, 2026
16 checks passed
@zeke
zeke deleted the ci/typos-check branch September 10, 2026 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants