Skip to content

Tidy cspell issues and add cspell to pre-commit hook#1828

Merged
pmckinney-codat merged 2 commits intomainfrom
cspell-tidy
May 7, 2026
Merged

Tidy cspell issues and add cspell to pre-commit hook#1828
pmckinney-codat merged 2 commits intomainfrom
cspell-tidy

Conversation

@pmckinney-codat
Copy link
Copy Markdown
Collaborator

Summary

  • Set the cspell locale to en,en-GB so British spellings (e.g. synchronisation, maximise, authorise) stop being flagged. The dictionary already had Organisation so this just makes it consistent.
  • Fixed 8 real typos in docs: CodatsCodat's, hetherwhether, questionnnairequestionnaire, proividesprovides, averaeaverage, oustandingoutstanding, opportunititesopportunities, plus 2 prose usecaseuse case.
  • Added domain terms, JSX prop names, sample-data names, and identifiers to cspell.json: Abra/Kedabra, Berge/Yundt, Cardable/cardable, createendpoint/downloadendpoint/endpointlink/listendpoint, datamodel/datatypes, deauthorizing, Freetext, grat (TabItem value in uw-decision.md), quickbooksonline, reengagement, Usecases/usecase/usecases.
  • Added cspell to the lint-staged pre-commit hook so any new unknown word in a staged .md/.mdx file blocks the commit.

After these changes: cspell **/*.md **/*.mdx --config cspell.json reports 0 issues across 559 files.

Targeted at add-prettier-precommit-hook so the diff is focused. Once that PR merges I'll re-base this onto main.

Test plan

  • npx cspell "**/*.md" "**/*.mdx" --config cspell.json returns 0 issues
  • Smoke-tested the hook: staged a markdown file containing defenitely and woord, ran npx lint-staged — cspell flagged both and lint-staged reverted the staged state (commit would have been blocked)
  • Hook fired automatically when creating this branch's commit
  • Reviewer: skim the dictionary additions and flag any that should instead be edited as text (e.g. if cardable should be re-worded)

🤖 Generated with Claude Code

Fix 8 typos in docs, accept en-GB spellings, and add legitimate
domain terms / sample-data names to the cspell dictionary so
cspell runs clean across all .md/.mdx files. Add cspell to the
lint-staged pre-commit hook so future typos block the commit.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 7, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
codat-docs Ready Ready Preview, Comment May 7, 2026 3:40pm

Request Review

Comment thread docs/auth-flow/optimize/maximize-links.md
Comment thread docs/configure/portal/dashboard.mdx
Comment thread docs/spend-insights/reports/spend-analysis.md
Comment thread docs/spend-insights/reports/spend-analysis.md
Comment thread docs/spend-insights/reports/spend-analysis.md
Comment thread docs/spend-insights/reports/spend-analysis.md
Comment thread docs/spend-insights/reports/spend-analysis.md
Comment thread docs/spend-insights/reports/spend-analysis.md
Comment thread docs/spend-insights/reports/spend-analysis.md
Comment thread docs/spend-insights/reports/spend-analysis.md
Base automatically changed from add-prettier-precommit-hook to main May 7, 2026 15:36
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

Link check results for preview deployment (https://codat-docs-git-cspell-tidy-codat.vercel.app):

[
  "[404] https://codat-docs-git-cspell-tidy-codat.vercel.app/blog/multi-entity-portal-update",
  "[404] https://codat-docs-git-cspell-tidy-codat.vercel.app/blog/multi-entity-portal-update/",
  "[404] https://codat-docs-git-cspell-tidy-codat.vercel.app/blog/multi-entity-portal-update/",
  "[404] https://codat-docs-git-cspell-tidy-codat.vercel.app/blog/multi-entity-portal-update",
  "[503] https://sandbox.dev.clover.com/developer-home/create-account",
  "[503] https://sandbox.dev.clover.com/developer-home/create-account"
]

@pmckinney-codat pmckinney-codat enabled auto-merge May 7, 2026 15:38
@pmckinney-codat pmckinney-codat merged commit 1173660 into main May 7, 2026
8 of 9 checks passed
@pmckinney-codat pmckinney-codat deleted the cspell-tidy branch May 7, 2026 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants