Makefile

SHELL := bash

VERSION ?=
CMD ?=

EMACS ?= emacs

# The order is important for compilation.
for_compile := *.el
for_checkdoc := *.el
for_longlines := $(wildcard *.bash *.el *.md *.yml) Makefile

.PHONY: help
help: ## Show this message
	@echo "usage:" >&2
	@grep -h "[#]# " $(MAKEFILE_LIST)	| \
		sed 's/^/  make /'		| \
		sed 's/:[^#]*[#]# /|/'		| \
		sed 's/%/LANG/'			| \
		column -t -s'|' >&2

.PHONY: lint
lint: compile checkdoc longlines package-lint ## Build project and run linters

.PHONY: compile
compile: ## Check for byte-compiler errors
	@for file in $(for_compile); do \
	    echo "[compile] $$file" ;\
	    rm -f "$${file}c" ;\
	    $(EMACS) -Q --batch -L . -f batch-byte-compile $$file 2>&1 \
	        | grep -v "^Wrote" \
	        | grep . && exit 1 || true ;\
	done

.PHONY: checkdoc
checkdoc: ## Check for missing or poorly formatted docstrings
	@for file in $(for_checkdoc); do \
	    echo "[checkdoc] $$file" ;\
	    $(EMACS) -Q --batch \
	        --eval "(or (fboundp 'checkdoc-file) (kill-emacs))" \
	        --eval "(setq sentence-end-double-space nil)" \
	        --eval "(checkdoc-file \"$$file\")" 2>&1 \
	        | grep . && exit 1 || true ;\
	done

.PHONY: longlines
longlines: ## Check for lines longer than 79 characters
	@for file in $(for_longlines); do \
	    echo "[longlines] $$file" ;\
	    cat "$$file" \
	        | sed '/[l]onglines-start/,/longlines-stop/d' \
	        | grep -E '.{80}' \
	        | grep -E -v 'https?://' \
	        | sed "s/^/$$file:long line: /" \
	        | grep . && exit 1 || true ;\
	done

.PHONY: package-lint
package-lint: ## Check for common packaging errors
	@echo "[package-lint] apheleia.el"
	@"$(EMACS)" -Q -batch -l scripts/elpa.el \
		-l scripts/hack-package-lint.el --eval \
		"(setq package-lint-batch-fail-on-warnings nil)" \
		-f package-lint-batch-and-exit apheleia.el

.PHONY: clean
clean: ## Remove build artifacts
	@echo "[clean]" *.elc
	@rm -f *.elc

.PHONY: docker
docker: ## Start a Docker shell; e.g. make docker VERSION=25.3
	@scripts/docker.bash "$(VERSION)" "$(CMD)"

.PHONY: update
update: ## Install and update development dependencies
	@"$(EMACS)" --batch -l scripts/update-pkgs.el

.PHONY: test
test: test/readme ## Run formatter test suite
	@cd test && find formatters -type f,l ! -name "*.formatted" | \
		xargs -n1 ./test-formatter.bash

test/%: ## Run test for specified formatter e.g. make test/mode/formatter
	@FILE=$$(cd test && \
		find formatters/ -type f,l -path *$*.* ! -name "*.formatted"); \
	if [[ -n "$${FILE}" ]]; then \
		cd test && ./test-formatter.bash "$${FILE}"; \
	else \
		echo >&2 "Mode/formatter pair not found: $*"; \
		exit 1; \
	fi

test/readme: ## Run test for README
	@cd test && ./test-readme.el