Skip to content

Add codespell support with configuration and fixes#103

Merged
mihaic merged 6 commits intobrainiak:masterfrom
yarikoptic:enh-codespell
Apr 16, 2026
Merged

Add codespell support with configuration and fixes#103
mihaic merged 6 commits intobrainiak:masterfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Copy Markdown
Contributor

Add codespell configuration and fix existing typos.

More about codespell: https://github.com/codespell-project/codespell

I personally introduced it to over a hundred of projects already mostly with a positive feedback
(see the "improveit-dashboard").

CI workflow has 'permissions' set only to 'read' so also should be safe.

Changes

Configuration & Infrastructure

  • Added .codespellrc with skip patterns for .git, vendored jsPsych, PDFs, SVGs, CSS
  • Created GitHub Actions workflow to check spelling on push to master and PRs
  • Uses pinned codespell-project/actions-codespell@v2.2 action

Typo Fixes

Ambiguous typos fixed manually (19 fixes with context review):

  • tyesyes in 3 files (neither codespell suggestion was correct; flag is --yesToPrompts)
  • InitativeInitiative, commndscommands, thowthrow
  • registerdregistered, complextcomplex, thesesthese
  • elipseellipse, ComplieCompile, InteraceInterface
  • doesntdoesn't (2), cantcan't (2)

Typos codespell missed (fixed manually):

  • usnernameusername (docs/subject-feedback.md)
  • initScrannerStreaminitScannerStream (docs/for-developers.md)
  • getAllReponsesgetAllResponses (docs/for-developers.md)
  • initalizeinitialize (projects/sample/initialize.py, missed by codespell)

Non-ambiguous typos fixed automatically (65 fixes in 38 files via codespell -w):
Common fixes include: recievesreceives, requets/reqeustsrequests,
initalizeinitialize, calcluatecalculate, utilitesutilities,
wholelywholly, paritallypartially, occuredoccurred,
runnningrunning, instatiatedinstantiated, and many more.

Historical Context

This project had 3 prior commits fixing typos manually (grep for "typo" in git log),
demonstrating the value of automated spell-checking.

Testing

  • Codespell passes with zero errors after all fixes
  • All changes are in comments, docstrings, help strings, and documentation — no functional code modified

🤖 Generated with Claude Code and love to typos free code

yarikoptic and others added 6 commits April 16, 2026 12:09
Co-Authored-By: Claude Code 2.1.111 / Claude Opus 4.6 <noreply@anthropic.com>
Ambiguous typos (multiple codespell suggestions, resolved by context):
- Initative -> Initiative (docs/using-bids-data.md)
- tyes -> yes (3 files; neither codespell suggestion was correct)
- commnds -> commands (rtCommon/projectServer.py)
- thow -> throw (rtCommon/clientInterface.py)
- registerd -> registered (rtCommon/remoteable.py)
- complext -> complex (rtCommon/remoteable.py)
- theses -> these (rtCommon/webServer.py)
- elipse -> ellipse (web/html/jsPsychFeedback.html)
- doesnt -> doesn't (tests/test_bidsIncremental.py, scripts/run-docker.sh)
- cant -> can't (docs/for-developers.md, 2 occurrences)
- Complie -> Compile (scripts/install-on-linux.sh)
- Interace -> Interface (rtCommon/projectServerRPC.py)

Typos codespell missed (found during manual review):
- usnername -> username (docs/subject-feedback.md)
- initScrannerStream -> initScannerStream (docs/for-developers.md)
- getAllReponses -> getAllResponses (docs/for-developers.md)

Co-Authored-By: Claude Code 2.1.111 / Claude Opus 4.6 <noreply@anthropic.com>
65 typos across 30 files, all with single-suggestion fixes including:
- recieves -> receives, requets/reqeusts/requsts -> requests
- initalize -> initialize (4), calcluate -> calculate (2)
- utilites -> utilities (2), miliseconds -> milliseconds (2)
- wholely -> wholly (2), paritally -> partially (2), occured -> occurred (3)
- runnning -> running (2), instatiated -> instantiated (2)
- Various other typos in code comments, docstrings, and documentation

Co-Authored-By: Claude Code 2.1.111 / Claude Opus 4.6 <noreply@anthropic.com>

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "uvx codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
Co-Authored-By: Claude Code 2.1.111 / Claude Opus 4.6 <noreply@anthropic.com>
@mihaic mihaic merged commit 00762e7 into brainiak:master Apr 16, 2026
1 of 2 checks passed
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