Skip to content

ci,chore: add codespell support with configuration and fixes#782

Open
yarikoptic wants to merge 4 commits into
kucherenko:masterfrom
yarikoptic:enh-codespell
Open

ci,chore: add codespell support with configuration and fixes#782
yarikoptic wants to merge 4 commits into
kucherenko:masterfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic

@yarikoptic yarikoptic commented Apr 7, 2026

Copy link
Copy Markdown

Since just 1 minor typo fixed - feel free to ignore or cherrypick etc... just my way to say "thanks" for a nice tool is by making world free of typos ;)

Add codespell configuration and fix existing typo.

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 fixtures, SVGs, CSS, lock files
  • Created GitHub Actions workflow to check spelling on push and PRs to master

Domain-Specific Whitelist

Added legitimate terms that codespell flags as typos:

  • afterall - JS test framework function (afterAll)
  • inout - SQL keyword (INOUT)
  • acter - part of CHAR(?:ACTER|SET)? regex pattern for SQL keywords

Typo Fixes

Non-ambiguous typo fixed (1 fix):

  • programing -> programming (apps/jscpd/README.md)

Historical Context

This project has had 39 prior commits fixing typos manually, demonstrating the value of automated spell-checking.

Testing

Codespell passes with zero errors after all fixes.


Generated with Claude Code and love to typos free code


This change is Reviewable

Summary by CodeRabbit

  • Documentation

    • Fixed spelling error in project documentation.
  • Chores

    • Added automated spell-checking configuration and GitHub Actions workflow to maintain code quality across the repository.

yarikoptic and others added 4 commits April 7, 2026 11:49
- Skip fixtures/ directory (test fixtures with intentional duplicate code)
- Add afterall (JS test framework), inout (SQL keyword), acter (part of
  CHAR(?:ACTER|SET)? regex) to ignore-words-list

Co-Authored-By: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>
Fixed typo:
- programing -> programming (apps/jscpd/README.md)

Co-Authored-By: Claude Code 2.1.63 / 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 ^^^
@coderabbitai

coderabbitai Bot commented Apr 7, 2026

Copy link
Copy Markdown

Walkthrough

A .codespellrc configuration file and corresponding GitHub Actions workflow are added to enable automated spell checking on the repository. The workflow runs on push and pull request events to the master branch. A documentation typo in the README is corrected.

Changes

Cohort / File(s) Summary
Codespell Configuration
.codespellrc
New configuration file specifying paths to skip during spell checking (VCS directories, SVG/CSS assets, lock files, fixtures), enabling hidden file scanning, and defining an ignore list for false-positive terms (afterall, inout, acter).
CI/CD Workflow
.github/workflows/codespell.yml
New GitHub Actions workflow that runs codespell on push and pull request events targeting the master branch, using the codespell-project/actions-codespell action with configuration from .codespellrc.
Documentation
apps/jscpd/README.md
Fixed spelling error in the Features section, correcting "programing" to "programming".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A spell-check arrives to catch our flaws,
With .codespellrc and GitHub's cause,
"Programming" now spelled just right,
Our code and words both clean and bright!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly summarizes the main changes: adding codespell integration (CI setup, configuration file) and fixing a typo, which aligns with the actual changeset.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ghost

ghost commented Apr 7, 2026

Copy link
Copy Markdown

Rooviewer Clock   Follow task

Reviewing your PR now. Will share feedback in a few minutes!

@yarikoptic yarikoptic changed the title Add codespell support with configuration and fixes ci,chore: add codespell support with configuration and fixes Apr 7, 2026
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