chore: Precommit hooks and workflow #27
Merged
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.
What does this PR do?
Creates a pre-commit configuration to run additional linting checks. Both local development and the CI use the same pre-commit hooks to verify the quality of the code.
Motivation
Adds pre-commit configuration to ease verifying the quality of committed code and maintain quality via CI.
Describe how you validated your changes
Verify the CI does not attempt to run the
make fmtpre-commit step because it requires a different set of dependencies and thus a different workflow executes that.Additional Notes
Attempted using other standard tools like
prettierbut that package is limited on the files it's able to read, parse, and evaluate it's rules on. For instance, I could not find any support inprettierto do linting on terraform"*.tf"files.