Makefile

# Run 'make help' for a list of targets.
.DEFAULT_GOAL := help

PKG_PATH := readme

.PHONY: help
help: ## Shows this help
	@egrep -h '\s##\s' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

## Linting ##
.PHONY: modverify
modverify: ## Runs 'go mod verify'
	@go mod verify

.PHONY: vet
vet: ## Runs 'go vet'
	@go vet ./...

.PHONY: gofumpt
gofumpt: vet ## Check linting with 'gofumpt'
	@go run mvdan.cc/gofumpt -l -d .

.PHONY: lines
lines: ## Check long lines.
	@go run github.com/segmentio/golines -m 120 --dry-run $(PKG_PATH)/

.PHONY: lines-fix
lines-fix: lines ## Fix long lines
	@go run github.com/segmentio/golines -m 120 -w $(PKG_PATH)/

.PHONY: golangci-lint
golangci-lint: ## Lint using 'golangci-lint'
	@go run github.com/golangci/golangci-lint/cmd/golangci-lint \
	run --deadline=300s --timeout=300s --out-format checkstyle ./... 2>&1 | tee checkstyle-report.xml

.PHONY: lint
lint: modverify vet gofumpt lines golangci-lint ## Run all linters

## Testing ##
.PHONY: test
test: ## Run unit and race tests with 'go test'
	go test -v -count=1 -parallel=4 -coverprofile=coverage.txt -covermode count ./$(PKG_PATH)/...
	go test -race -short ./$(PKG_PATH)/...

## Coverage ##
.PHONY: coverage
coverage: test ## Generate a code test coverage report using 'gocover-cobertura'
	go run github.com/boumenot/gocover-cobertura < coverage.txt > coverage.xml
	rm -f coverage.txt

.PHONY: test-coverage
test-coverage: test ## Open the HTML test coverage report
	@go tool cover -html=coverage.txt

## Vulnerability checks ##
.PHONY: check-vuln
check-vuln: ## Check for vulnerabilities using 'govulncheck'
	@echo "Checking for vulnerabilities..."
	go run golang.org/x/vuln/cmd/govulncheck ./...

.PHONY: clean
clean: ## Clean test files
	rm -f dist/*
	rm -f coverage.txt coverage.xml coverage.html checkstyle-report.xml

.PHONY: docs
docs: ## Run 'go generate' to create documentation
	go generate ./...

.PHONY: install
install: ## Run 'go install' to install package
	go install .