Skip to content

demo: CSpell PR check comments (do not merge) - #1892

Closed
marcleblanc2 wants to merge 1 commit into
add-cspell-pr-checkfrom
cspell-check-demo
Closed

demo: CSpell PR check comments (do not merge)#1892
marcleblanc2 wants to merge 1 commit into
add-cspell-pr-checkfrom
cspell-check-demo

Conversation

@marcleblanc2

Copy link
Copy Markdown
Contributor

Temporary PR to capture screenshots of the CSpell review comments for #1853. Will be closed without merging.

@vercel

vercel Bot commented Sep 9, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sourcegraph-docs Ready Ready Preview Sep 9, 2026 10:19am UTC

Request Review

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

⚠️ CSpell found 2 spelling error(s) in this PR

Only findings on lines added by this PR are shown.

docs/batch-changes/index.mdx

  • line 15, column 47: chagnesBatch Changes helps you ship large-scale code chagnes across many repositries and code hosts. You can create pull requests on all affected repositories, and it
  • line 15, column 67: repositriesBatch Changes helps you ship large-scale code chagnes across many repositries and code hosts. You can create pull requests on all affected repositories, and it

Please correct the spelling, or add words which are correct to cspell-allow-list.txt.

Run npx cspell@10 --no-progress --dot '**/*' locally to check the full repository.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CSpell found 2 spelling error(s) on lines added by this PR. Please correct them, or add them to cspell-allow-list.txt if they are correct.

</p>

Batch Changes helps you ship large-scale code changes across many repositories and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.
Batch Changes helps you ship large-scale code chagnes across many repositries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

chagnes is not in the dictionary. Did you mean:

changes:

Suggested change
Batch Changes helps you ship large-scale code chagnes across many repositries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.
Batch Changes helps you ship large-scale code changes across many repositries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.

chagres:

Suggested change
Batch Changes helps you ship large-scale code chagnes across many repositries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.
Batch Changes helps you ship large-scale code chagres across many repositries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.

chaines:

Suggested change
Batch Changes helps you ship large-scale code chagnes across many repositries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.
Batch Changes helps you ship large-scale code chaines across many repositries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.

Please correct the spelling, or add the word to cspell-allow-list.txt if it is correct.

</p>

Batch Changes helps you ship large-scale code changes across many repositories and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.
Batch Changes helps you ship large-scale code chagnes across many repositries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

repositries is not in the dictionary. Did you mean:

repositories:

Suggested change
Batch Changes helps you ship large-scale code chagnes across many repositries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.
Batch Changes helps you ship large-scale code chagnes across many repositories and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.

registries:

Suggested change
Batch Changes helps you ship large-scale code chagnes across many repositries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.
Batch Changes helps you ship large-scale code chagnes across many registries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.

reposition:

Suggested change
Batch Changes helps you ship large-scale code chagnes across many repositries and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.
Batch Changes helps you ship large-scale code chagnes across many reposition and code hosts. You can create pull requests on all affected repositories, and it tracks their progress until they're all merged. You can also preview the changes and update them at any time.

Please correct the spelling, or add the word to cspell-allow-list.txt if it is correct.

@marcleblanc2

Copy link
Copy Markdown
Contributor Author

Screenshots captured and added to #1853; closing.

@marcleblanc2
marcleblanc2 deleted the cspell-check-demo branch September 9, 2026 10:20
marcleblanc2 added a commit that referenced this pull request Sep 11, 2026
Linear [FE-499: Fix doc site
issues](https://linear.app/sourcegraph/issue/FE-499/fix-doc-site-issues)

## Summary

- Install CSpell 10 in CI only (not a project dependency); `npx
cspell@10 --no-progress --dot '**/*'` runs the full-repository check
locally
- Add a custom dictionary file to allowlist needed words
- On pull requests, report only spelling errors on lines added by the
PR, so existing repository findings are ignored
- Create / update one PR summary comment containing grouped file, line,
column, word, and context details, plus an inline review comment per
flagged line with a one-click GitHub suggestion for the best candidate
- Every comment links to `cspell-allow-list.txt` on the PR branch, to
allowlist false positives
- Resolve the comment after fixes
- Initially roll out the PR check as non-blocking, while preserving the
local command's failing exit code

## Verification

- Simulated an added typo: the diff checker exited 1 and reported
exactly that word, line, column, and context
- Reverted the typo: the diff checker exited 0 despite pre-existing
repository findings
- Prettier checks passed for the script, package/config, and workflow
- Workflow YAML parsed successfully and every shell `run` block passed
`bash -n`
- `node --check dev/check-spelling.mjs`
- `git diff --check`

## Exclusions

- CSpell honors `.gitignore`, so dependency, cache, and build output
remain excluded
- The full local check additionally skips:
  - Binary image/font formats
  - `pnpm-lock.yaml`
  - CSpell's own config/dictionary
- Checked-in generated outputs (`docs/technical-changelog.mdx`,
generated observability alert/dashboard references, and the generated
AWS icon module)

## Screenshots

From demo PRs #1892 and #1893:

Summary comment

![CSpell summary
comment](https://ampcode.com/user-content/artifacts/7a53381b97a7dd82302e234b173ad5334d249915f967eeb86f35f3cfc9beaf89-file.png)

Inline review comment

![CSpell inline review
comment](https://ampcode.com/user-content/artifacts/18e0509bc77a41a96ca4d91b3ce3a0df1da598576708214fabd1664964c757cd-file.png)

## Amp threads

- [Spelling PR
check](https://ampcode.com/threads/T-01a06e27-8097-7461-8d90-eef25db09feb)
- [CSpell PR
check](https://ampcode.com/threads/T-01a06e21-70c8-77bb-aa01-9a6fa75488bd)
- [Inline spelling
comments](https://ampcode.com/threads/T-01a0837b-04dc-7559-831d-ba3b35c75489)
- [Clean cspell
dictionary](https://ampcode.com/threads/T-01a07e67-73b3-779f-8880-7ba770fe7ade)
- [Cspell word list
review](https://ampcode.com/threads/T-01a082f4-e864-769b-8269-46847abcd228)
- [Link to allow list in
comments](https://ampcode.com/threads/T-01a085a6-bee2-73a7-a3d4-49683789fc84)

---------

Co-authored-by: Amp <amp@ampcode.com>
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.

1 participant