summaryrefslogtreecommitdiffstats
path: root/Makefile
blob: 091d00701270b8f98bd4529e8084b48dc3438234 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Development tasks. Everything runs through `dub`, so there is nothing to
# install first.
#
#   make            list the targets
#   make test       run the suite
#   make lint       dscanner + a dfmt check, no files touched
#   make build      release build of the library
#
# `lint` and `format` shell out to dscanner and dfmt, which dub fetches and
# builds on first use.

DUB ?= dub
DFMT_FLAGS := --max_line_length=100
SOURCES := $(wildcard source/cepis/*.d) $(wildcard test/*.d)

.DEFAULT_GOAL := help
.PHONY: help test lint format build check clean

help:
	@echo 'Targets:'
	@echo '  test       run the test suite (unit and integration)'
	@echo '  lint       dub lint + a dfmt formatting check (read-only)'
	@echo '  format     apply dfmt (writes)'
	@echo '  build      release build of the library'
	@echo '  check      lint + test + build, in that order'
	@echo '  clean      remove build artefacts'

test:
	$(DUB) test

# Read-only by design, so it is safe in CI and in a pre-commit hook: it reports
# what `make format` would change without changing anything.
lint:
	$(DUB) lint
	@status=0; for file in $(SOURCES); do \
		$(DUB) run --quiet --yes dfmt -- $(DFMT_FLAGS) "$$file" \
			| diff -u "$$file" - || status=1; \
	done; exit $$status

format:
	$(DUB) run --quiet --yes dfmt -- $(DFMT_FLAGS) --inplace $(SOURCES)

build:
	$(DUB) build --build=release

# The order matters: lint is the fastest to fail, build the slowest, so a broken
# run reports the cheapest problem first.
check: lint test build

clean:
	$(DUB) clean
	rm -f libcepis.a cepis cepis-test-library