1 Commits
Author SHA1 Message Date
sneak 370fad06fc Rewrite TODO.md sentence by sentence
check / check (push) Canceled after 0s
Rewritten from scratch against the code on next; the sections and
their contents are kept.

Model: fable-5-1
2026-10-25 05:18:45 +00:00
13 changed files with 3489 additions and 664 deletions
+3 -1
View File
@@ -72,8 +72,10 @@
**/*.sublime-* **/*.sublime-*
# This repository's own host-built artifacts: the binary `make build` # This repository's own host-built artifacts: the binary `make build`
# writes. # writes, and the Alpine.js file `make assets` extracts from 3p/ (the
# build extracts its own).
/bin /bin
/static/js/alpine.min.js
# SQLite databases, which hold the session key and webhook payloads, at # SQLite databases, which hold the session key and webhook payloads, at
# any depth. # any depth.
+4
View File
@@ -77,3 +77,7 @@ data/
# Temporary files # Temporary files
tmp/ tmp/
temp/ temp/
# Alpine.js, extracted by `make assets` from its tarball in 3p/, which is
# what is committed.
/static/js/alpine.min.js
-1
View File
@@ -1,3 +1,2 @@
node_modules/ node_modules/
yarn.lock yarn.lock
static/js/alpine.min.js
Binary file not shown.
+11 -2
View File
@@ -92,6 +92,10 @@ COPY . .
# fmt-check` is the markdown-check stage above. # fmt-check` is the markdown-check stage above.
RUN if [ -n "$(gofmt -s -l .)" ]; then echo "gofmt needed on:"; gofmt -s -l .; exit 1; fi RUN if [ -n "$(gofmt -s -l .)" ]; then echo "gofmt needed on:"; gofmt -s -l .; exit 1; fi
# static/static.go embeds the Alpine.js file this extracts from 3p/; without
# it the static package does not compile and cannot be linted.
RUN script/assets
# The golangci-lint steps run with --network=none. `golangci-lint config # The golangci-lint steps run with --network=none. `golangci-lint config
# verify` is documented as fetching its JSON schema over HTTPS; this pinned # verify` is documented as fetching its JSON schema over HTTPS; this pinned
# image resolves the schema without any network, and --network=none enforces # image resolves the schema without any network, and --network=none enforces
@@ -126,6 +130,9 @@ RUN go mod download
COPY . . COPY . .
# static/static.go embeds the Alpine.js file this extracts from 3p/.
RUN script/assets
# -timeout applies to each package on its own, so 90s has only to clear the # -timeout applies to each package on its own, so 90s has only to clear the
# slowest one. -p 4 -parallel 8 keep the run under 2 GB of memory: at most # slowest one. -p 4 -parallel 8 keep the run under 2 GB of memory: at most
# four test binaries build or run at once, each with at most eight parallel # four test binaries build or run at once, each with at most eight parallel
@@ -204,8 +211,10 @@ RUN version="$(make version VERSION="$VERSION")"; \
esac; \ esac; \
fi fi
# The Makefile's build target builds with cgo off, so the binary is # Builds through the Makefile's build target, which runs script/assets
# statically linked and runs on the Alpine runtime image below. # (Alpine.js, extracted from its tarball in 3p/) first. The target builds
# with cgo off, so the binary is statically linked and runs on the Alpine
# runtime image below as it is.
RUN make build VERSION="$VERSION" RUN make build VERSION="$VERSION"
# Runtime stage # Runtime stage
+1 -1
View File
@@ -17,7 +17,7 @@ COPY . .
# The test binary embeds the templates and static files, so the browser # The test binary embeds the templates and static files, so the browser
# stage needs nothing else. It is built with cgo off and -p 4 keeps the # stage needs nothing else. It is built with cgo off and -p 4 keeps the
# compile's memory down, both as in the test phase of Dockerfile. # compile's memory down, both as in the test phase of Dockerfile.
RUN CGO_ENABLED=0 go test -c -p 4 -tags browser -o /browser.test ./internal/server RUN make assets && CGO_ENABLED=0 go test -c -p 4 -tags browser -o /browser.test ./internal/server
# chromedp/headless-shell:151.0.7922.109 (Debian trixie), 2026-08-11. The # chromedp/headless-shell:151.0.7922.109 (Debian trixie), 2026-08-11. The
# browser is on PATH as headless-shell, where the test's browser library # browser is on PATH as headless-shell, where the test's browser library
+6 -3
View File
@@ -1,4 +1,4 @@
.PHONY: bootstrap setup test test-browser lint fmt fmt-check check build run dev deps docker clean hooks css css-check version .PHONY: bootstrap setup assets test test-browser lint fmt fmt-check check build run dev deps docker clean hooks css css-check version
# Default target # Default target
.DEFAULT_GOAL := check .DEFAULT_GOAL := check
@@ -22,6 +22,9 @@ bootstrap:
setup: setup:
@script/setup @script/setup
assets:
@script/assets
test: test:
@script/test @script/test
@@ -44,13 +47,13 @@ check:
# REPO_POLICIES.md does: the binary carries no build paths, symbol table or # REPO_POLICIES.md does: the binary carries no build paths, symbol table or
# debug information, and on Linux, the image's included, it is statically # debug information, and on Linux, the image's included, it is statically
# linked. # linked.
build: build: assets
CGO_ENABLED=0 go build -trimpath -ldflags '-s -w -X main.version=$(VERSION)' -o bin/webhooker ./cmd/webhooker CGO_ENABLED=0 go build -trimpath -ldflags '-s -w -X main.version=$(VERSION)' -o bin/webhooker ./cmd/webhooker
run: build run: build
./bin/webhooker ./bin/webhooker
dev: dev: assets
go run ./cmd/webhooker go run ./cmd/webhooker
deps: deps:
+3440 -639
View File
File diff suppressed because it is too large Load Diff
+1 -1
View File
@@ -5,7 +5,7 @@
// REPO_POLICIES.md states that a linter can check: const for everything, // REPO_POLICIES.md states that a linter can check: const for everything,
// let only for a variable that is reassigned, never var. // let only for a variable that is reassigned, never var.
export default [ export default [
// Alpine.js, committed as published; not ours to lint. // Alpine.js, extracted from 3p/ by make assets; not ours to lint.
{ ignores: ["static/js/alpine.min.js"] }, { ignores: ["static/js/alpine.min.js"] },
{ {
// The pages load static/js/app.js as a classic script, not a module. // The pages load static/js/app.js as a classic script, not a module.
+3
View File
@@ -13,6 +13,9 @@ import (
// TestBaseTemplateScriptsAreServed walks every /s/ script the base // TestBaseTemplateScriptsAreServed walks every /s/ script the base
// template loads on each page and fetches it through the real router. // template loads on each page and fetches it through the real router.
// Alpine.js is extracted from its tarball in 3p/ at build time, so the
// file is not in the tree: this is the check that the page still gets
// the JavaScript it asks for.
func TestBaseTemplateScriptsAreServed(t *testing.T) { func TestBaseTemplateScriptsAreServed(t *testing.T) {
t.Parallel() t.Parallel()
Executable
+17
View File
@@ -0,0 +1,17 @@
#!/bin/sh
# script/assets: extract Alpine.js from its npm package tarball, committed
# in 3p/, to static/js/alpine.min.js, where go:embed reads it. The package
# is @alpinejs/csp, Alpine's build for pages whose Content-Security-Policy
# forbids eval. The extracted file is not committed. make build, make dev
# and the Dockerfile's lint, test and build stages run this first.
set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
main() {
cd "$ROOT"
tar -xzOf 3p/alpinejs-csp-3.14.9.tgz package/dist/cdn.min.js \
>static/js/alpine.min.js
}
main "$@"
-11
View File
File diff suppressed because one or more lines are too long
+3 -5
View File
@@ -6,11 +6,9 @@ import (
) )
// Static holds the CSS and JavaScript files the web UI's pages load. They // Static holds the CSS and JavaScript files the web UI's pages load. They
// are named one by one, so a missing file fails the build instead of // are named one by one so that a missing js/alpine.min.js, which make
// leaving the pages without it. // assets extracts and git does not track, fails the build instead of
// // leaving the pages without Alpine.js.
// js/alpine.min.js is Alpine.js, committed unchanged. It is
// package/dist/cdn.min.js from the npm package @alpinejs/csp 3.14.9.
// //
//go:embed css/tailwind.css css/style.css js/app.js js/alpine.min.js //go:embed css/tailwind.css css/style.css js/app.js js/alpine.min.js
var Static embed.FS var Static embed.FS