myfaces icon indicating copy to clipboard operation
myfaces copied to clipboard

Add pre-commit with codespell and fix typos

Open jbampton opened this issue 6 months ago • 4 comments

The codespell hook is self contained and is bootstrapped with pre-commit. There is no need to have codespell installed to run pre-commit.

To recreate the codespell ignored words list - codespell.txt - you will need to have codespell installed locally.

Ran locally:

codespell --skip='./api/src/main/resources/jakarta/faces' | cut -f2 -d' ' | tr A-Z a-z | sort | uniq > .github/linters/codespell.txt

https://github.com/pre-commit/pre-commit

https://pre-commit.com/

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

https://pre-commit.com/#github-actions-example

pre-commit config examples:

https://github.com/apache/sedona/blob/master/.pre-commit-config.yaml

https://github.com/apache/airflow/blob/main/.pre-commit-config.yaml

There are many more hooks we could add for example:

https://github.com/pre-commit/pre-commit-hooks

jbampton avatar Jun 30 '25 18:06 jbampton

@jbampton @melloware I'm a bit busy and won't have time until next week

bohmber avatar Jul 02 '25 08:07 bohmber

@bohmber no rush...I didn't want to merge a pre-commit hook PR without someone like you verifying and approving it.

melloware avatar Jul 02 '25 11:07 melloware

This looks good based on my investigation. I don't have many objects -- just that one comment.

@bohmber @tandraschko Your thoughts?

volosied avatar Sep 18 '25 19:09 volosied

@jbampton Just following up.

volosied avatar Sep 22 '25 14:09 volosied