Makefile

include .env

# ==================================================================================== #
# HELPERS
# ==================================================================================== #

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

.PHONY: confirm
confirm:
	@echo -n 'Are you sure? [y/N] ' && read ans && [ $${ans:-N} = y ]

# ==================================================================================== #
# DEVELOPMENT
# ==================================================================================== #

## run/api: run the cmd/api application
.PHONY: run/api
run/api:
	docker-compose up -d api

.PHONY: run/all
run/all:
	docker-compose --env-file .env -p $(PROJECT_NAME) up --build

.PHONY: down/all
down/all:
	docker-compose down -v

## db/psql: connect to the database using psql
.PHONY: db/psql
db/psql:
	docker-compose -p $(PROJECT_NAME) exec db psql -U $(DATABASE_USER) -d $(DATABASE_NAME)

## db/migrations/new name=$1: create a new database migration
.PHONY: db/migrations/new
db/migrations/new:
	@echo 'Creating migration files for ${name}...'
	migrate create -seq -ext=.sql -dir=./migrations ${name}

## db/migrations/up: apply all up database migrations
.PHONY: db/migrations/up
db/migrations/up: confirm
	@echo 'Running up migrations...'
	docker-compose run --rm migrate

# ==================================================================================== #
# BUILD
# ==================================================================================== #

## build/api: build the cmd/api application
.PHONY: build/api
build/api:
	@echo 'Building cmd/api...'
	go build -ldflags='-s' -o=./bin/api ./cmd/api
	GOOS=linux GOARCH=amd64 go build -ldflags='-s' -o=./bin/linux_amd64/api ./cmd/api

# ==================================================================================== #
# QUALITY CONTROL
# ==================================================================================== #

## test/coverage: provides a report of total test coverage
.PHONY: test/coverage
test/coverage:
	go test -cover "./cmd/api" "./tests/integration"

## audit: tidy dependencies, format, vet, and test all code
.PHONY: audit
audit:
	@echo 'Formatting code...'
	go fmt ./...
	
	@echo 'Vetting code...'
	go vet ./...
	staticcheck ./...
	
	@echo 'Running tests...'
	go test -race -vet=off ./...

## vendor: tidy and vendor dependencies
.PHONY: vendor
vendor:
	@echo 'Tidying and verifying module dependencies...'
	go mod tidy
	go mod verify

	@echo 'Vendoring dependencies...'
	go mod vendor