NETOBSERV-1498 Add shellcheck linter for bash and make help target #5
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
jpinsonneau
reviewed
Mar 13, 2024
| $(OCI_BIN) build -t network-observability-cli . | ||
|
|
||
| .PHONY: lint | ||
| lint: prereqs ## Lint code | ||
| @echo "### Linting code" | ||
| golangci-lint run ./... | ||
| @echo "### Run shellcheck against bash scripts" | ||
| find . -name '*.sh' | xargs shellcheck |
There was a problem hiding this comment.
Is there a way to install shellcheck automatically in the prereqs target ?
There was a problem hiding this comment.
There was a problem hiding this comment.
no this a pkg u need to install on ur host and it depends on the os
There was a problem hiding this comment.
the article above suggest:
docker pull koalaman/shellcheck:latest
docker run -v "$PWD:/mnt" koalaman/shellcheck "$1"
The advantage of this is that shellcheck will not be a requirement for devs / CI
Else we need to add that in the README
There was a problem hiding this comment.
updated readme its not worth spinning up docker atm for single pkg dependency
jpinsonneau
reviewed
Mar 13, 2024
Comment on lines
+48
to
+54
| .PHONY: help | ||
| help: ## Display this help. | ||
| @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) |
jpinsonneau
reviewed
Mar 13, 2024
Comment on lines
+1
to
+3
| #!/usr/bin/env bash | ||
| set -eux | ||
|
|
There was a problem hiding this comment.
ok since this repo has bash dependency I thought having lint for bash will be add good value
Signed-off-by: Mohamed Mahmoud <[email protected]>
jpinsonneau
changed the title
jpinsonneau
approved these changes
Mar 13, 2024
|
/approve |
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.
Add shellcheck bash scripts linter and fix linter error
Add make help target