Skip to content

Decouple codespell from pre-commit config with rc file#2581

Merged
fpapon merged 2 commits intoapache:mainfrom
jbampton:codespellrc
Mar 2, 2026
Merged

Decouple codespell from pre-commit config with rc file#2581
fpapon merged 2 commits intoapache:mainfrom
jbampton:codespellrc

Conversation

@jbampton
Copy link
Member

codespell when run with pre-commit will automatically look for the rc file

Also makes it a lot more convenient when running codespell standalone from the repo root since it uses this same rc file

codespell is a python package and installed with pip

So for example when you have to regenerate the codespell ignored words list you need to run codespell from the commandline with my one line script.

In future we can add a skip entry to the rc file to skip / exclude directories and files from spell checking

refs #2521

https://github.com/codespell-project/codespell?tab=readme-ov-file#using-a-config-file

codespell when run with pre-commit will automatically look for the rc file

Also makes it a lot more convenient when running codespell standalone from the repo root since it uses this same rc file

codespell is a python package and installed with pip

So for example when you have to regenerate the codespell ignored words list you need to run codespell from the commandline with my one line script.

In future we can add a `skip` entry to the rc file to skip / exclude directories and files from spell checking
@github-actions github-actions bot added the yaml label Feb 27, 2026
@fpapon fpapon merged commit 2ebea8c into apache:main Mar 2, 2026
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants