adafruit / cookiecutter-adafruit-circuitpython

Cookiecutter template for Adafruit's CircuitPython libraries.
MIT License
22 stars 37 forks source link

run mypy during CI / from pre-commit #183

Open jepler opened 2 years ago

jepler commented 2 years ago

It's great to have type information, but it's not so great if nothing is verifying it. Let's run mypy during CI, and preferably during pre-commit so that we're aware of the quality of our type annotations.

There will be some challenges to doing this, and so it may not be something to enable by deafult. Still, cookie cutter should help point the way (e.g., by a commented out block in pre-commit-config.yaml) even if we can't enable it by default.

(Though enabling by default means that a library has to be mypy "approved" before its initial release, which would be a good thing if it's feasible)

I am prototyping this in https://github.com/jepler/Jepler_CircuitPython_udecimal/pull/13