Makefile

# Rules that should run regardless of files state
all: build

# Environment Variables
BUILD_DIR ?= build/  ## Directory for build files (pdf, artifacts)
LATEX_FILE ?= resume.tex  ## Main LaTeX file
TEXMFHOME := $(shell kpsewhich -var-value=TEXMFHOME)
INSTALL_DIR := $(TEXMFHOME)/tex/luatex/local

# Latexmk Configuration

# -pdf tells latexmk to generate a PDF directly (instead of DVI).
# -lualatex tells latexmk to use the `lualatex` backend.
# -use-make tells latexmk to call make to generate missing files.
# -jobname gives the name of the output pdf file
# -outdir gives the folder for the output file and artifacts
# -quiet suppresses logs

BUILD_OPTIONS := -pdf -quiet -lualatex -jobname=resume -outdir=$(BUILD_DIR)

# ------------------------------------------------------------------------------
# Targets
# ------------------------------------------------------------------------------

.PHONY: build
build: $(LATEX_FILE)  ## Build the resume
	latexmk $(BUILD_OPTIONS) -f $(LATEX_FILE)

.PHONY: preview
preview: $(LATEX_FILE)  ## Builds the resume with preview and reload options
	# The -pvc option turns on the preview and reload mode
	latexmk $(BUILD_OPTIONS) -pvc $(LATEX_FILE)

.PHONY: clean
clean:  ## Cleans up build files
	latexmk -CA -outdir=$(BUILD_DIR) $(LATEX_FILE)

.PHONY: install
install:  ## Copies .cls to `TEXMFHOME`
	@mkdir -p $(INSTALL_DIR)
	cp resume.cls $(INSTALL_DIR)/resume.cls

# ------------------------------------------------------------------------------
# Help - Documentation
# ------------------------------------------------------------------------------

.PHONY: check
check:  ## Check for expected files and print some help if they're missing
ifeq (,$(wildcard $(LATEX_FILE)))
	@printf '$(YELLOW)(!) Expected the following structure:$(RESET)\n'
	@printf 'working_directory/\n'
	@printf '├── Makefile\t\t$(GREY)# <- This file$(RESET)\n'
	@printf '├── $(BOLD)$(LATEX_FILE)\t$(RESET)$(GREY)# (!) Required$(RESET)\n'
	@printf '└── sections/\t\t$(GREY)# << Recommended structure $(ITALIC)- but you do you$(RESET)\n'
	@printf '   ├── education.tex\n'
	@printf '   ├── experience.tex\n'
	@printf '   └── ...\n'
	@exit 1
else
	@:
endif

# Colours Variables - to use colour in 'make help' prints
ITALIC := \033[4m
YELLOW := \033[33m
BLUE := \033[36m
GREY := \033[37m
RESET := \033[0m
BOLD := \033[1m

# Implements this pattern for autodocumenting Makefiles:
# https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
#
# Picks up all comments that start with a ## and are at the end of a target definition line.
.PHONY: help
help:  ## Display command usage
	@printf '$(BOLD)Commands$(RESET)\n'
	@grep -E '^[0-9a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "$(BLUE)%-40s$(RESET) %s\n", $$1, $$2}'
	@printf '$(BOLD)Environment Variables$(RESET)\n'
	@grep -E '^[0-9a-zA-Z_]+ \?=.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = " (\\?=|##) "}; {printf "$(BLUE)%-20s$(GREY)%-20s$(RESET) %s\n", $$1, $$2,$$3}'