-
Notifications
You must be signed in to change notification settings - Fork 9
/
Makefile
387 lines (300 loc) · 12.3 KB
/
Makefile
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
# Run `make help` to display help
.DEFAULT_GOAL := $(or $(EVY_DEFAULT_GOAL),help)
# --- Global -------------------------------------------------------------------
O = out
COVERAGE = 69
VERSION ?= $(shell git describe --tags --dirty --always)
GOFILES = $(shell find . -name '*.go')
PRETTIER = npx --prefix $(NODEPREFIX) -y prettier --log-level warn
## Build, test, check coverage and lint
all: build-full test lint
@if [ -e .git/rebase-merge ]; then git --no-pager log -1 --pretty='%h %s'; fi
@echo '$(COLOR_GREEN)Success$(COLOR_NORMAL)'
test: test-go test-tiny test-cli check-coverage
lint: lint-go lint-sh check-prettier check-style check-fmt-evy conform
## Full clean build and up-to-date checks as run on CI
ci: clean check-uptodate all
check-uptodate: tidy fmt doc docs learn lab
test -z "$$(git status --porcelain)" || { git status; false; }
## Remove generated files
clean::
-rm -rf $(O)
.PHONY: all check-uptodate ci test lint clean
# --- Build --------------------------------------------------------------------
GO_LDFLAGS = -X main.version=$(VERSION)
CMDS = .
LEARN_CMDS = ./cmd/levy
## Build full evy binaries
build-full: embed | $(O)
go build -tags full -o $(O) -ldflags='$(GO_LDFLAGS)' $(CMDS)
## Build evy binaries without web content embedded
build-go: $(O)
go build -o $(O) -ldflags='$(GO_LDFLAGS)' $(CMDS)
cd learn; go build -o ../$(O) -ldflags='$(GO_LDFLAGS)' $(LEARN_CMDS)
## Build and install binaries in $GOBIN
install-full: embed
go install -tags full -ldflags='$(GO_LDFLAGS)' $(CMDS)
cd learn; go install -ldflags='$(GO_LDFLAGS)' $(LEARN_CMDS)
## Build and install binaries without embedded frontend in $GOBIN
install:
go install -ldflags='$(GO_LDFLAGS)' $(CMDS)
go install -C learn -ldflags='$(GO_LDFLAGS)' $(LEARN_CMDS)
# Use `go version` to ensure the right go version is installed when using tinygo.
go-version:
go version
## Build with tinygo targeting wasm
# optimise for size, see https://www.fermyon.com/blog/optimizing-tinygo-wasm
build-tiny: go-version | $(O)
GOOS=wasip1 GOARCH=wasm tinygo build -o $(O)/evy-unopt.wasm -no-debug -ldflags='$(GO_LDFLAGS)' -stack-size=512kb ./pkg/wasm
wasm-opt -O3 $(O)/evy-unopt.wasm -o frontend/module/evy.wasm
cp -f $$(tinygo env TINYGOROOT)/targets/wasm_exec.js frontend/module/
echo '{ "version": "$(VERSION)" }' | jq > frontend/version.json
## Prepare frontend assets to be embedded into the binary
embed: build-tiny | $(O)
rm -rf $(O)/embed
go run ./build-tools/site-gen frontend $(O)/embed
## Tidy go modules with "go mod tidy"
tidy:
go mod tidy
## Format all go files with gofumpt, a stricter gofmt
fmt:
gofumpt -w $(GOFILES)
clean::
-rm -f frontend/module/evy.wasm
-rm -f frontend/module/wasm_exec.js
-rm -f frontend/version.json
.PHONY: build-full build-go build-tiny embed go-version install install-full tidy
# --- Test ---------------------------------------------------------------------
COVERFILE = $(O)/coverage.txt
LEARNCOVERFILE = $(O)/learn-coverage.txt
EXPORTDIR = $(O)/export-test
## Run non-tinygo tests and generate a coverage file
test-go: | $(O)
go test -coverprofile=$(COVERFILE) ./...
cd learn; go test -coverprofile=../$(LEARNCOVERFILE) ./...
## Test evy CLI
test-cli: build-full
rm -rf $(EXPORTDIR)
$(O)/evy serve export $(EXPORTDIR)
test -f $(EXPORTDIR)/index.html
test -f $(EXPORTDIR)/play/module/evy.wasm
test ! -L $(EXPORTDIR)/play/module/evy.wasm
## Run tinygo tests
test-tiny: go-version | $(O)
tinygo test ./...
## Check that test coverage meets the required level
check-coverage: test-go
@go tool cover -func=$(COVERFILE) | $(CHECK_COVERAGE) || $(FAIL_COVERAGE)
@go tool cover -func=$(LEARNCOVERFILE) | $(CHECK_COVERAGE) || $(FAIL_COVERAGE)
## Show test coverage in your browser
cover: test-go
go tool cover -html=$(COVERFILE)
CHECK_COVERAGE = awk -F '[ \t%]+' '/^total:/ {print; if ($$3 < $(COVERAGE)) exit 1}'
FAIL_COVERAGE = { echo '$(COLOR_RED)FAIL - Coverage below $(COVERAGE)%$(COLOR_NORMAL)'; exit 1; }
.PHONY: check-coverage cover test-cli test-go test-tiny
# --- Lint ---------------------------------------------------------------------
EVY_FILES = $(shell fd --type file --extension evy)
## Lint go source code
lint-go:
golangci-lint run
cd learn; golangci-lint run
## Format evy sample code
fmt-evy:
go run . fmt --write $(EVY_FILES)
check-fmt-evy:
go run . fmt --check $(EVY_FILES)
## Conform runs evy over an example suite with asserts.
conform: install
for n in examples/human-eval/*.evy; do \
printf "%s " "$${n##*/}"; \
evy run "$$n"; \
done
.PHONY: check-fmt-evy conform fmt-evy lint-go
# --- Docs ---------------------------------------------------------------------
doc: doctest godoc toc usage
DOCTEST_CMD = ./build-tools/doctest.awk $(md) > $(O)/out.md && mv $(O)/out.md $(md)
DOCTESTS = docs/builtins.md docs/spec.md docs/syntax-by-example.md
doctest: install
$(foreach md,$(DOCTESTS),$(DOCTEST_CMD)$(nl))
TOC_CMD = ./build-tools/toc.awk $(md) > $(O)/out.md && mv $(O)/out.md $(md)
TOCFILES = docs/builtins.md docs/spec.md
toc:
$(foreach md,$(TOCFILES),$(TOC_CMD)$(nl))
USAGE_CMD = ./build-tools/gencmd.awk $(md) > $(O)/out.md && mv $(O)/out.md $(md)
USAGEFILES = docs/usage.md
usage: install
$(foreach md,$(USAGEFILES),$(USAGE_CMD)$(nl))
GODOC_CMD = ./build-tools/gengodoc.awk $(filename) > $(O)/out.go && mv $(O)/out.go $(filename)
GODOCFILES = main.go learn/cmd/levy/main.go
godoc: install
$(foreach filename,$(GODOCFILES),$(GODOC_CMD)$(nl))
DOCS_TARGET_DIR = frontend/docs
LEARN_TARGET_DIR = frontend/learn
LAB_TARGET_DIR = frontend/lab
## Generate static HTML documentation in frontend/docs from MarkDown in docs
docs: | $(NODELIB)
go run ./build-tools/docsite-gen docs $(DOCS_TARGET_DIR)
$(PRETTIER) --write $(DOCS_TARGET_DIR)
## Generate static HTML for learn.evy.dev in frontend/learn from MarkDown in learn/content
learn: install | $(NODELIB)
levy export html --no-self-contained --root-dir="/learn/" learn/content $(LEARN_TARGET_DIR)
$(PRETTIER) --write $(LEARN_TARGET_DIR)
LAB_SVG_SRC := $(shell fd --full-path --glob '**/img/*.evy' $(LAB_TARGET_DIR))
LAB_SVG := $(LAB_SVG_SRC:%.evy=%.svg)
LAB_HTMLF_SRC := $(shell fd --full-path --extension md $(LAB_TARGET_DIR))
LAB_HTMLF := $(LAB_HTMLF_SRC:%.md=%.htmlf)
## Generate SVG files from .evy files for lab.evy.dev in frontend/lab
lab: $(LAB_SVG) $(LAB_HTMLF)
%.svg: %.evy | $(NODELIB)
go run . run --svg-out "$@" "$<"
$(PRETTIER) --write "$@"
%.htmlf: %.md | $(NODELIB)
go run ./build-tools/labsite-gen "$<" "$@"
$(PRETTIER) --write "$@"
FIND_GENERATED_CMD = fd --exclude '*.css' --exclude '*.js' --type file --full-path
clean::
$(FIND_GENERATED_CMD) frontend/docs --exec rm
$(FIND_GENERATED_CMD) frontend/learn --exec rm
rm -f $(LAB_SVG)
$(foreach file,$(LAB_MDFILES),rm -f "$(file:md=htmlf)"$(nl))
test-urls:
! grep -rIioEh 'https?://[^[:space:]]+' --include "*.md" --exclude-dir "node_modules" --exclude-dir "bin" | \
sort -u | \
xargs -n1 curl -sL -o /dev/null -w "%{http_code} %{url}\n" | \
grep -v '^200 '
.PHONY: doc docs doctest godoc lab learn sdocs test-urls toc usage
# --- frontend -----------------------------------------------------------------
NODEPREFIX = .hermit/node
NODELIB = $(NODEPREFIX)/lib
define PLAYWRIGHT_CMD_LOCAL
npm --prefix e2e ci > /dev/null
npx --prefix e2e playwright test --config e2e $(PLAYWRIGHT_ARGS)
endef
PLAYWRIGHT_OCI_IMAGE = mcr.microsoft.com/playwright:v1.46.1-jammy
PLAYWRIGHT_CMD_DOCKER = docker run --rm \
--volume $$(pwd):/work/ -w /work/ \
--user $(shell id -u):$(shell id -g) \
--network host --add-host=host.docker.internal:host-gateway \
--env BASEURL=$(BASEURL) \
--env NPM_CONFIG_UPDATE_NOTIFIER=false \
--env PLATFORM_OVERRIDE=docker \
--env HOME=/tmp \
$(PLAYWRIGHT_OCI_IMAGE) /bin/bash -e -c "$(subst $(nl),;,$(PLAYWRIGHT_CMD_LOCAL))"
PLAYWRIGHT_CMD = $(PLAYWRIGHT_CMD_$(if $(USE_DOCKER),DOCKER,LOCAL))
# BASEURL needs to be in the environment so that `e2e/playwright.config.js`
# can see it when the `e2e` target is called.
# The firebase-deploy script sets BASEURL to the deployment URL on GitHub CI.
SERVEDIR_HOST = $(if $(USE_DOCKER),host.docker.internal,localhost)
export SERVEDIR_PORT ?= 8080
export BASEURL ?= http://$(SERVEDIR_HOST):$(SERVEDIR_PORT)
## Serve frontend on port 8080 by default to work with e2e target
serve:
servedir frontend
## Format code with prettier
prettier: | $(NODELIB)
$(PRETTIER) --write .
## Ensure code is formatted with prettier
check-prettier: | $(NODELIB)
$(PRETTIER) --check .
## Fix CSS files with stylelint
style: | $(NODELIB)
npm --prefix $(NODEPREFIX) ci
npx --prefix $(NODEPREFIX) stylelint -c $(NODEPREFIX)/.stylelintrc.json --fix frontend/**/*.css
## Lint CSS files with stylelint
check-style: | $(NODELIB)
npm --prefix $(NODEPREFIX) ci
npx --prefix $(NODEPREFIX) stylelint -c $(NODEPREFIX)/.stylelintrc.json frontend/**/*.css
## Install playwright on host system for `e2e` to use.
install-playwright:
npx --prefix e2e playwright install --with-deps chromium
## Run playwright locally, or in docker if run with `make USE_DOCKER=1 ...`
run-playwright:
@echo "running playwright against $(BASEURL)"
$(PLAYWRIGHT_CMD)
## Run end-to-end tests with playwright (see run-playwright)
e2e: run-playwright
## Run end-to-end tests and list failed snapshot test image files.
e2e-diff: PLAYWRIGHT_ARGS = --reporter json
e2e-diff:
$(PLAYWRIGHT_CMD) | \
jq -r '.suites[].suites.[]?.specs[].tests[].results[].attachments?.[].path'
## Make end-to-end testing golden screenshots with playwright (see run-playwright)
snaps: PLAYWRIGHT_ARGS = --update-snapshots
snaps: run-playwright
$(NODELIB):
@mkdir -p $@
.PHONY: check-prettier e2e prettier serve
# --- deploy -----------------------------------------------------------------
CHANNEL = live
ENV = test
## Deploy to firebase ENV on CHANNEL. ENV: test (default), stage, prod. CHANNEL live (default), ...
deploy: build-tiny
# Empty channel becomes to "dev" locally.
# Empty channel becomes PR-NUM or "live" on CI.
./build-tools/firebase-deploy $(ENV) $(CHANNEL)
.PHONY: deploy
# --- scripts ------------------------------------------------------------------
SCRIPTS = build-tools/firebase-deploy .github/scripts/app_token
## Lint script files with shellcheck and shfmt
lint-sh:
shellcheck $(SCRIPTS)
shfmt --diff $(SCRIPTS)
## Format script files
fmt-sh:
shfmt --write $(SCRIPTS)
.PHONY: fmt-sh lint-sh
# --- Release -------------------------------------------------------------------
## Tag and release binaries for different OS on GitHub release
# We need to run embed first to generate the full website including evy.wasm
# for embedding in the go binary. goreleaser build hooks cannot be used as
# they run in parallel for each os/arch and cause a race condition.
release: nexttag embed
git tag $(NEXTTAG)
git push origin $(NEXTTAG)
[ -z "$(CI)" ] || GITHUB_TOKEN=$$(.github/scripts/app_token) || exit 1; \
goreleaser release --clean $(if $(RELNOTES),--release-header=$(RELNOTES))
nexttag:
$(eval NEXTTAG := $(shell $(NEXTTAG_CMD)))
$(eval RELNOTES := $(wildcard docs/release-notes/$(NEXTTAG).md))
.PHONY: nexttag release
define NEXTTAG_CMD
{
{ git tag --list --merged HEAD --sort=-v:refname; echo v0.0.0; }
| grep -E "^v?[0-9]+\.[0-9]+\.[0-9]+$$"
| head -n 1
| awk -F . '{ print $$1 "." $$2 "." $$3 + 1 }';
git diff --name-only @^ | sed -E -n 's|^docs/release-notes/(v[0-9]+\.[0-9]+\.[0-9]+)\.md$$|\1|p';
} | sort --reverse --version-sort | head -n 1
endef
# --- Utilities ----------------------------------------------------------------
COLOR_NORMAL = $(shell tput sgr0 2>/dev/null)
COLOR_RED = $(shell tput setaf 1 2>/dev/null)
COLOR_GREEN = $(shell tput setaf 2 2>/dev/null)
COLOR_WHITE = $(shell tput setaf 7 2>/dev/null)
help:
$(eval export HELP_AWK)
@awk "$${HELP_AWK}" $(MAKEFILE_LIST) | sort | column -s "$$(printf \\t)" -t
$(O):
@mkdir -p $@
.PHONY: help
# Awk script to extract and print target descriptions for `make help`.
define HELP_AWK
/^## / { desc = desc substr($$0, 3) }
/^[A-Za-z0-9%_-]+:/ && desc {
sub(/::?$$/, "", $$1)
printf "$(COLOR_WHITE)%s$(COLOR_NORMAL)\t%s\n", $$1, desc
desc = ""
}
endef
define nl
endef
ifndef ACTIVE_HERMIT
$(eval $(subst \n,$(nl),$(shell bin/hermit env -r | sed 's/^\(.*\)$$/export \1\\n/')))
endif
# Ensure make version is gnu make 3.82 or higher
ifeq ($(filter undefine,$(value .FEATURES)),)
$(error Unsupported Make version. \
$(nl)Use GNU Make 3.82 or higher (current: $(MAKE_VERSION)). \
$(nl)Activate 🐚 hermit with `. bin/activate-hermit` and run again \
$(nl)or use `bin/make`)
endif