docs/Makefile at main · livetemplate/docs · 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
.PHONY: help serve site validate test test-unit test-examples test-e2e test-e2e-local sweep examples-test examples-list

SWEEP_URL ?= https://livetemplate.fly.dev

help:
	@echo "LiveTemplate docs — local development targets:"
	@echo "  serve            Run the docs site (tinkerdown serve content/)"
	@echo "  site             Run cmd/site (recipes binary on :9091, what tinkerdown proxies to)"
	@echo "  validate         Validate every page (tinkerdown validate content/)"
	@echo "  test-unit        Run fast Go package tests with GOWORK=off"
	@echo "  test-examples    Run example package tests with GOWORK=off"
	@echo "  test-e2e         Run browser-backed docs e2e tests with GOWORK=off"
	@echo "  test-e2e-local   Run docs e2e against http://127.0.0.1:8084"
	@echo "  sweep            Crawl the sitemap + flag horizontal overflow / missing content"
	@echo "                   (override target: make sweep SWEEP_URL=http://127.0.0.1:8084)"
	@echo "  test             Run the full Go test suite with GOWORK=off"
	@echo "  examples-test    Alias for test-examples"
	@echo "  examples-list    Enumerate examples (one per line)"
	@echo ""
	@echo "  To run a single example standalone:"
	@echo "      go run ./examples/<slug>/cmd --dev"
	@echo ""
	@echo "  To run a single example's tests:"
	@echo "      go test ./examples/<slug>"

serve:
	tinkerdown serve content/

site:
	go run ./cmd/site

validate:
	tinkerdown validate content/

test-unit:
	GOWORK=off go test ./cmd/... ./examples/counter/... ./examples/counter-basic/...

test-examples:
	GOWORK=off go test ./examples/...

test-e2e:
	GOWORK=off go test ./e2e/...

test-e2e-local:
	GOWORK=off E2E_BASE_URL=http://127.0.0.1:8084 go test ./e2e/...

# Responsive/visual gate: crawl /sitemap.xml and screenshot every page at
# desktop + iphone-14, reporting any horizontal overflow or missing content.
# This is the honest "visual regression" for this site (the Phase-1 mockups
# were throwaway Tailwind, so pixel-diffing against them is noise).
sweep:
	GOWORK=off go run ./e2e/cmd/sweep $(SWEEP_URL)

test:
	GOWORK=off go test ./...

examples-test:
	$(MAKE) test-examples

examples-list:
	@ls -1 examples/ | grep -v '^cmd$$'