feat: Add shellcheck and shfmt Pre-Commit Hooks
#550
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying with
|
| Latest commit: |
7e403d0
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://32e76730.karapace.pages.dev |
| Branch Preview URL: | https://fleshgrinder-shellcheck.karapace.pages.dev |
Fleshgrinder
force-pushed
the
fleshgrinder/shellcheck
branch
3 times, most recently
from
876f9c1
to
78d4fc0
Compare
Fleshgrinder
commented
Feb 21, 2023
| @@ -6,9 +6,6 @@ pdbpp==0.10.2 | |||
| psutil==5.9.0 | |||
| requests==2.27.1 | |||
|
|
|||
| # linting | |||
| pre-commit>=2.2.0 | |||
There was a problem hiding this comment.
We are currently managing this version in two places – here and in the .pre-commit-config.yaml file – and they already diverged. There is no reason to include it here, users who wish to use it can install it on their own (in any way they like), and GitHub Actions uses the pre-commit action now which is versioned separately.
There was a problem hiding this comment.
I had to remove the action, because it is broken with local hooks, and I had to add filelock as direct dependency, because it was used indirectly. Still, the sentiment towards having this dependency stays the same on my side.
Fleshgrinder
force-pushed
the
fleshgrinder/shellcheck
branch
2 times, most recently
from
0164777
to
f970c38
Compare
This adds `shellcheck` and `shfmt` pre-commit hooks. I fixed the most pressing issues that were found, but did not go through the existing scripts otherwise. We are going to need more shell scripts to automate other things, this is why it is a good idea to add these tools to our verification chain. ~This also changes the GHA lint workflow to use the official pre-commit action, which also makes use of caching, and thus should be faster.~ The pre-commit action uses the `--color=always` option, and that option results in the action hanging forever if paired with local hooks, which we have.
Fleshgrinder
force-pushed
the
fleshgrinder/shellcheck
branch
from
f970c38
to
7e403d0
Compare
jjaakola-aiven
approved these changes
Feb 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds
shellcheckandshfmtpre-commit hooks. I fixed the most pressing issues that were found, but did not go through the existing scripts otherwise. We are going to need more shell scripts to automate other things, this is why it is a good idea to add these tools to our verification chain.This also changes the GHA lint workflow to use the official pre-commit action, which also makes use of caching, and thus should be faster.The pre-commit action uses the--color=alwaysoption, and that option results in the action hanging forever if paired with local hooks, which we have.