Add codespell support (config, workflow to detect/not fix) and make it fix few typos

[yarikoptic]

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

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.17%. Comparing base (bd85b3a) to head (0e00255).
Report is 12 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #27      +/-   ##
==========================================
- Coverage   78.84%   76.17%   -2.68%     
==========================================
  Files           2        2              
  Lines        1026     1024       -2     
==========================================
- Hits          809      780      -29     
- Misses        217      244      +27     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[deajan]

Really like this one ^^
Thank you !

[deajan]

Just used this on another repo, works like a charm.
Just a quick side question, how do you get the excludes to work ?
I'd usually just add this to my testing workflow on top of black / pylint / flake8, so I'd run this with --skip *.yaml or so. How yo I achieve the same with gh actions ?

[yarikoptic]

action is just a wrapper around the codespell tool -- thus best to avoid any generic configuration in the action. For that there is the .codespellrc file https://github.com/netinvent/command_runner/pull/27/files#diff-5df60be1ec15d5da885121f5941ad7ceb4a31d7edeaf038873247cd1b9eb0193 where you could add "global" skips of words or regexes. There is also ways for "inline" ignores using codespell:ignore in the line comments https://github.com/codespell-project/codespell?tab=readme-ov-file#inline-ignore .

FWIW -- if you eventually add pyproject.toml or setup.cfg - you can move configuration into that file. see https://github.com/codespell-project/codespell?tab=readme-ov-file#using-a-config-file for more info

[yarikoptic]

FWIW if you are using black, can also start using pre-commit and then add codespell there too... See e.g. our https://github.com/dandi/dandi-cli/blob/master/.pre-commit-config.yaml

For adding to other projects, consider (generalizing or adopting) my crude helper: https://github.com/yarikoptic/improveit/blob/main/codespellit

[deajan]

Thank you for the insight. Adopted codespell.