ci: add codespell check script for tracking typos

[aabadie]

Contribution description

This PR introduce a new static check script for tracking typos in PRs.

Testing procedure

• Wait for riotdocker to contain codespell (requires Dockerfile: add codespell dependency riotdocker#86)
• Check the CI

Issues/PRs references

Should help with #12230

[kaspar030]

There's a lot of force-pushing going on here. ;)

[aabadie]

There's a lot of force-pushing going on here. ;)

Yeah, I wanted to verify if the container was running the right version. Now everything seems ok. When the Murdock workers are updated, this will be ready for merge (after reviews of course).

[kaspar030]

Ah, this was the other PR waiting on CI update ;)

[aabadie]

Now it works also on Murdock!

[kaspar030]

I tried this on master, there are ~1000 hits, most of them typos but some false positives ("od" -> "of", "WAN" -> "WANT").

Can we change the return value in case of errors to "0", so it basically becomes a warning? With that I'd be OK to merge.

Then I think we need an "--exclude-file" so we can filter the false positives, fix all actual typos and then make this use live ammunition (exit 1 on typo). (but in follow-up PRs).

[aabadie]

most of them typos but some false positives ("od" -> "of", "WAN" -> "WANT")

We can add them to a list of excluded patterns (see here).

Can we change the return value in case of errors to "0", so it basically becomes a warning?

OK

I tried this on master, there are ~1000 hits

If you call the script directly, all files are parsed but using make static-test only files changed in the current branch compared to master are parsed.

[kaspar030]

We can add them to a list of excluded patterns (see here).

Well, we'd need a file for that, too, then (list will get long fast). But wouldn't doing that reduce effectiveness? While some cases might want to use "od" instead of "of", that might also be a real typo. Using "--exclude-file", we have to explicitly add every false-positive line, but codespell stays sharp.

[kaspar030]

If you call the script directly, all files are parsed but using make static-test only files changed in the current branch compared to master are parsed.

Yes, and it shows typos that were already in a file, when doing a probably unrelated change...

[kaspar030]

OK

You can squash directly!

[aabadie]

squashed

[kaspar030]

ACK.

[aabadie]

Thank you!