ci/spelling: Add spelling PR check - #1853
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
marcleblanc2
marked this pull request as draft
September 9, 2026 00:24
marcleblanc2
force-pushed
the
add-cspell-pr-check
branch
from
September 9, 2026 02:05
ad282ab to
bad0fac
Compare
marcleblanc2
changed the title
marcleblanc2
added a commit
that referenced
this pull request
Sep 9, 2026
Moved from #1853 so that PR stays scoped to the CSpell check.
marcleblanc2
added a commit
that referenced
this pull request
Sep 9, 2026
Fake commit hash, tmp filename, pod name, TLS cert blobs, ARN, and base64 IDs in examples, replaced with placeholders that look realistic and pass the spell check. Moved from #1853.
marcleblanc2
marked this pull request as ready for review
September 9, 2026 10:33
pjlast
approved these changes
Sep 11, 2026
marcleblanc2
enabled auto-merge (squash)
September 11, 2026 01:46
Co-authored-by: Amp <amp@ampcode.com> Amp-Thread-ID: https://ampcode.com/threads/T-01a06e27-8097-7461-8d90-eef25db09feb
Amp-Thread-ID: https://ampcode.com/threads/T-01a06e27-8097-7461-8d90-eef25db09feb Co-authored-by: Amp <amp@ampcode.com>
Remove the 126 misspelled words from cspell-project-words.txt: the 112 words already listed in flagWords, plus 14 more found while reviewing the dictionary (addresseses, Changs, certains, condeintel, ERRROS, gorelaser, lobal, Redict, settingscasacde, sguqery, Sourcegraphs, Stablechore, theyre, Wofli). The words that still appear in non-generated docs are fixed in #1855 and #1873; the rest only occur in generated files that cspell.json already ignores. Keep eror, functio, and stabili in the dictionary and stop flagging them: eror is Sourcegraph's log level token (lvl=eror), and functio and stabili are truncation artifacts in verbatim command output, not misspellings. Co-authored-by: Amp <amp@ampcode.com> Amp-Thread-ID: https://ampcode.com/threads/T-01a07e67-73b3-779f-8880-7ba770fe7ade
check-spelling.mjs gains --format json (with cspell suggestions) and loses the markdown formatter. post-spelling-review.mjs owns all GitHub posting: the existing summary comment, plus one COMMENT review per run with an inline comment on each newly flagged line. Comments for findings that are still present are kept; stale ones are deleted. Capped at 25 inline per run. Amp-Thread-ID: https://ampcode.com/threads/T-01a0837b-04dc-7559-831d-ba3b35c75489 Co-authored-by: Amp <amp@ampcode.com>
check-spelling.mjs emits the full source line. Each inline comment carries a suggestion block per cspell candidate (up to 3), with candidates matching the flagged word's initial capitalization listed first. Amp-Thread-ID: https://ampcode.com/threads/T-01a0837b-04dc-7559-831d-ba3b35c75489 Co-authored-by: Amp <amp@ampcode.com>
Keep this PR to the CSpell check and dictionary. The LINTER_ERRROS, gorelaserConfig, sguqery, lobal, and imedout fixes now live in #1873.
Amp-Thread-ID: https://ampcode.com/threads/T-01a085a6-bee2-73a7-a3d4-49683789fc84 Co-authored-by: Amp <amp@ampcode.com>
…elog TODO The docs/ example placeholder swaps now live in #1873 so this PR is only the CSpell check and dictionary. cspell.json gains a TODO to drop the technical-changelog ignore once PR 1888 merges.
Amp-Thread-ID: https://ampcode.com/threads/T-01a085a6-bee2-73a7-a3d4-49683789fc84 Co-authored-by: Amp <amp@ampcode.com>
Co-authored-by: Amp <amp@ampcode.com> Amp-Thread-ID: https://ampcode.com/threads/T-01a06e27-8097-7461-8d90-eef25db09feb
Amp-Thread-ID: https://ampcode.com/threads/T-01a06e27-8097-7461-8d90-eef25db09feb Co-authored-by: Amp <amp@ampcode.com>
marcleblanc2
force-pushed
the
add-cspell-pr-check
branch
from
September 11, 2026 01:51
57f1ce3 to
e66cf0e
Compare
marcleblanc2
added a commit
that referenced
this pull request
Sep 11, 2026
Moved from #1853 so that PR stays scoped to the CSpell check.
marcleblanc2
added a commit
that referenced
this pull request
Sep 11, 2026
Fake commit hash, tmp filename, pod name, TLS cert blobs, ARN, and base64 IDs in examples, replaced with placeholders that look realistic and pass the spell check. Moved from #1853.
marcleblanc2
added a commit
that referenced
this pull request
Sep 11, 2026
#1873) Linear [FE-499: Fix doc site issues](https://linear.app/sourcegraph/issue/FE-499/fix-doc-site-issues) ## Summary Follow-up to #1855. While reviewing the ~1100-word dictionary in #1853 for misspellings, these five were the only ones still present in non-generated docs: - `$LINTER_ERRROS` → `$LINTER_ERRORS` in the batch spec templating example (the step's `env` defines `LINTER_ERRORS`, so the example was referencing an unset variable) - `gorelaserConfig` → `goreleaserConfig` - ````sguqery` → ````sgquery` code fence language (2 occurrences) - `lobal` → `Global` in an image alt text - `imedout` → `timedout` in the `src search -get-curl` GraphQL example (moved here from #1853) All other misspellings in the dictionary were either already fixed by #1855 or appear only in generated files that CSpell ignores (`docs/technical-changelog.mdx`, observability alerts/dashboards). Also moved from #1853: seven example placeholders that CSpell flagged as gibberish (a fake commit hash, tmp filename, pod name, TLS cert blobs, an ARN, and base64 IDs), replaced with realistic-looking placeholders that pass the check. #1853 will drop these words from `cspell-allow-list.txt`. ## Verification - `git diff --check` - `rg` for each fixed word returns no hits outside generated files ## Amp threads - [Clean cspell dictionary](https://ampcode.com/threads/T-01a07e67-73b3-779f-8880-7ba770fe7ade) --------- Co-authored-by: Amp <amp@ampcode.com>
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
2 participants
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.
Linear FE-499: Fix doc site issues
Summary
npx cspell@10 --no-progress --dot '**/*'runs the full-repository check locallycspell-allow-list.txton the PR branch, to allowlist false positivesVerification
runblock passedbash -nnode --check dev/check-spelling.mjsgit diff --checkExclusions
.gitignore, so dependency, cache, and build output remain excludedpnpm-lock.yamldocs/technical-changelog.mdx, generated observability alert/dashboard references, and the generated AWS icon module)Screenshots
From demo PRs #1892 and #1893:
Summary comment
Inline review comment
Amp threads