Skip to content

Enhance codespell support with configuration, CI workflow, and fixes#37

Open
yarikoptic wants to merge 5 commits intoMRI-Lab-Graz:mainfrom
yarikoptic:enh-codespell
Open

Enhance codespell support with configuration, CI workflow, and fixes#37
yarikoptic wants to merge 5 commits intoMRI-Lab-Graz:mainfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Copy Markdown

So there was codespell ignore file but seems no 'central' config. There still is

tests/verify_repo.py:def check_codespell(repo_path, fix=False):

But I think it largely becomes obsolete since better to fix config to just rely on just running codespell and github action would also annotate conveniently where typos found.

Changes

Configuration & Infrastructure

  • Added [tool.codespell] section in pyproject.toml with comprehensive skip patterns
  • Created GitHub Actions workflow (.github/workflows/codespell.yml) to check spelling on push to main and PRs
  • Created .codespellignore file with German language tokens and domain-specific terms

Skip Patterns

  • Standard: .git, .gitattributes, *.pdf, *.svg, vendor, *.css, *.min.*
  • Project-specific: official/, examples/ (predominantly German-language survey content)

Domain-Specific Whitelist (.codespellignore)

Added legitimate terms that codespell flags as typos:

  • German words: Sie, sie, oder, ist, als, unter, vor, finde, offen, alle, ue/Ue, Fo, bu/BU, linke
  • Medical/scientific: VAS/vas (Visual Analogue Scale), puls (physiological data type)
  • Project domain: ANC/anc (Austrian NeuroCloud), sav/SAV (SPSS file format), Linz (city in Austria), datas (PyInstaller parameter name)
  • Valid English: theses (plural of thesis), pre-select/pre-selected (valid hyphenated forms)

Typo Fixes

  • schmeasschemas in .github/instructions/repo.instructions.md
  • imporatntimportant in .github/instructions/repo.instructions.md
  • accrosacross in official/library/survey/survey-bfi-s.json (citation text)
  • somehwatsomewhat in official/library/survey/survey-nmp-q.json (9 occurrences in English response option text)

Testing

codespell passes with zero errors after all fixes


🤖 Generated with Claude Code and love to typos free code

yarikoptic and others added 5 commits April 17, 2026 23:01
- Reference .codespellignore via ignore-words in pyproject.toml
- Add comprehensive German word list (sie, als, unter, vor, finde, offen, etc.)
- Add domain terms: VAS (Visual Analogue Scale), ANC (Austrian NeuroCloud),
  sav/SAV (SPSS format), Linz (city), datas (PyInstaller parameter)
- Skip official/ and examples/ directories (predominantly German content)
- Add pre-select/pre-selected and theses to ignore-words-list

Co-Authored-By: Claude Code 2.1.114 / Claude Opus 4.6 <noreply@anthropic.com>
- schmeas -> schemas (repo.instructions.md)
- imporatnt -> important (repo.instructions.md)
- accros -> across (survey-bfi-s.json citation)
- somehwat -> somewhat (survey-nmp-q.json, 9 occurrences)

Co-Authored-By: Claude Code 2.1.114 / Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Code 2.1.114 / Claude Opus 4.6 <noreply@anthropic.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