Skip to content

Resolve all cspell lints#210

Merged
rhennigan merged 5 commits into
mainfrom
chore/resolve-all-cspell-lints
Jul 6, 2026
Merged

Resolve all cspell lints#210
rhennigan merged 5 commits into
mainfrom
chore/resolve-all-cspell-lints

Conversation

@rhennigan

Copy link
Copy Markdown
Member

Summary

Resolves all outstanding cspell spell-check lints across the repository. Fixes are applied via the least-intrusive mechanism per case:

  • Dictionary + ignore patterns — added project-specific terms (e.g. AgentTools, Chatbook, paclet, wolframscript, Sourcegraph) to the .cspell.json word list, and broadened the unicode-escape ignore regexes to cover uppercase hex and \uXXXX forms.
  • Inline cspell directives — added cspell: disable/ignore comments to files containing intentional non-dictionary terms that don't belong in the global dictionary (docs, specs, notes, all client-research/*.md, a FrontEnd string asset, SubmitPaclet.wl, and two test files).
  • Identifier renames — where a rename read better than a dictionary entry, renamed flagged abbreviations to full words: assocsassociations in PreferencesContent.wl, and sdirsDir, tooloptstoolOpts, SessSession, rootmarkerRootMarker in the test suite. These are functionally equivalent (session IDs and temp file/dir names are arbitrary).
  • Truncated word fix — restored the elided Parameters key in a sample output in Notes/generating-scripts-from-tools.md so cspell no longer flags Paramet.

Also adds ignore/ to .gitignore (private scratch dir) as unrelated housekeeping.

Notes

  • The identifier renames that shifted line numbers caused the repo's pre-commit hook to re-sync the line-number references embedded in TestID strings; that accounts for the larger-than-expected line counts in the test files.
  • No runtime/logic changes to product source — PreferencesContent.wl is a pure variable rename plus trailing-whitespace cleanup.

Commits

  1. Ignore private scratch directory in git
  2. Resolve cspell lints via dictionary words and inline ignores
  3. Rename abbreviated identifiers to satisfy spell-check
  4. Fix truncated word in generating-scripts-from-tools note

Test plan

  • cspell reports no lints across the repo
  • Wolfram Language test suite passes (renames are functionally equivalent; TestIDs auto-synced by the pre-commit hook)

🤖 Generated with Claude Code

rhennigan and others added 4 commits July 6, 2026 09:43
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add project-specific terms to the .cspell.json dictionary, extend the
unicode escape ignore patterns, and add inline cspell disable/ignore
directives to files containing intentional non-dictionary terms.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Rename flagged abbreviations to full words so cspell passes without new
dictionary entries: assocs->associations in PreferencesContent, and the
sdir/toolopts/Sess/rootmarker abbreviations in the test suite. Also trims
trailing whitespace in PreferencesContent.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Restore the elided "Parameters" key in the sample output so cspell does
not flag the truncated "Paramet".

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 6, 2026 13:58

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR aims to eliminate repository-wide cspell spell-check lints by updating the cspell configuration, adding targeted inline ignore/disable directives in content-heavy files, and renaming a few abbreviated identifiers (mostly in tests) to more dictionary-friendly forms.

Changes:

  • Expanded .cspell.json with additional project-specific dictionary words and broadened ignore regexes for escape sequences.
  • Added inline cspell directives to docs/specs/notes and a few Wolfram Language/test files to suppress intentional non-dictionary tokens.
  • Renamed a handful of abbreviated identifiers and test temp-file/session naming strings to avoid spell-check flags, plus minor whitespace/comment formatting tweaks.

Reviewed changes

Copilot reviewed 21 out of 22 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
TODO/more-mcp-clients.md Adds inline cspell ignore directive for client names/terms.
Tests/Tools.wlt Adds cspell ignore for a token and re-syncs TestID line references.
Tests/ToolOptions.wlt Renames temp config filename fragments (tooloptstoolOpts).
Tests/StartMCPServer.wlt Renames root marker filenames and updates related checks and TestIDs.
Tests/EvaluatorSessions.wlt Renames temp dir/session IDs and a local var (sdirsDir) for readability/spell-check.
Tests/CreateMCPServer.wlt Adds cspell ignore for a tool name and re-syncs TestID line references.
Specs/MCPApps.md Adds inline cspell ignore directive for embedded/base64-related token.
Notes/generating-scripts-from-tools.md Fixes a truncated sample-output token (ParametParameters).
Kernel/Tools/PacletTools/SubmitPaclet.wl Adds cspell ignore for an intentional auth keyword prefix token.
Kernel/PreferencesContent.wl Renames assocsassociations and performs whitespace/comment formatting cleanup.
FrontEnd/Assets/AgentTools.wl Disables cspell for a FrontEnd string asset file.
docs/mcp-clients.md Adds inline cspell ignore directive for client/tooling terms.
client-research/windsurf.md Adds inline cspell ignore directive for a proper noun.
client-research/pi.md Adds inline cspell ignore directive for names/handles/terms.
client-research/msty.md Adds inline cspell ignore directive for a client name.
client-research/junie.md Adds inline cspell ignore directive for names/terms.
client-research/goose.md Adds inline cspell ignore directive for org/tooling terms.
client-research/continue.md Adds inline cspell ignore directive for a client identifier.
client-research/cherry-studio.md Adds inline cspell ignore directive for a storage engine term.
client-research/5ire.md Adds inline cspell ignore directive for handle/term.
.gitignore Ignores a private scratch directory (ignore/).
.cspell.json Adds dictionary words, notebook ignore paths, and broader escape-sequence ignore regexes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .cspell.json
Comment thread TODO/more-mcp-clients.md
Comment thread docs/mcp-clients.md
Comment thread client-research/5ire.md
Comment thread client-research/pi.md
Comment thread client-research/junie.md
Comment thread client-research/goose.md
@rhennigan rhennigan merged commit 210af03 into main Jul 6, 2026
1 check failed
@rhennigan rhennigan deleted the chore/resolve-all-cspell-lints branch July 6, 2026 14:08
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