"Interaction" with pre-commit: ideally should skip the skipped files.

[yarikoptic]

I ran into it before but forgot to report, and now didn't find open issue. Currently inspired by PrefectHQ/prefect#10893 where running codespell in CLI directly results in no hits, but pre-commit reports:

codespell................................................................Failed
- hook id: codespell
- exit code: 65

.github/ISSUE_TEMPLATE/5_maintenance_ticket.yaml:1: maintenence ==> maintenance
.github/workflows/python-tests.yaml:62: automaticlly ==> automatically
.github/workflows/python-tests.yaml:246: automaticlly ==> automatically
.github/ISSUE_TEMPLATE/2_ui_bug_report.yaml:69: Browers ==> Browsers
ui/package-lock.json:2999: OT ==> TO, OF, OR, NOT
ui/package-lock.json:8411: OT ==> TO, OF, OR, NOT
src/prefect/_vendor/fastapi/utils.py:131: unecessary ==> unnecessary

Problems:

1. If I define files to skip in codespell configuration (e.g. in .codespellrc), those files will not be skipped in pre-commit run --all since ( I guess) pre-commit would pass those paths explicitly to codespell invocation and thus it would not account for skip.

2. Also, complimentary, may be codespell should check in .dotdirs like .github etc?

[DimitriPapadopoulos]

1. It looks like we do skip explicitly passed files that match the skip list:

   $ echo unecessary > foobar
   $ 
   $ codespell foobar
   foobar:1: unecessary ==> unnecessary
   $ 
   $ codespell -S foobar foobar
   $ 
   

   Could it be that .codespellrc is not taken into account when codespell is run by pre-commit?
2. Does option -H/--check-hidden help?

[yarikoptic]

1. Could it be that .codespellrc is not taken into account when codespell is run by pre-commit?

I think it might be more of the case of directories listed in skip

❯ grep skip .codespellrc
skip = .git,*.pdf,*.svg,versioneer.py,package-lock.json,_vendor,*.css
❯ codespell
❯ codespell **/_vendor
src/prefect/_vendor/fastapi/utils.py:131: unecessary ==> unnecessary

2. Does option -H/--check-hidden help?

oh, it does! besides that I need to skip .codespellrc explicitly then. I should probably make this "default" in my "codespellit" script.

[DimitriPapadopoulos]

oh, it does! besides that I need to skip .codespellrc explicitly then. I should probably make this "default" in my "codespellit" script.

Mmmh.. I wonder whether we should always skip files named .codespellrc.

[DimitriPapadopoulos]

❯ grep skip .codespellrc
skip = .git,*.pdf,*.svg,versioneer.py,package-lock.json,_vendor,*.css
❯ codespell
❯ codespell src
❯ codespell src/prefect
❯ codespell src/prefect/_vendor
src/prefect/_vendor/fastapi/utils.py:131: unecessary ==> unnecessary
❯ codespell src/prefect/_vendor/fastapi
src/prefect/_vendor/fastapi/utils.py:131: unecessary ==> unnecessary

It looks like we don't test well enough the root directory passed as an argument.

[yarikoptic]

FWIW, if I have missed the point above -- seems to apply also for target filename, not just folder:

❯ codespell community/front-end/ofe/
❯ codespell community/front-end/
❯ codespell community/
❯ codespell
❯ codespell --version
2.2.6
❯ pre-commit run --all codespell
codespell................................................................Failed
- hook id: codespell
- exit code: 65

community/front-end/ofe/requirements.txt:4: astroid ==> asteroid
community/front-end/ofe/website/ghpcfe/static/js/bootstrap.bundle.js:2947: trough ==> through
community/front-end/ofe/website/ghpcfe/static/js/bootstrap.bundle.js:3420: othwerise ==> otherwise
community/front-end/ofe/website/ghpcfe/static/js/bootstrap.bundle.js:3842: ofset ==> offset, of set
community/front-end/ofe/website/ghpcfe/static/js/bootstrap.bundle.js:3873: trough ==> through
community/front-end/ofe/website/ghpcfe/static/js/jquery.formset.js:166: thnaks ==> thanks
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:2176: guarnteed ==> guaranteed
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:6353: enhancments ==> enhancements
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:6521: enhancment ==> enhancement
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:7308: multipe ==> multiple
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8018: Deffered ==> Differed, Deferred
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8827: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8918: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8920: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8923: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8925: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8927: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8930: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8932: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8945: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8956: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8988: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8995: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:8997: calender ==> calendar
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:9493: overriden ==> overridden
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:10468: modfied ==> modified
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:12226: openening ==> opening
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:13972: inital ==> initial
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:16590: get's ==> gets
community/front-end/ofe/website/ghpcfe/static/js/jquery-ui.js:17906: durning ==> during

❯ grep skip .codespellrc
skip = .git,*.pdf,*.svg,*.min.js,*.js.map,js,requirements.txt