Makefile

SHELL = bash
EMACS ?= emacs
PORT ?= 8000
NOOUTPUT = grep -v '^Loading' | { ! grep '^'; }
VENDOR = vendor
FONT_SIZE ?= 180
ENV ?= env
ACTIVATE = source $(ENV)/bin/activate
MAX_LINE_LEN = 80
WAIT_TIME ?= 0.5
SELECTOR ?= t
GIT_CLONE = git clone --depth 1

.PHONY: test

help: ## Display this help message.
	@printf 'Summary of available Makefile recipes:\n\n'
	@grep '##' Makefile | grep -v grep | column -t -s '##'
	@echo

setup-tests:  ## Install everything required for testing (Python dependencies).
	test -d $(ENV) || python3 -m venv $(ENV)
	$(ACTIVATE) && \
	pip install -U pip wheel && \
	pip install -r test/requirements-dev.txt

test: ## Run all ERT tests (set SELECTOR to specify only one).
test: clean server-bg
	sleep $(WAIT_TIME)
	$(EMACS) --batch -L . \
		 -l test/verb-test.el \
		 --eval "(ert-run-tests-batch-and-exit '$(SELECTOR))"; \
	ret=$$?; \
	make server-kill; \
	exit $$ret

server: ## Run a testing HTTP server on port 8000 (default).
	$(ACTIVATE) && \
	SKIP_PIDFILE=1 PORT=$(PORT) python3 test/server.py

server-bg:
	$(ACTIVATE) && \
	PORT=$(PORT) python3 test/server.py &

server-kill:
	kill $$(cat test/server.pid)

clean: ## Clean up all temporary files created during testing/linting.
	rm -f verb-autoloads.el test/server.pid
	find . -name "*.elc" -type f -delete

setup-check: ## Install everything required for linting (package-lint and relint).
	rm -rf $(VENDOR)
	mkdir $(VENDOR)
	$(GIT_CLONE) https://github.com/purcell/package-lint.git $(VENDOR)/package-lint
	$(GIT_CLONE) https://github.com/mattiase/xr.git $(VENDOR)/xr
	$(GIT_CLONE) https://github.com/mattiase/relint.git $(RELINT) $(VENDOR)/relint

lint-file:
	$(EMACS) --batch -L . \
			 --eval '(byte-compile-file "$(filename)")' 2>&1 | $(NOOUTPUT)
	yes n | $(EMACS) --batch \
			 --eval '(find-file "$(filename)")' \
			 --eval '(setq sentence-end-double-space nil)' \
			 --eval '(checkdoc-current-buffer)' 2>&1 | $(NOOUTPUT)
	$(EMACS) --batch -l $(VENDOR)/package-lint/package-lint.el \
			 -f package-lint-batch-and-exit "$(filename)"
	$(EMACS) --batch -l $(VENDOR)/xr/xr.el -l $(VENDOR)/relint/relint.el \
			 -f relint-batch "$(filename)"
	! grep -n '.\{$(MAX_LINE_LEN)\}' "$(filename)"

check: ## Lint all Emacs Lisp files in the package.
check: clean
	make lint-file filename=verb.el
	make lint-file filename=ob-verb.el
	test $$(cat *.el | grep Package-Version | uniq | wc -l) -eq 1

update: ## Update the package version number (version=X.Y.Z).
update:
	@test -n "$(version)" || (echo "version not set!" && exit 1)
	@grep -q "$(version)" CHANGELOG.md || (echo "Update changelog first!" && exit 1)
	sed -i -e "s/^;; Package-Version: .*/;; Package-Version: $(version)/g" verb.el ob-verb.el
	sed -i -e "s/defconst verb-version .*/defconst verb-version \"$(version)\"/g" verb.el

run: ## Run emacs -Q with the working version of verb.el loaded.
run: clean server-bg
	FONT_SIZE=$(FONT_SIZE) $(EMACS) -Q -L . --load test/init.el; \
	make server-kill