Makefile

# Based on https://git.io/fjkGc

# The full path to the main package is use in the
# imports tool to format imports correctly.
NAMESPACE = github.com/xorcare/caiman

# The name of the file recommended in the standard
# documentation go test -cover and used codecov.io
# to check code coverage.
COVER_FILE ?= coverage.out

# Main targets.
.DEFAULT_GOAL := build

build: ## Build the project binary
	@go build ./cmd/caiman

ci: check build ## Target for integration with ci pipeline
	go get github.com/xorcare/caiman/cmd/caiman
	caiman --help

check: static test build ## Check project with static checks and unit tests

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

imports: tools ## Check and fix import section by import rules
	@test -z $$(for d in $$(go list -f {{.Dir}} ./...); do goimports -e -l -local $(NAMESPACE) -w $$d/*.go; done)

install: ## Install the project binary to $GOPATH/bin
	@go install ./cmd/caiman

lint: tools ## Check the project with lint
	@golint -set_exit_status ./...

static: imports vet lint ## Run static checks (lint, imports, vet, ...) all over the project

test: ## Run unit tests
	@go test ./... -count=1 -race
	@go test ./... -count=1 -coverprofile=$(COVER_FILE) -covermode=atomic $d
	@go tool cover -func=$(COVER_FILE) | grep ^total

tools: ## Install all needed tools, e.g. for static checks
	@go install \
	golang.org/x/lint/golint \
	golang.org/x/tools/cmd/goimports

toolsup: ## Update all needed tools, e.g. for static checks
	go mod tidy && \
	go get \
	golang.org/x/lint/golint@latest \
	golang.org/x/tools/cmd/goimports@latest && \
	go mod download && \
	go mod verify
	$(MAKE) tools

vet: ## Check the project with vet
	@go vet ./...

.PHONY: build check ci help imports install lint static test tools toolsup vet