Add codespell support: workflow, config + make it fix typos

dbpedia / databus

A digital factory platform for managing files online with stable IDs, high-quality metadata, powerful API and tools for building on data: find, access, make interoperable, re-use

Apache License 2.0

42 stars 17 forks source link

Add codespell support: workflow, config + make it fix typos #174

Open yarikoptic opened 9 months ago

yarikoptic commented 9 months ago

See https://github.com/codespell-project/codespell for more info about the tool.

I am on a quest to codespell any project "I touch", so here I am -- feel welcome to close this PR and cherish the typos ;)

Note that some typos were found in the code so might affect (fix?) the operation. Please review with care.

manonthegithub commented 9 months ago

Thanks for contributing. Looks like a useful tool for us, but I don't think it is a good idea to use a python tool in a project which does not use any python. There must be similar tools which could be employed for spellchecking and correction injs as well. @holycrab13 WDYT? do you know one?

yarikoptic commented 9 months ago

I use tools written in other languages all the time, but I could see some rationale behind such desire for local needs (for CI -- doesn't really matter). FWIW I am aware of

https://github.com/streetsidesoftware/cspell but it might require more substantial configuration to get low number of false positives, see https://github.com/mermaid-js/mermaid/pull/5176#issuecomment-1909551351
there was one more, I believe JS tool, which literally reused codespell's dictionary but I forgot its name... I will chime in if I recall that.