search

timvink / mkdocs-table-reader-plugin

MkDocs plugin that enables a markdown tag like {{ read_csv('table.csv') }} to directly insert various table formats into a page
https://timvink.github.io/mkdocs-table-reader-plugin/
MIT License
111 stars 18 forks source link

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

Closed yarikoptic closed 3 months ago

yarikoptic commented 3 months ago

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.

timvink commented 3 months ago

Cool, thanks for adding!

I'd prefer to keep the root of the project clean. Couldn you update the PR to avoid using the codespelrc file? The githb action supports the options using "with:", see https://github.com/codespell-project/actions-codespell

yarikoptic commented 3 months ago

Let me try to just remove it as see what happens for CI since your config is really minimal here... Note that if you had setup.cfg or even more contemporary pyproject.toml -- we could embed configuration there instead.

overall why I would advise against concentrating configuration for it in CI configuration is that you will (hopefully) run it locally, and then that CI configuration would be ignored. ... I will push a rewritten history without config file now.

timvink commented 3 months ago

That makes sense. Thanks for introducing me to it.

I will try using codespell as a precommit hook in some of my corporate projects, looks interesting!