syncmap/Makefile at main · axonops/syncmap · GitHub

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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
.DEFAULT_GOAL := help
SHELL := bash
.SHELLFLAGS := -eu -o pipefail -c

GO           ?= go
GOBIN        ?= $(shell $(GO) env GOPATH)/bin
GOLANGCI     ?= $(GOBIN)/golangci-lint
GOIMPORTS    ?= $(GOBIN)/goimports
GOVULNCHECK  ?= $(GOBIN)/govulncheck
GORELEASER   ?= goreleaser

GO_FILES     := $(shell find . -type f -name '*.go' -not -path './.git/*' 2>/dev/null)
PKG          := ./...
BDD_PKG      := ./tests/bdd/...
COVER_OUT    := coverage.out
COVER_HTML   := coverage.html

.PHONY: help
help: ## Show this help
	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage: make \033[36m<target>\033[0m\n\nTargets:\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-18s\033[0m %s\n", $$1, $$2 }' $(MAKEFILE_LIST)

.PHONY: check
check: fmt-check vet lint tidy-check test test-bdd coverage security ## Run the full quality gate (mirrors CI)

.PHONY: test
test: ## Run unit tests with race detector
	$(GO) test -race -count=1 $(PKG)

.PHONY: test-bdd
test-bdd: ## Run BDD tests
	@if [ -d tests/bdd ]; then \
		$(GO) test -race -count=1 -tags bdd $(BDD_PKG); \
	else \
		echo "tests/bdd not present yet — skipping BDD run"; \
	fi

.PHONY: lint
lint: ## Run golangci-lint
	$(GOLANGCI) run $(PKG)

.PHONY: vet
vet: ## Run go vet
	$(GO) vet $(PKG)

.PHONY: fmt
fmt: ## Auto-format Go source files
	$(GO) fmt $(PKG)
	@if command -v $(GOIMPORTS) >/dev/null 2>&1; then $(GOIMPORTS) -w $(GO_FILES); fi

.PHONY: fmt-check
fmt-check: ## Fail if any Go file is unformatted
	@out=$$(gofmt -s -l .); if [ -n "$$out" ]; then echo "gofmt diff:"; echo "$$out"; exit 1; fi
	@if command -v $(GOIMPORTS) >/dev/null 2>&1; then out=$$($(GOIMPORTS) -l .); if [ -n "$$out" ]; then echo "goimports diff:"; echo "$$out"; exit 1; fi; fi

.PHONY: bench
bench: ## Run benchmarks
	$(GO) test -bench=. -benchmem -run=^$$ $(PKG)

.PHONY: bench-regression
bench-regression: ## Compare this tree against bench.txt and fail on regression
	@if ! command -v benchstat >/dev/null 2>&1; then \
		echo "benchstat not installed. Install with: go install golang.org/x/perf/cmd/benchstat@latest"; \
		exit 2; \
	fi
	@echo "Running benchmarks at count=5 (fresh samples for benchstat)..."
	@$(GO) test -bench=. -benchmem -run=^$$ -count=5 $(PKG) > current.txt
	@echo "Comparing against committed baseline (bench.txt) via benchstat..."
	@benchstat bench.txt current.txt | tee bench-regression.txt
	@./scripts/check-bench-regression.sh bench-regression.txt

.PHONY: coverage
coverage: ## Generate coverage profile and HTML report for the library
	$(GO) test -race -coverprofile=$(COVER_OUT) -covermode=atomic .
	$(GO) tool cover -func=$(COVER_OUT) | tail -1
	$(GO) tool cover -html=$(COVER_OUT) -o $(COVER_HTML)

.PHONY: tidy
tidy: ## Run go mod tidy
	$(GO) mod tidy

.PHONY: tidy-check
tidy-check: ## Fail if go mod tidy would modify go.mod or go.sum
	@cp go.mod go.mod.bak
	@[ -f go.sum ] && cp go.sum go.sum.bak || true
	@$(GO) mod tidy
	@if ! diff -q go.mod go.mod.bak >/dev/null; then mv go.mod.bak go.mod; [ -f go.sum.bak ] && mv go.sum.bak go.sum || true; echo "go.mod drift — run 'make tidy'"; exit 1; fi
	@if [ -f go.sum ] && [ -f go.sum.bak ] && ! diff -q go.sum go.sum.bak >/dev/null; then mv go.sum.bak go.sum; mv go.mod.bak go.mod; echo "go.sum drift — run 'make tidy'"; exit 1; fi
	@rm -f go.mod.bak go.sum.bak

.PHONY: security
security: ## Run govulncheck
	@if command -v $(GOVULNCHECK) >/dev/null 2>&1; then \
		$(GOVULNCHECK) $(PKG); \
	else \
		echo "govulncheck not installed — skipping (install: go install golang.org/x/vuln/cmd/govulncheck@latest)"; \
	fi

.PHONY: release-check
release-check: ## Validate GoReleaser config without releasing
	$(GORELEASER) check

.PHONY: llms-full
llms-full: ## Regenerate llms-full.txt from its canonical sources
	@./scripts/gen-llms-full.sh

.PHONY: llms-full-check
llms-full-check: ## Fail if llms-full.txt is out of date
	@cp llms-full.txt llms-full.txt.bak
	@trap 'mv -f llms-full.txt.bak llms-full.txt 2>/dev/null || true' EXIT; \
	./scripts/gen-llms-full.sh >/dev/null; \
	if ! diff -q llms-full.txt llms-full.txt.bak >/dev/null; then \
		echo "llms-full.txt drift — run 'make llms-full' and commit the result"; \
		exit 1; \
	fi; \
	rm -f llms-full.txt.bak; \
	trap - EXIT

.PHONY: clean
clean: ## Remove generated test and coverage artefacts
	$(GO) clean -testcache
	rm -f $(COVER_OUT) $(COVER_HTML)