Makefile

## help: print this help message
help:
	@echo "Usage:"
	@sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ":" | sed -e 's/^/  /'

## lint: runs golangci lint based on .golangci.yml configuration
.PHONY: lint
lint:
	golangci-lint run -c .golangci.yml  --fix -v

## unit-test: runs tests
.PHONY: unit-test
unit-test:
	go test -v ./... -coverprofile=unit_coverage.out

## unit-coverage-html: extract unit tests coverage to html format
.PHONY: unit-coverage-html
unit-coverage-html:
	make unit-test
	go tool cover -html=unit_coverage.out -o unit_coverage.html

## before-commit: run golangci lint and unit tests before commit
.PHONY: before-commit
before-commit: lint unit-test

## build-cli: build the cli application
.PHONY: build-cli
build-cli:
	go build -o vx cmd/vx/main.go

## precommit-install: install pre-commit scripts to .git/hooks
.PHONY: precommit-install
precommit-install:
	pre-commit install

## precommit-run: runs pre-commit scripts without commiting the changes
.PHONY: precommit-run
precommit-run:
	pre-commit run --all-files