Add pre-commit checks #597
Conversation
Make sure that we do not have trailing blanks and so on and that Python code is reasonably formatted
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||
| rev: v3.2.0 | ||
| hooks: | ||
| - id: trailing-whitespace |
There was a problem hiding this comment.
should we add another hook for python linter? Then you do not need to wait until CI runs through and clippy for rust files maybe. Just a thought
There was a problem hiding this comment.
flake8 and pylint has similar checks, but with some differences. At the moment we do not do any linter checks with pylint/mypy in CI, but in the long run we better should. In feeder we use pylint/mypy, but only fail on errors. I did by the way try mypy some time ago on kuksa-client but it gave some false positives as it could not really understand the gRPC integration correctly, so there are some tweaks needed if we are to use it.
It is possiblw to run pylint as part of pre-commit, see https://pylint.pycqa.org/en/latest/user_guide/installation/pre-commit-integration.html, but it requires that you do a local install. That is no problem for us working with Python but I am not sure if our rust/c++-guys want to do that, as it might be needed even if you have not changed any Python files.
I suggest we take extending/improving checks as a later step.
This will introduce pre-commit checks for kuksa-val. We already have it for kuksa.val.feeders
What it will do:
Suggest approach is to have a pre-commit hook installed on your local machine, then the check will be performed before you commit and this check shall be guaranteed to pass. But you may work reactively as well and fix issues if build fails and upload a new version. It only checks files affected by the commit/PR, but it checks the whole file, so initially you may need to fix some old sins.
Caveat: There might be cases where we do not want files to be changed, I took some settings "inherited" from kuksa.val.feeders. If you would notice that the checker wants to change files that should not be changed, then we may need to tweak the setting.