Skip to content

Commit

Permalink
chore: add help Make target
Browse files Browse the repository at this point in the history
  • Loading branch information
jar-b committed Nov 7, 2024
1 parent 82665ee commit 5d766bc
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions GNUmakefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,40 @@ TIMEOUT ?= 30s

default: test lint

cleantidy:
cleantidy: ## Tidy go modules
@echo "make: tidying Go mods..."
@cd tools && go mod tidy && cd ..
@cd v2/awsv1shim && go mod tidy && cd ../..
@go mod tidy
@echo "make: Go mods tidied"

fmt:
fmt: ## Run gofmt
gofmt -s -w ./

gen:
gen: ## Run generators
@echo "make: Running Go generators..."
@go generate ./...

golangci-lint:
golangci-lint: ## Run golangci-lint
@golangci-lint run ./...
@cd v2/awsv1shim && golangci-lint run ./...

importlint:
help: ## Display this help
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-13s\033[0m %s\n", $$1, $$2}'

importlint: ## Lint imports
@impi --local . --scheme stdThirdPartyLocal ./...

lint: golangci-lint importlint
lint: golangci-lint importlint ## Run all linters

semgrep:
semgrep: ## Run semgrep checks
@docker run --rm --volume "${PWD}:/src" returntocorp/semgrep semgrep --config .semgrep --no-rewrite-rule-ids

test:
test: ## Run unit tests
go test -timeout=$(TIMEOUT) -parallel=4 ./...
cd v2/awsv1shim && go test -timeout=$(TIMEOUT) -parallel=4 ./...

tools:
tools: ## Install tools
cd tools && go install github.com/golangci/golangci-lint/cmd/golangci-lint
cd tools && go install github.com/pavius/impi/cmd/impi

Expand All @@ -42,8 +45,9 @@ tools:
fmt \
gen \
golangci-lint \
help \
importlint \
lint \
test \
test \
tools \
tools \

0 comments on commit 5d766bc

Please sign in to comment.