feat: introduce pre-commit and configure most existing linters in it #118
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
This is toward #114 . This introduces the
pre-commit
tool which is configured to run all hooks that we previously ran locally via standard shell scripts.This MR also runs the hooks on all files resulting in some being touched up.
SuperLinter (used in CI) still provides some checks that we do not cover here yet. This also updates the Dockerfile to symlink the pip installation to /usr/bin to support some tools that expect to find pip installed there.
Reading Guide
Most changes in this MR are source reflows from the linters. The exceptions are
.githooks
.pre-commit-config.yaml
Dockerfile
andMakefile
pre-commit
as a CI step in.github/workflows/pre-merge.yml
Limitations
Setting up the hooks in the Docker environment is a bit awkward because the user first has to install
git
and then trust the DGP repo. We could do this as part of the Dockerfile, but that would mean installinggit
. I did not move to installgit
in this work.The usual concern of people running a virtual environment with a Python version different than what we use in CI persists.
This change is