Author SHA1 Message Date
end 927594b567 test(page): cover tied foreign-tenant seek row
Documentation / docs (pull_request) Successful in 22s
ci / postgres (pull_request) Failing after 34s
ci / check (pull_request) Successful in 3m19s
2026-10-27 12:59:42 -07:00
end 8615d8ca66 feat(page): add typed keyset pagination for Bob
Add versioned typed cursors, composable native query mods, bidirectional page assembly and opt-in authorized counts. Cover SQLite and PostgreSQL outcomes, strict cursor boundaries and a runnable example; require PostgreSQL service tests in CI.

Refs: #6
2026-10-27 12:55:23 -07:00
end da1ff94fe2 docs(page): compact proposed cursor wire format 2026-10-27 12:28:25 -07:00
end 2318c4fa39 docs(page): clarify cursor size and timestamp encoding 2026-10-27 11:55:43 -07:00
end ea5d57f626 docs(page): propose tagged cursor format and plain sort key API 2026-10-27 11:51:01 -07:00
end 46c4416ed4 docs: establish module versioning boundaries (#4)
Documentation / docs (push) Successful in 15s
Record the accepted rule for root-module versions and nested modules
for heavy dependencies or independent releases. Update repository
instructions and link implementation evidence to the ADR.

Closes #2
2026-10-26 21:45:06 -07:00
end 7d36785649 chore: adopt Corestack project standards
Documentation / docs (push) Successful in 17s
ci / check (push) Successful in 58s
Adopt ADRs-only documentation policy, compact base and Go rules, comment lint and TODO checks.

Always validate records with the local docs checker. Skip implementation CI for root Markdown and docs-only changes while retaining coverage for embedded templates and future modules.
2026-10-25 14:39:58 -07:00
endandClaude Opus 5.5 cc482d9a9b feat: add docs checker for ADRs and implementation plans (#1)
release / release (push) Successful in 17s
ci / check (push) Successful in 18s
Add cmd/docs, the first corestack component: `docs new adr|plan "Title"`
writes records from embedded templates, and `docs check` validates them
against the public format spec in docs/docs-format.md (timestamp IDs,
frontmatter keys and enums, separate decision and implementation status,
supersession symmetry, MADR 4 layout with required Consequences, plan
sections, and repo-root/durable references), reporting path:line errors.

Also adds the module skeleton (go.auvem.com/corestack, BSD-3-Clause,
README, AGENTS.md, CLAUDE.md), Gitea CI running tests and docs check,
a tag-triggered goreleaser release for darwin/linux binaries, and the
accepted ADR adopting the format.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-23 15:56:03 -07:00
38 changed files with 3849 additions and 0 deletions

No files matched your search

+63
View File
@@ -0,0 +1,63 @@
name: ci
on:
push:
branches: [main]
paths-ignore:
# Keep embedded Markdown templates in CI; paths-ignore cannot undo a match.
- "*.md"
- "docs/**"
pull_request:
paths-ignore:
- "*.md"
- "docs/**"
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7.0.1
with:
fetch-depth: 0
- uses: actions/setup-go@v7.0.0
with:
go-version-file: go.mod
- name: gofmt
run: test -z "$(gofmt -l .)"
- run: go vet ./...
- run: go test -race ./...
- name: Require issue URLs in TODO comments
run: |
find . -type d \( -name .git -o -name node_modules -o -name vendor -o -name generated -o -name gen -o -name target -o -name dist -o -name build -o -name .svelte-kit -o -name .next \) -prune -o -type f \( -name '*.go' -o -name '*.ts' -o -name '*.tsx' -o -name '*.js' -o -name '*.svelte' -o -name '*.rs' -o -name '*.sql' -o -name '*.sh' -o -name '*.proto' -o -name '*.graphql' -o -name '*.yml' -o -name '*.yaml' -o -name '*.toml' \) -exec awk 'match($0, "((^|[^:])[/][/]|[/][*]|(^|[[:space:]])(#|--)|^[[:space:]]*([*]|<!--))") { comment=substr($0, RSTART + RLENGTH); todo=index(comment, "TO" "DO"); if (todo && substr(comment, todo + 4) !~ "https?:[/][/]") { print FILENAME ":" FNR ":" $0; bad=1 } } END { exit bad }' {} + # shortcut: line-based scan can flag comment-like strings and misses multiline issue links, use a parser when these need accurate coverage
- name: Go lint
run: go run github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.15.0 run ./...
- uses: goreleaser/goreleaser-action@v7.3.0
with:
distribution: goreleaser
version: v2.19.0
args: check
- uses: goreleaser/goreleaser-action@v7.3.0
with:
distribution: goreleaser
version: v2.19.0
args: release --snapshot --clean
postgres:
runs-on: ubuntu-latest
container: golang:1.27.1
services:
postgres:
image: postgres:17-alpine
env:
POSTGRES_PASSWORD: page-test
POSTGRES_DB: page_test
options: >-
--health-cmd "pg_isready -U postgres -d page_test"
--health-interval 5s
--health-timeout 5s
--health-retries 12
env:
PAGE_POSTGRES_DSN: postgres://postgres:page-test@postgres:5432/page_test?sslmode=disable
PAGE_REQUIRE_POSTGRES: "1"
steps:
- uses: actions/checkout@v7.0.1
- run: go test -race ./page
+15
View File
@@ -0,0 +1,15 @@
name: Documentation
on:
push:
branches: [main]
pull_request:
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7.0.1
- uses: actions/setup-go@v7.0.0
with:
go-version-file: go.mod
cache: false
- run: go run ./cmd/docs check
+29
View File
@@ -0,0 +1,29 @@
name: release
on:
push:
tags:
- "v*"
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7.0.1
with:
fetch-depth: 0
- uses: actions/setup-go@v7.0.0
with:
go-version-file: go.mod
- name: Require issue URLs in TODO comments
run: |
find . -type d \( -name .git -o -name node_modules -o -name vendor -o -name generated -o -name gen -o -name target -o -name dist -o -name build -o -name .svelte-kit -o -name .next \) -prune -o -type f \( -name '*.go' -o -name '*.ts' -o -name '*.tsx' -o -name '*.js' -o -name '*.svelte' -o -name '*.rs' -o -name '*.sql' -o -name '*.sh' -o -name '*.proto' -o -name '*.graphql' -o -name '*.yml' -o -name '*.yaml' -o -name '*.toml' \) -exec awk 'match($0, "((^|[^:])[/][/]|[/][*]|(^|[[:space:]])(#|--)|^[[:space:]]*([*]|<!--))") { comment=substr($0, RSTART + RLENGTH); todo=index(comment, "TO" "DO"); if (todo && substr(comment, todo + 4) !~ "https?:[/][/]") { print FILENAME ":" FNR ":" $0; bad=1 } } END { exit bad }' {} + # shortcut: line-based scan can flag comment-like strings and misses multiline issue links, use a parser when these need accurate coverage
- uses: goreleaser/goreleaser-action@v7.3.0
with:
distribution: goreleaser
version: v2.19.0
args: release --clean
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
# goreleaser fails on more than one token; an empty value counts as unset.
GITHUB_TOKEN: ""
+1
View File
@@ -0,0 +1 @@
dist/
+12
View File
@@ -0,0 +1,12 @@
version: "2"
linters:
default: none
enable:
- revive
settings:
revive:
rules:
- name: exported
- name: package-comments
exclusions:
presets: []
+29
View File
@@ -0,0 +1,29 @@
version: 2
project_name: docs
builds:
- id: docs
main: ./cmd/docs
binary: docs
env:
- CGO_ENABLED=0
goos: [darwin, linux]
goarch: [amd64, arm64]
flags: [-trimpath]
ldflags: [-s -w]
archives:
- formats: [tar.gz]
name_template: "docs_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
checksum:
name_template: checksums.txt
gitea_urls:
api: https://gitea.auvem.com/api/v1
download: https://gitea.auvem.com
release:
gitea:
owner: corestack
name: go
+51
View File
@@ -0,0 +1,51 @@
# AGENTS.md
## Commands
- Check: `go build ./...`, `go vet ./...`, `go test -race ./...`, `go run github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.15.0 run ./...`; from the project root, run the TODO check below.
- Generate: No code generation is configured; format with `gofmt -w .`.
- Documentation: `go run ./cmd/docs check`; create records with `go run ./cmd/docs new adr|plan "Title"`. This checker repository uses its local implementation as the source of truth.
## Scope and decisions
- Before editing under a directory with its own AGENTS.md, read it. Scoped files: none currently; this root governs the repository, including nested Go modules unless nearer instructions override it.
- Explicit user instructions win; nearer scoped rules override broader rules.
- Distinguish confirmed requirements, proposed defaults and unresolved decisions; resolve material ambiguity before dependent work.
- Proposed ADRs are context, not authority; read relevant accepted decisions before changing their scope.
- Before final review and merge, reconcile affected records against the latest target branch plus the PR, following [/docs/adr/README.md](/docs/adr/README.md).
- Documentation tier: ADRs only. Create a plan only when work needs durable execution context across areas, phases or sessions; then enable the plans tier.
- In a sandbox, request required network/cache access before first codegen; on permission/cache errors retry once with that access. Never hand-edit generated output.
- Shared databases and ports may belong to other worktrees/agents; read project rules before starting, stopping or resetting them.
- Ask before lint/autofix changes that could alter runtime behavior.
- Report commands actually run and their results; never claim an unrun check passed.
- Name branches `<type>/<kebab>` without agent-name prefixes.
## Comments
- Document package/module purpose, ownership and boundaries, and every public/exported contract in native doc comments; document generated surfaces at their source.
- Explain why at invariants, auth decisions, concurrency/ordering, destructive edges and deliberate deviations; no narration, changelog comments or commented-out code.
- Use `invariant: <property>`, `authz: <who and enforcement>`, `shortcut: <limit>, <when to upgrade>` on relevant code; retain Go `Deprecated:` and Rust `// SAFETY:`.
- Every TODO needs an issue URL; reviewers recheck tagged comments on touched code.
## Project map
Go module `go.auvem.com/corestack`.
- Docs format (the spec `docs check` implements): `docs/docs-format.md`.
- Decisions live in `docs/adr/`, plans in `docs/plans/`. Records are permanent; never rename them.
- Add dependencies only to the module that needs them; heavy dependencies go in nested modules (see the [module-boundary ADR](/docs/adr/20261025T214616275Z-version-light-core-packages-in-the-root-module-and-nest-heavy-dependency-modules.md)).
## Go
- Default backend language is Go; follow existing package boundaries.
- Define interfaces at the consumer only when a second implementation or a test seam needs one.
- Wrap contextual errors with `%w`; inspect causes with `errors.Is`/`errors.As`.
- Do not add package-level mutable state or `init` side effects.
- Put `context.Context` first in parameters; never store it in a struct.
- Give every goroutine an owner and a shutdown path.
- Run `gofmt`, `go vet ./...`, tests and the project's configured linter from the owning module.
- Use `.golangci.yml` (revive exported/package-comments); the pinned linter command is listed above.
## TODO check
Run from the project root (also enforced in CI):
```sh
find . -type d \( -name .git -o -name node_modules -o -name vendor -o -name generated -o -name gen -o -name target -o -name dist -o -name build -o -name .svelte-kit -o -name .next \) -prune -o -type f \( -name '*.go' -o -name '*.ts' -o -name '*.tsx' -o -name '*.js' -o -name '*.svelte' -o -name '*.rs' -o -name '*.sql' -o -name '*.sh' -o -name '*.proto' -o -name '*.graphql' -o -name '*.yml' -o -name '*.yaml' -o -name '*.toml' \) -exec awk 'match($0, "((^|[^:])[/][/]|[/][*]|(^|[[:space:]])(#|--)|^[[:space:]]*([*]|<!--))") { comment=substr($0, RSTART + RLENGTH); todo=index(comment, "TO" "DO"); if (todo && substr(comment, todo + 4) !~ "https?:[/][/]") { print FILENAME ":" FNR ":" $0; bad=1 } } END { exit bad }' {} + # shortcut: line-based scan can flag comment-like strings and misses multiline issue links, use a parser when these need accurate coverage
```
+1
View File
@@ -0,0 +1 @@
See [AGENTS.md](AGENTS.md).
+28
View File
@@ -0,0 +1,28 @@
BSD 3-Clause License
Copyright (c) 2026, Elijah Duffy
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+41
View File
@@ -1 +1,42 @@
# corestack go
Shared Go building blocks. The first one is `docs`, a checker for architecture decision records (ADRs) and implementation plans.
## docs
Install:
```sh
go install go.auvem.com/corestack/cmd/docs@latest
```
Use, from a repository root:
```sh
docs new adr "Use Example Queue for background jobs" # creates docs/adr/<id>.md
docs new plan "Adopt Example Queue" # creates docs/plans/<id>.md
docs check [--root DIR] # prints path:line: message; exit 1 on problems
```
The format is specified in [docs/docs-format.md](docs/docs-format.md); that document is the complete rule set. Exit status is `0` when every record is valid, `1` when problems are reported and `2` for usage errors.
## page
[`page`](page/page.go) provides transport-neutral Bob keyset pagination with typed
items, mixed-direction sorts, opaque typed cursors, and a separate opt-in count.
Pass a trusted Sort and a typed row key in the same column order; sort columns
must be non-null and end in a unique column. See the [runnable example](page/example_test.go)
and [cursor decision](docs/adr/20261027T184351001Z-preserve-typed-sort-values-in-versioned-page-cursors.md).
SQLite runs in-process in the normal test suite (requires CGO). PostgreSQL runs in
CI; locally set `PAGE_POSTGRES_DSN` to an isolated test database to run the same
flow. Set `PAGE_REQUIRE_POSTGRES=1` to fail rather than skip when the DSN is absent.
MySQL mod composition compiles; its runtime behavior has not been verified.
## Status
No support is guaranteed. Breaking changes, including to the format rules, may happen before 1.0 and are listed in the release notes.
## License
BSD-3-Clause, see [LICENSE](LICENSE).
+66
View File
@@ -0,0 +1,66 @@
// Command docs creates and checks ADR and plan records. See docs/docs-format.md.
package main
import (
"flag"
"fmt"
"io"
"os"
"time"
"go.auvem.com/corestack/internal/docs"
)
const usage = `usage:
docs new adr|plan "Title"
docs check [--root DIR]
`
func main() { os.Exit(run(os.Args[1:], os.Stdout, os.Stderr, time.Now())) }
// run returns the exit status: 0 success, 1 problems or failure, 2 usage error.
func run(args []string, stdout, stderr io.Writer, now time.Time) int {
if len(args) == 0 {
fmt.Fprint(stderr, usage)
return 2
}
switch args[0] {
case "new":
if len(args) != 3 || (args[1] != "adr" && args[1] != "plan") {
fmt.Fprint(stderr, usage)
return 2
}
path, err := docs.New(".", args[1], args[2], now)
if err != nil {
fmt.Fprintf(stderr, "docs: %v\n", err)
return 1
}
fmt.Fprintln(stdout, path)
return 0
case "check":
fs := flag.NewFlagSet("docs check", flag.ContinueOnError)
fs.SetOutput(stderr)
root := fs.String("root", ".", "repository root")
if err := fs.Parse(args[1:]); err != nil || fs.NArg() != 0 {
if fs.NArg() != 0 {
fmt.Fprint(stderr, usage)
}
return 2
}
res, err := docs.Check(*root)
if err != nil {
fmt.Fprintf(stderr, "docs: %v\n", err)
return 1
}
for _, p := range res.Problems {
fmt.Fprintln(stdout, p)
}
if len(res.Problems) > 0 {
return 1
}
fmt.Fprintf(stdout, "ok: %d records checked\n", res.Records)
return 0
}
fmt.Fprint(stderr, usage)
return 2
}
+80
View File
@@ -0,0 +1,80 @@
package main
import (
"bytes"
"os"
"path/filepath"
"strings"
"testing"
"time"
)
var now = time.Date(2026, 10, 23, 20, 45, 12, 345_000_000, time.UTC)
func do(t *testing.T, args ...string) (code int, stdout, stderr string) {
t.Helper()
var out, errw bytes.Buffer
code = run(args, &out, &errw, now)
return code, out.String(), errw.String()
}
func TestCLI(t *testing.T) {
root := t.TempDir()
t.Chdir(root)
if code, out, _ := do(t, "check"); code != 0 || out != "ok: 0 records checked\n" {
t.Fatalf("empty check: %d %q", code, out)
}
code, out, _ := do(t, "new", "adr", "Use X")
if code != 0 || out != "docs/adr/20261023T204512345Z-use-x.md\n" {
t.Fatalf("new: %d %q", code, out)
}
code, out, _ = do(t, "check")
var want strings.Builder
for _, line := range []string{"6", "8", "20", "24", "28", "32"} { // numeric, not lexical, order
want.WriteString("docs/adr/20261023T204512345Z-use-x.md:" + line + ": unfinished placeholder {{docs:todo}}\n")
}
if code != 1 || out != want.String() {
t.Fatalf("check with markers: %d %q", code, out)
}
// --root checks another directory; the working directory is not used.
t.Chdir(t.TempDir())
if code, _, _ := do(t, "check", "--root", root); code != 1 {
t.Errorf("--root: %d", code)
}
if code, out, _ := do(t, "check"); code != 0 || !strings.HasPrefix(out, "ok: ") {
t.Errorf("cwd root: %d %q", code, out)
}
}
func TestCLIExitCodes(t *testing.T) {
t.Chdir(t.TempDir())
must := func(err error) {
t.Helper()
if err != nil {
t.Fatal(err)
}
}
must(os.MkdirAll("docs/adr", 0o755))
must(os.WriteFile(filepath.Join("docs", "adr", "bad.md"), nil, 0o644))
for _, tt := range []struct {
args []string
code int
}{
{nil, 2},
{[]string{"bogus"}, 2},
{[]string{"new"}, 2},
{[]string{"new", "adr"}, 2},
{[]string{"new", "note", "T"}, 2},
{[]string{"new", "adr", "T", "extra"}, 2},
{[]string{"new", "adr", "!!!"}, 1},
{[]string{"check", "--bogus"}, 2},
{[]string{"check", "extra"}, 2},
{[]string{"check", "--root", "missing-dir"}, 1},
{[]string{"check"}, 1}, // bad.md is not a valid name
} {
if code, _, stderr := do(t, tt.args...); code != tt.code {
t.Errorf("docs %v = %d, want %d (stderr %q)", tt.args, code, tt.code, stderr)
}
}
}
@@ -0,0 +1,82 @@
---
title: Adopt a checked format for ADRs and implementation plans
date: 2026-10-23
status: accepted
implementation: implemented
summary: Use one documented ADR and plan format, enforced by a shared Go CLI (docs check).
tags:
- documentation
- adr
- tooling
supersedes: []
superseded_by: []
related: []
tracking: []
implemented_by:
- https://gitea.auvem.com/corestack/go/pulls/1
---
# Adopt a checked format for ADRs and implementation plans
## Context and Problem Statement
We record architecture decisions as ADRs and track delivery work as implementation plans. Across our repositories, four independent implementations of this practice grew up: each had its own filename scheme, frontmatter keys, status vocabulary and checking script (or none). The same concept was spelled differently from repository to repository, cross-references were relative paths that broke when files moved, and "accepted" did not say whether anything had been built. Tooling and agents had to learn each variant, and fixes to one checker did not reach the others.
We need one format that people and tools can write without surprises, that separates *the decision* from *its delivery*, and that is verified mechanically so records do not rot. The format must be public and documented well enough that someone can write valid files from the specification alone.
## Decision Drivers
* One vocabulary and one layout everywhere, so a record means the same thing in every repository.
* Stable identity: a record's ID and path never change, so references stay valid.
* The decision status and the implementation status are tracked separately.
* Checks run locally and in CI with no service dependency.
* Low upkeep: one tool to maintain, not one per repository.
## Considered Options
* MADR 4 template plus generic Markdown and link linting.
* Keep a checking script per repository, converging informally.
* Extract and publish one existing checker.
* Define one format and implement one shared Go CLI that creates and checks records.
## Decision Outcome
Chosen option: "Define one format and implement one shared Go CLI that creates and checks records", because it is the only option that gives a single enforced vocabulary and identity scheme while keeping the checks free of service dependencies.
The format is specified in [docs-format](/docs/docs-format.md). It uses the MADR 4 layout, with `### Consequences` under Decision Outcome made mandatory, and adds the parts MADR leaves open: timestamp-based permanent IDs in filenames, a fixed frontmatter schema, a separate `implementation` field, reciprocal supersession, durable repo-root references, and a plan record with its own lifecycle. The CLI, `docs`, offers `docs new adr|plan` and `docs check`.
### Consequences
* Good, because the format has one specification, one checker and one set of error messages.
* Good, because records are validated, so dead links, missing sections and contradictory statuses fail CI instead of accumulating.
* Good, because the permanent ID survives title edits.
* Bad, because the format is ours: we own the specification and the tool, and breaking changes before 1.0 will require updating adopters.
* Neutral, because the check validates structure only; it cannot tell whether a decision is sound.
## Pros and Cons of the Options
### MADR 4 template plus generic Markdown and link linting
* Good, because it is a public, widely understood template and nothing custom is built.
* Bad, because MADR is a template with no checker of its own, and generic linters enforce no ID, status, supersession or reference rules.
### Keep a checking script per repository
* Good, because there is no new shared artifact and each team keeps full control.
* Bad, because the four existing variants already diverged; nothing stops further divergence.
* Bad, because each script is maintained, tested and fixed separately, and most repositories would simply not have one.
### Extract and publish one existing checker
* Good, because it is cheaper: an existing Go checker already handles timestamp IDs, exclusive creation and reciprocal supersession.
* Bad, because it has no plan record, no `implementation` field and no public specification, and it is tied to one repository's conventions.
### Define one format and implement one shared Go CLI that creates and checks records
* Good, because one specification and one implementation can be tested thoroughly and installed with `go install`.
* Good, because the same binary creates records, so new files start with the required structure.
* Bad, because we commit to maintaining a small public tool and a specification.
## More Information
MADR 4: https://adr.github.io/madr/. The specification is [docs-format](/docs/docs-format.md); the implementation lands in the same pull request that records this decision.
@@ -0,0 +1,51 @@
---
title: "Version light core packages in the root module and nest heavy-dependency modules"
date: 2026-10-25
status: accepted
implementation: implemented
summary: Keep light core packages on root-module versions and isolate heavy or independently versioned packages in nested modules from their first commit.
tags:
- modules
- versioning
supersedes: []
superseded_by: []
related: []
tracking:
- https://gitea.auvem.com/corestack/go/issues/2
implemented_by:
- https://gitea.auvem.com/corestack/go/pulls/4
---
# Version light core packages in the root module and nest heavy-dependency modules
## Context and Problem Statement
The repository currently has one Go module, `go.auvem.com/corestack`. A plain `vX.Y.Z` tag versions every package in that module together and triggers a release of the `docs` binary. Light core packages can share this version stream and one changelog per tag; packages with heavy dependencies or independent release needs benefit from their own module boundaries.
Carving a package out after it has shipped in the root module is the expensive case: older root versions still contain it, while the new nested module supplies the same import path. Consumers can encounter ambiguous imports until coordinated releases and dependency upgrades remove the overlap. Starting a package as a nested module from its first commit avoids that migration.
The fixed dependency list in AGENTS.md described only the docs checker. It would block the planned Bob and Goose dependencies for `page` and `migrate`; dependency placement needs a module-boundary rule instead of a repository-wide allowlist.
## Considered Options
* Keep every package in the root module: simplest releases, but couples heavy and independently versioned packages to core releases and makes later extraction costly.
* Give every package a nested module immediately: avoids later extraction, but adds module and release bookkeeping to light core packages that can share a version.
* Keep light core packages in the root module and start heavy or independently versioned packages as nested modules: retain simple core releases while avoiding the costly extraction case.
## Decision Outcome
Choose the mixed boundary: light core packages share the root module; heavy-dependency or independently versioned packages begin as nested modules.
* Root module, plain `v*` tags: `lifecycle`, `lifecycle/cli`, `migrate`, `page`, and `cmd/docs`. They share one version stream and one changelog per root tag. Before 1.0, breaking changes use minor version bumps.
* Nested modules from their first commit: `gql`, `connect`, and any future package that brings heavy dependencies, such as gqlgen or protobuf, or is likely to need independent versioning. Each has its own `go.mod` and directory-prefixed tags, for example `gql/v0.1.0` and `connect/v0.1.0`.
* Add dependencies only to the module that needs them. The named core packages remain in the root module; heavy dependencies belong in the relevant nested module.
* Keep `cmd/docs` in the root module. The [release workflow](/.gitea/workflows/release.yml) listens only for plain `v*` tags, and [GoReleaser](/.goreleaser.yaml) builds `./cmd/docs`, so only root-module tags publish binaries. Prefixed library tags never publish binaries.
This decision establishes the boundary before the planned packages are added. The rule is implemented in [AGENTS.md](/AGENTS.md), and the existing release configuration already follows it. Future packages apply the rule when introduced; no empty modules are needed.
### Consequences
* Light core packages retain coordinated versions and releases. Consumers do not compile dependencies of packages they do not import; module graph pruning helps limit the dependency graph they load.
* Heavy-dependency and independently versioned packages avoid overlapping ownership of an import path with older root-module versions.
* Each nested module needs its own dependency maintenance, checks, and prefixed release tags. That bookkeeping is reserved for packages that need the boundary.
* Root-module consumers share version bumps even when only another core package changes. Moving a shipped root package into a nested module later still requires coordinated releases and consumer upgrades.
@@ -0,0 +1,90 @@
---
title: Preserve supported value types in versioned page cursors
date: 2026-10-27
status: accepted
implementation: in-progress
summary: Pair a plain sort with a typed row key function and preserve supported concrete values with tagged cursors.
tags:
- pagination
- cursors
supersedes: []
superseded_by: []
related:
- /docs/adr/20261025T214616275Z-version-light-core-packages-in-the-root-module-and-nest-heavy-dependency-modules.md
tracking:
- https://gitea.auvem.com/corestack/go/issues/6
implemented_by: []
---
# Preserve supported value types in versioned page cursors
## Context and Problem Statement
[Issue 6](https://gitea.auvem.com/corestack/go/issues/6) requires transport-neutral, non-null keyset pagination through Bob query mods. Cursors may be retained by callers, so their format is a compatibility contract. The owner requires two plain query inputs: a Sort and a typed `func(T) []any` returning column values in sort order. No reflection, struct tags, field lookup or per-column getters may connect rows to columns. Future code generation may produce both values; v0 must work with handwritten values.
Type preservation here means retaining each supported concrete value across encoding/decoding and passing that value to Bob's argument binder. It does not mean statically proving the agreement between independent Sort and key values. JSON decoded into untagged `any` would lose integer precision and concrete types.
## Considered Options
* Plain Sort/key values with explicit tagged scalar encoding: meets the requested API and preserves a documented finite set without reflection.
* Untagged JSON decoded into `[]any`: smaller, but numbers become float64 and concrete type information disappears.
* Per-column generic extractors or caller-defined generic cursor tuples: can tie values to columns more strongly, but do not match the owner's chosen two-value API.
* Reflection, codec registration or arbitrary serialized Go objects: broadens the supported set at the cost of machinery and compatibility obligations not needed for v0.
## Decision Outcome
Use plain Sort/key inputs with tagged JSON, wrapped in unpadded base64url (`base64.RawURLEncoding`). The owner accepted this reviewed design on 2026-10-27, including the two-input API and continuation flags. Implementation is present in the working branch; delivery remains in progress pending independent implementation review and a real PR. No PR delivery evidence is recorded yet.
Sort contains a stable caller-owned ID and an ordered list of columns, each with a Bob expression, direction and unique marker. Reject empty sorts, a missing or invalid UTF-8 Sort ID, nil expressions, invalid directions and a missing unique marker on the final column. Columns have no redundant ID field. The marker asserts that column alone is unique in the selected relation under database collation/comparison semantics, including joins. The library cannot prove schema truth. Composite-only uniqueness is outside the issue's final unique-column contract. Expressions and IDs come from trusted application declarations, never cursor-controlled SQL. The sort ID identifies the full immutable interpretation: ordered expressions, directions, key types, uniqueness and comparison semantics. Changing any of these requires a new ID. The backend selects the expected trusted Sort for the query; a decoded token ID must equal its ID. There is no global registry, descriptor fallback or hash subsystem. Local column metadata remains available for validation and query generation; it is not repeated on the wire.
A typed key function returns values in exactly that order. Check `len(key(row)) == len(sort.Columns)` for every returned row used to assemble a page, including the fetched extra row. A mismatch returns a clear programmer-error `KeyError` with expected/actual lengths; never truncate, zip a prefix or emit a bad cursor. Reject nil key functions. Column/value correspondence remains an explicit caller contract; no field discovery or hidden mapping is introduced.
Cursor v1 contains only version, sort ID and ordered typed values. Each value is exactly a two-element `[typeTag,payloadString]` array. Example decoded JSON:
```json
{"v":1,"sort":"orders/recent/v1","values":[["time","2026-10-27T12:00:00Z"],["int64","9007199254740993"]]}
```
For this exact example, compact JSON is 105 bytes and its unpadded base64url token is 140 bytes; the prior descriptor/object format was 242 and 323 bytes respectively. All tags and payloads are strings. Fixed type tags distinguish `int`, `int8`, `int16`, `int32`, `int64`, `string`, `time` and `uuid`. A type switch encodes exactly these concrete Go types; a fixed switch reconstructs them using range-checked integer parsing, valid UTF-8 strings, `time.Time` via RFC3339Nano, and standard-library `uuid.UUID` via canonical lowercase dashed text. Integer decimal text is canonical and never passes through float64. `int` must fit the consuming platform. Normalize timestamps to UTC before RFC3339Nano encoding, preserving the instant and nanoseconds, not monotonic metadata or named timezone identity; reject years unrepresentable in RFC3339 with a typed `ValueError`. Reject invalid UTF-8 rather than silently replacing bytes.
UUID support specifically means Go 1.27.1's standard `uuid.UUID`: its Parse/String methods support this representation and database/sql's default converter converts it to a string for drivers. Third-party UUID types require explicit caller conversion to this type. Named user-defined scalar types, unsigned integers, floats, booleans, pointers, nullable wrappers, byte slices and arbitrary custom types return a typed `ValueError`; no reflection, implicit coercion, custom binder or registry is proposed. A true Go type alias retains its underlying supported identity. Additional types require an explicit format/support decision. V0 sort columns must be non-null and ordered consistently by WHERE and ORDER BY; callers extract actual stored/scanned values, including timestamp precision.
Apply the same maximum of 16 KiB (16,384 bytes) to both emitted and received tokens, measured after final unpadded base64url encoding, including the full envelope. Check received token bytes before decoding, and decode before constructing a mod. Encoding a key or envelope that cannot fit returns a typed `CursorError` and no partial Page. Reject bad base64/JSON, unknown/duplicate/missing envelope fields (only `v`, `sort` and `values` are allowed, so `columns` is rejected), trailing data, version mismatch, a sort ID unequal to the expected Sort ID, wrong value count, nulls, non-array value entries, pairs of any arity other than two, non-string tags/payloads, unknown tags and invalid/range-overflowing payloads. The outer `values` array must contain exactly `len(sort.Columns)` pairs; the former type/value objects are rejected. An exported `CursorError`, inspectable with `errors.As`, distinguishes malformed, version, sort and unsupported-value failures. Encoding unsupported key values returns `ValueError` identifying the position and type, without leaking values. Keys and token shape are validated before producing a Page; errors return no partial page. Cursors are not authenticated: a well-formed edit to a supported value or tag remains a seek request, not a tamper-detection failure. Without expected type metadata in Sort, the library cannot prove an edited supported tag matches a SQL column; driver/database errors propagate normally. Authorization stays in the query.
Prepared pagination exposes one generic Bob `Mod[Q]` targeting native `AppendWhere(...any)`, `AppendOrder(bob.Expression)` and `SetLimit(any)` methods shared by PostgreSQL, SQLite and MySQL SelectQuery. Use Bob expressions and `clause.OrderDef`, fixed operators/directions, and an integer limit. Prepare validates requests/cursors first because ordinary Bob Apply has no error return. Cursor values only enter `expr.Arg(value)`; Bob's existing `any` boundary retains their concrete dynamic type. No custom SQL renderer is needed. Apply once to a query without ORDER BY, LIMIT, OFFSET or FETCH; callers may append their dynamic/authorization filters but must not override pagination/order.
For `(created DESC, id ASC)`, after means `created < c OR (created = c AND id > i)`, grouped as one WHERE condition. Before reverses each comparison. Backward also reverses each ORDER BY direction, fetches limit+1, trims overflow, then reverses retained rows into canonical order. Page[T] holds Items, StartCursor, EndCursor, HasNext and HasPrevious; cursors describe the canonical first/last returned items, or are empty when no items exist. Deleted anchors remain value boundaries. Writes or changed filters between requests may skip/repeat items; no snapshot is promised.
Forward maps first/after and Backward maps last/before to a transport-neutral Direction, Size and Cursor request. Request rules: zero direction is Forward, zero/absent size uses configured default, negative sizes and invalid directions fail, oversized sizes clamp to maximum; require `1 <= default <= maximum` and overflow-safe limit+1. Empty cursor means no anchor. The owner selected continuation semantics: forward HasNext=overflow and HasPrevious=nonempty after; backward HasPrevious=overflow and HasNext=nonempty before. This applies even to empty/stale results. An anchor-derived opposite flag does not prove rows exist; no extra existence probes are required.
Bob v0.50.0 distinguishes generated column references from generated typed WHERE helpers. Generated references such as `models.Orders.Columns.CreatedAt` (schematic; this repository has no generated models) satisfy `bob.Expression` and can replace handwritten `expr.Quote` identifiers in Sort. Their generated per-table column type embeds the dialect Expression and has no Go value-type parameter: neither reference nor `expr.Quote` statically links that expression to a `time.Time` key. In contrast, generated `models.SelectWhere.Orders.CreatedAt` uses `WhereMod[Q, time.Time]`; its `EQ`/`LT`/`GT` arguments must be assignable to `time.Time`, and Q must satisfy Bob's Filterable constraint. These helpers produce WHERE mods, not sortable column expressions, and expose no public expression accessor. They cannot be substituted directly for Sort expressions or consume a heterogeneous `[]any` element without recovering the expected concrete type. The chosen API preserves the concrete dynamic values through the codec/binder and checks lengths at runtime; it promises no compile-time column/key type or order agreement. The owner deferred stronger compile-time field correspondence to [code generation issue 11](https://gitea.auvem.com/corestack/go/issues/11); no code generation or stronger typed abstraction is implemented here.
A concrete call shape using schematic Bob-generated references is (this repository has no generated models):
```go
sort := page.Sort{ID: "orders/recent/v1", Columns: []page.Column{
{Expression: models.Orders.Columns.CreatedAt, Direction: page.Desc},
{Expression: models.Orders.Columns.ID, Direction: page.Asc, Unique: true},
}}
key := func(o Order) []any { return []any{o.CreatedAt, o.ID} } // time.Time, int64
prepared, err := page.Prepare(sort, key, page.Request{
Direction: page.Forward, Size: 25, Cursor: after,
}, page.Limits{Default: 25, Maximum: 100})
// Handle err before applying the mod to a normal Bob PostgreSQL SELECT q.
q.Apply(page.Mod[*pgdialect.SelectQuery](prepared))
q.Apply(sm.Where(psql.Quote("orders", "tenant_id").EQ(psql.Arg(tenantID))))
// Execute q with Bob's normal Order mapper, obtaining up to 26 []Order rows.
result, err := prepared.Page(rows)
```
Backward changes Direction and supplies the before cursor. `pgdialect`/`sm` are Bob's PostgreSQL dialect/select-mod packages; corresponding SQLite/MySQL select types use the same mod. `Page` retains the typed `Order` key function; `o.ID` is restored as int64, including above 2^53. A separate opt-in `Count(ctx, executor, callerBuiltCountQuery)` executes an explicitly counting, authorized unpaginated Bob query. It never guesses how to strip pagination or count grouped/distinct caller relations.
Bob v0.50.0 is source-feasible for all three dialects, with two reported limitations: generic `mods.OrderBy` expects a different AppendOrder signature from actual selects (native ModFunc matches); MySQL's select writer discards LIMIT expression arguments (use the normal native integer LIMIT API, while cursor WHERE values remain bound). SQLite runs in-process in the normal test suite. PostgreSQL uses the same pagination outcome suite and a required CI service container. MySQL has compile-time native mod composition coverage; runtime behavior remains unverified. Bob belongs in the root module under the accepted module-boundary ADR; no UUID dependency is needed. No persistence, writers, migrations, secrets, workers or timers are introduced.
### Consequences
* The owner-chosen Sort/key separation is simple and code-generation-ready, with runtime length errors instead of compile-time column/value agreement. Tests and package examples must demonstrate correct pairing and disagreement failures.
* Explicit tags retain supported concrete types without reflection, precision loss or a registry. Unsupported custom/third-party types require explicit caller conversion or a later support decision.
* Version and sort IDs become compatibility commitments; changes may deliberately reject retained cursors. No legacy decoder is needed before another version exists.
* Cursors expose values and permit valid edits; queries, counts and every request must preserve authorization. Concurrent writes have no snapshot guarantee. Nothing runs when unused.
* Implementation tests must cover tagged round trips (including large integers, time with an unusual second-offset timezone, and UUID), unrepresentable timestamp years, encoded-token boundaries at and above 16 KiB for both emission and receipt, oversized-string rejection with a typed error and no partial Page, unsupported/malformed/tampered/mismatched cursors (including removed `columns` fields, object-shaped values, incorrect pair arity and non-string entries), Sort/key disagreement, mixed-direction ties, both directions, boundaries and size clamping, plus a package Example of the key function. Execute our pagination and compliant binding/composition tests on in-process SQLite and PostgreSQL CI; do not assert Bob SQL formatting/rendering guarantees. MySQL remains source-feasible until runtime coverage exists.
+29
View File
@@ -0,0 +1,29 @@
Baseline copied from corestack/standards at a36288e7cec933a32f4819a1308201027c9f57ec; this project owns and may adapt it.
# Documentation policy
The [corestack/go docs-format specification](https://gitea.auvem.com/corestack/go/src/branch/main/docs/docs-format.md) owns record format, templates, and validation. In scaffolded projects, generate records and run checks with the pinned documentation command in the root AGENTS.md; do not maintain local format templates.
The copied policy is a project-owned baseline that the project may adapt; scaffold re-runs never refresh it unless the owner explicitly asks. The project owns its locked checker pin and upgrades: update the tag and ensure compliance; scaffold re-runs retain the existing pin unless the owner asks.
## Choose the smallest useful tier
| Tier | Use when | Scaffold output |
| --- | --- | --- |
| Neither | A single-purpose CLI, library, or script has no consequential architectural choice or durable execution context yet. | No record directories and no docs-check CI step; root instructions tell agents to ask the owner to run scaffold-project to enable records when a consequential choice arises. |
| ADRs only | Consequential choices need durable rationale, but execution fits a short issue or PR. | Local policy in docs/adr/README.md, ADRs as warranted and docs-check CI. |
| ADRs + plans | Work spans areas, phases, or sessions and needs durable execution context. | Local policy in docs/adr/README.md, a docs/plans/README.md pointer, ADRs as warranted, one file per plan, and docs-check CI. |
Project size is a signal, not an exemption: a small security-sensitive library can warrant an ADR. Add the CI docs-check step exactly when the selected tier enables records. Change tiers when actual work warrants it; do not create empty record directories in anticipation.
## Decisions and execution
Write an ADR for a consequential choice among real alternatives: difficult to reverse, crossing areas, changing a boundary, data model or security posture, or establishing a convention. Routine details and choices already governed by an accepted ADR or practice guide do not need another record. Read relevant accepted decisions and verify their claims against code before dependent work. Proposed ADRs are context, not authority; only the owner accepts a decision.
Write a plan when work spanning areas, phases or sessions needs durable execution context. Otherwise keep planning in a PR, issue or chat. Each plan has its own file; the directory is the index. Never create a central living plan or living PRD checklist that parallel worktrees continually edit. Closed plans are history, never standing instructions.
Use `write-adr` and `review-adr` when available: they guide reasoning while deferring textual format to repository conventions. Seek independent review and owner acceptance before treating a proposal as binding. Neither a self-check nor an independent recommendation accepts an ADR. ADRs may share a PR with implementation; no separate ADR PR or extra sections are required by this policy.
## Reconcile before final review and merge
Compare the latest target branch plus the PR with the affected decisions and plans, not just the working branch's previous metadata. Update ADR implementation state and `implemented_by` with the real PR URL when delivery evidence supports it. Close finished plans with completion evidence and an Outcome; keep work active when scope remains. Never invent PR links, completed checks, owner acceptance, or delivery evidence. Run `docs check` using the pinned documentation command in the root AGENTS.md after reconciliation.
+245
View File
@@ -0,0 +1,245 @@
# Docs format
This is the complete specification for architecture decision records (ADRs) and implementation plans checked by `docs check`. It is standalone: a file that follows this document is valid without running the tool. The words MUST, MUST NOT and MAY are used in their RFC 2119 sense.
The ADR body uses the [MADR 4](https://adr.github.io/madr/) layout; `Consequences` is mandatory. The frontmatter, naming and cross-reference rules are specific to this format.
## 1. Files and directories
- ADRs live in `docs/adr/`, plans in `docs/plans/`, relative to the repository root. Both are flat: subdirectories are not scanned and are errors.
- A missing directory is treated as empty. `docs/adr` and `docs/plans` MUST be real directories: a symlink in their place is an error, and neither may resolve outside the repository through a symlinked parent such as `docs`.
- Entries whose name starts with `.` (such as `.DS_Store` or editor swap files) are ignored. `README.md` in either directory is skipped. Every other entry MUST be a regular file whose name matches section 2 and ends in `.md`. Any other file, directory or name is an error. There are no other exceptions: no templates and no companion files; every `.md` file is a record.
- Files are UTF-8 without a byte order mark. LF and CRLF line endings are both accepted.
## 2. Names and IDs
A record file is named `YYYYMMDDTHHMMSSmmmZ-slug.md`, for example `20261023T204512345Z-use-example-queue.md`.
- The timestamp is UTC to the millisecond and MUST be a real date and time.
- The slug is lowercase `a-z0-9` words joined by single hyphens: no leading, trailing or doubled hyphen, 1 to 80 characters.
- The filename without `.md` (the stem) is the record's permanent ID. Never rename a record, even to fix its slug; change the title instead.
- IDs MUST be unique across `docs/adr` and `docs/plans` (compared by the timestamp-and-slug stem).
- Tools create `docs/<type>/<stem>.md` exclusively (`O_EXCL`) and advance the timestamp by 1 ms on `EEXIST`, or while any record in either directory has the same stem. This is tool behavior and does not affect validity.
## 3. Frontmatter
Every record starts with a YAML frontmatter block: the first line is exactly `---`, and the block ends at the next line that is exactly `---`. The block MUST be a mapping containing exactly the keys listed for the record type, no more, no fewer, each once. Key order is free. Empty lists are written `[]`. A key with no value (null) is an error.
A plain `~`, `null`, `Null` or `NULL` is null, the same as an empty value, and is an error. Every other scalar is a string with no type resolution: its parsed text, whether quoted or not. For example, `date` may be quoted or unquoted, `title: 2026` is the string `2026`, and `title: "null"` is the string `null`. A block scalar (`|`, `>`) is its parsed text. Anchors, aliases, explicit tags and multiple YAML documents are errors. "Single line" means the parsed value contains no line break.
### 3.1 ADR keys
| Key | Type | Rule |
| --- | --- | --- |
| `title` | string | Non-empty, single line. |
| `date` | `YYYY-MM-DD` | Valid date. Equals the date in the filename (UTC). |
| `status` | enum | `proposed`, `accepted`, `rejected`, `deprecated`, `superseded`. |
| `implementation` | enum | `not-started`, `in-progress`, `implemented`, `deferred`, `not-applicable`. |
| `summary` | string | Non-empty, single line. |
| `tags` | list of strings | Non-empty list. Each tag is lowercase `a-z0-9` words joined by single hyphens; no duplicates. |
| `supersedes` | list of references | May be empty. |
| `superseded_by` | list of references | May be empty. |
| `related` | list of references | May be empty. |
| `tracking` | list of references | May be empty. |
| `implemented_by` | list of references | May be empty. |
### 3.2 Plan keys
| Key | Type | Rule |
| --- | --- | --- |
| `status` | enum | `draft`, `active`, `completed`, `cancelled`. |
| `tracking` | list of references | May be empty unless `active`. |
| `adrs` | list of references | May be empty. |
| `completion` | list of references | May be empty unless `completed` or `cancelled`. |
A plan has no `title` key; its title is its H1.
### 3.3 References in frontmatter
Every list item is a string. No list may contain duplicates. Which kinds of reference each key accepts:
| Key | Accepts |
| --- | --- |
| `supersedes`, `superseded_by`, plan `adrs` | Repo-root paths to ADRs (`/docs/adr/<id>.md`). |
| `related` | Repo-root paths to any record (`/docs/adr/...` or `/docs/plans/...`). |
| ADR `tracking` | `http` or `https` URLs, or repo-root paths to plans (`/docs/plans/<id>.md`). |
| Plan `tracking` | `http` or `https` URLs. |
| `implemented_by`, `completion` | `http` or `https` URLs (pull request, commit, release), or repo-root paths to existing files. |
See section 7 for what a valid path or URL is. A record MUST NOT reference itself. An ADR whose delivery is tracked by a plan lists the plan in `tracking`; other record-to-record links go in `related`.
Reference lists MUST be durable: an item that is a bare issue number such as `#123` or `owner/repo#123`, or one of the placeholders "this PR", "this pull request" or "this commit" (any case), is rejected. Use a full URL. This applies to whole list items in frontmatter reference lists only; `title`, `summary` and body text are not inspected for it.
## 4. Status
`status` is the decision; `implementation` is delivery of that decision. They are independent except where stated.
ADR `status`:
- `proposed`: under discussion; not binding.
- `accepted`: the decision stands. Accepting is the owner's act.
- `rejected`: considered and declined. Requires `implementation: not-applicable`.
- `deprecated`: once accepted, no longer recommended, with no replacement.
- `superseded`: replaced by another ADR. Requires non-empty `superseded_by`.
ADR `implementation`:
- `not-started`, `in-progress`, `deferred`: delivery state.
- `implemented`: requires non-empty `implemented_by`.
- `not-applicable`: nothing to deliver (required for `rejected`; allowed for any other status).
Per-status requirements, summarized:
| Condition | Requirement |
| --- | --- |
| `status: superseded` | `superseded_by` non-empty. |
| `superseded_by` non-empty | `status: superseded`. |
| `status: rejected` | `implementation: not-applicable`. |
| `implementation: implemented` | `implemented_by` non-empty. |
Plan `status`:
| Status | Meaning | `tracking` | `completion` |
| --- | --- | --- | --- |
| `draft` | Being written. | any | MUST be empty |
| `active` | Work under way. | MUST be non-empty | MUST be empty |
| `completed` | All steps done. | any | MUST be non-empty |
| `cancelled` | Abandoned. | any | MUST be non-empty |
## 5. Supersession
- If ADR A lists B in `supersedes`, then B MUST list A in `superseded_by`, and the reverse. Both records exist and are ADRs.
- Supersession MUST NOT form a cycle.
- The superseding record (A, the one whose `supersedes` lists the other) MUST have status `accepted`, or `superseded` or `deprecated` (it was accepted once and has since moved on). It MUST NOT be `proposed` or `rejected`.
- While a replacement is `proposed`, list the ADR it would replace in `related`. On acceptance, in the same change, move it to `supersedes` and set the target's `status: superseded` and `superseded_by`.
- A superseded record keeps its original `date` and filename; only its `status` and `superseded_by` change.
## 6. Body
The body is Markdown (CommonMark) after the frontmatter. Headings inside fenced code blocks or HTML comments do not count. Only headings at the top level of the document count. Required section headings are matched case-sensitively and exactly, at level 2 (`##`). A section runs until the next heading of level 1 or 2, so its subsections belong to it. A required section MUST appear exactly once and contain non-empty prose: at least one paragraph (including paragraphs inside blockquotes), list item or table cell of text. HTML comments and code (fenced, indented or inline) do not count as prose. Extra sections are allowed anywhere.
Heading text is the raw source after the `#` markers, trimmed, with any closing `#` run removed; it is compared byte for byte, with no inline-markup rendering. Setext headings are read as the equivalent ATX heading.
### 6.1 ADR
- The first heading is an H1 whose heading text equals `title`. There is one H1.
- Required H2 sections: `Context and Problem Statement`, `Considered Options`, `Decision Outcome`.
- `Decision Outcome` MUST contain exactly one `### Consequences` (H3) subsection with non-empty prose, and at least one prose block before its first H3 subsection. A level-2 `## Consequences` is an error.
- Optional MADR sections (for example `Decision Drivers`, `Pros and Cons of the Options`, `More Information`) MAY be added.
### 6.2 Plan
- The first heading is a non-empty H1: the plan title. There is one H1.
- Required H2 sections: `Scope`, `Steps`, `Validation`.
- `## Outcome` is optional for every status. Closed plans still require `completion` (section 4).
### 6.3 Placeholders
A record is invalid if it still contains the exact marker `{{docs:todo}}` anywhere outside code, including inside a frontmatter string value or list item (write it quoted there: `summary: "{{docs:todo}}"`). A list item equal to the marker reports only the marker error, not the format error for its key. `docs new` writes this marker into each field and section it leaves for you to fill; replace it with content. No other text is treated as a placeholder, so words like TODO or TBD are fine. To mention the marker itself, put it in inline or fenced code.
## 7. References and links
A reference is either a repo-root path or a URL. This applies to frontmatter reference lists and to every Markdown link and image destination in the body (inline, reference-style and autolinks; bare URLs in text are not checked). In the body, link rules apply only to Markdown link destinations: forge autolink shortcuts in plain text (`#123`, `owner/repo#123`, `@user`, commit SHAs) and raw HTML (`<a href>`, `<img src>`) are not inspected. Every link reference definition is checked, whether or not it is used.
Repo-root path:
- Starts with a single `/` and is relative to the repository root, for example `/docs/adr/20261023T204512345Z-use-example-queue.md`. A leading `//` (protocol-relative `//host/...`) is rejected.
- Repo-root links render correctly on Git forges (GitHub, Gitea) but not in every Markdown viewer.
- The destination is percent-decoded before the existence check (`%20` is a space). A `?query` is an error.
- The target MUST exist as a regular file inside the repository, and the path MUST match the target's case exactly, component by component, even on case-insensitive filesystems. Symlinks that resolve outside the repository are rejected.
- In body links only, a `#fragment` suffix is allowed; the fragment is not verified. In frontmatter, a fragment is an error.
- Rejected: relative paths (`foo.md`, `./foo.md`), any `..` segment and backslashes. Other non-existent targets, including machine paths such as `/Users/...` or `/home/...`, fail the existence rule; `file:` URLs fail the scheme rule.
URL:
- Scheme `http` or `https` with a host, for example `https://example.com/org/repo/pull/42`. Credentials in the URL (`user:pass@`) are rejected. URLs are not fetched.
Always allowed in body prose only: in-page anchors (`#section`) and `mailto:` links. Any other scheme is rejected.
## 8. What `docs check` reports
`docs check [--root DIR]` checks every record under `DIR` (default: the working directory) and prints one line per problem:
```
path:line: message
```
`path` is relative to the root using `/` separators. `line` is the best location of the problem (the key, heading or link), or `1` for file-level problems. Output is sorted by path, then line, then message. The exit status is `1` if any problem is reported, `2` for usage errors, and `0` otherwise, in which case a one-line summary of the records checked is printed.
It reports violations of everything above:
- unexpected files, directories or names; bad timestamps or slugs; duplicate IDs;
- missing, malformed or unterminated frontmatter; unknown, missing, duplicate or null keys; wrong types or values; `date` not matching the filename;
- status/implementation/field combinations from section 4;
- supersession problems from section 5, and self-references;
- missing, repeated or empty required sections; H1 problems; `{{docs:todo}}` markers;
- invalid, unresolvable or non-durable references and links.
It does not judge whether a decision is good, whether a record should have been written, or whether a link's fragment exists.
## 9. Minimal valid examples
`docs/adr/20261023T204512345Z-use-example-queue.md`:
```markdown
---
title: Use Example Queue for background jobs
date: 2026-10-23
status: proposed
implementation: not-started
summary: Run background jobs on Example Queue.
tags:
- jobs
supersedes: []
superseded_by: []
related: []
tracking: []
implemented_by: []
---
# Use Example Queue for background jobs
## Context and Problem Statement
Jobs currently run inline and block requests.
## Considered Options
* Example Queue
* Keep running jobs inline
## Decision Outcome
Chosen option: Example Queue, because it decouples jobs from requests.
### Consequences
* We operate one more service.
```
`docs/plans/20261023T210000000Z-adopt-example-queue.md`:
```markdown
---
status: draft
tracking: []
adrs:
- /docs/adr/20261023T204512345Z-use-example-queue.md
completion: []
---
# Adopt Example Queue
## Scope
Move the email job to Example Queue.
## Steps
1. Add the queue client.
2. Move the email job.
## Validation
The email job runs from the queue in staging.
```
+17
View File
@@ -0,0 +1,17 @@
module go.auvem.com/corestack
go 1.27.1
require (
github.com/lib/pq v1.10.9
github.com/mattn/go-sqlite3 v1.14.32
github.com/stephenafamo/bob v0.50.0
github.com/stephenafamo/scan v0.9.0
github.com/yuin/goldmark v1.8.6
go.yaml.in/yaml/v3 v3.0.5
)
require (
github.com/aarondl/opt v0.0.0-20250607033636-982744e1bd65 // indirect
github.com/qdm12/reprint v0.0.0-20200326205758-722754a53494 // indirect
)
+147
View File
@@ -0,0 +1,147 @@
dario.cat/mergo v1.0.1 h1:Ra4+bf83h2ztPIQYNP99R6m+Y7KfnARDfID+a+vLl4s=
dario.cat/mergo v1.0.1/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk=
github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 h1:UQHMgLO+TxOElx5B5HZ4hJQsoJ/PvUvKRhJHDQXO8P8=
github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1/go.mod h1:xomTg63KZ2rFqZQzSB4Vz2SUXa1BpHTVz9L5PTmPC4E=
github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY=
github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU=
github.com/aarondl/opt v0.0.0-20250607033636-982744e1bd65 h1:lbdPe4LBNmNDzeQFwNhEc88w90841qv737MI4+aXSYU=
github.com/aarondl/opt v0.0.0-20250607033636-982744e1bd65/go.mod h1:+xKBXrTAUOvrDXO5PRwIr4E1wciHY3Glgl+6OkCXknU=
github.com/antlr4-go/antlr/v4 v4.13.1 h1:SqQKkuVZ+zWkMMNkjy5FZe5mr5WURWnlpmOuzYWrPrQ=
github.com/antlr4-go/antlr/v4 v4.13.1/go.mod h1:GKmUxMtwp6ZgGwZSva4eWPC5mS6vUAmOABFgjdkM7Nw=
github.com/cenkalti/backoff/v4 v4.2.1 h1:y4OZtCnogmCPw98Zjyt5a6+QwPLGkiQsYW5oUqylYbM=
github.com/cenkalti/backoff/v4 v4.2.1/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE=
github.com/containerd/errdefs v1.0.0 h1:tg5yIfIlQIrxYtu9ajqY42W3lpS19XqdxRQeEwYG8PI=
github.com/containerd/errdefs v1.0.0/go.mod h1:+YBYIdtsnF4Iw6nWZhJcqGSg/dwvV7tyJ/kCkyJ2k+M=
github.com/containerd/errdefs/pkg v0.3.0 h1:9IKJ06FvyNlexW690DXuQNx2KA2cUJXx151Xdx3ZPPE=
github.com/containerd/errdefs/pkg v0.3.0/go.mod h1:NJw6s9HwNuRhnjJhM7pylWwMyAkmCQvQ4GpJHEqRLVk=
github.com/containerd/log v0.1.0 h1:TCJt7ioM2cr/tfR8GPbGf9/VRAX8D2B4PjzCpfX540I=
github.com/containerd/log v0.1.0/go.mod h1:VRRf09a7mHDIRezVKTRCrOq78v577GXq3bSa3EhrzVo=
github.com/containerd/platforms v0.2.1 h1:zvwtM3rz2YHPQsF2CHYM8+KtB5dvhISiXh5ZpSBQv6A=
github.com/containerd/platforms v0.2.1/go.mod h1:XHCb+2/hzowdiut9rkudds9bE5yJ7npe7dG/wG+uFPw=
github.com/cpuguy83/dockercfg v0.3.2 h1:DlJTyZGBDlXqUZ2Dk2Q3xHs/FtnooJJVaad2S9GKorA=
github.com/cpuguy83/dockercfg v0.3.2/go.mod h1:sugsbF4//dDlL/i+S+rtpIWp+5h0BHJHfjj5/jFyUJc=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/distribution/reference v0.6.0 h1:0IXCQ5g4/QMHHkarYzh5l+u8T3t73zM5QvfrDyIgxBk=
github.com/distribution/reference v0.6.0/go.mod h1:BbU0aIcezP1/5jX/8MP0YiH4SdvB5Y4f/wlDRiLyi3E=
github.com/docker/docker v28.2.2+incompatible h1:CjwRSksz8Yo4+RmQ339Dp/D2tGO5JxwYeqtMOEe0LDw=
github.com/docker/docker v28.2.2+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
github.com/docker/go-connections v0.5.0 h1:USnMq7hx7gwdVZq1L49hLXaFtUdTADjXGp+uj1Br63c=
github.com/docker/go-connections v0.5.0/go.mod h1:ov60Kzw0kKElRwhNs9UlUHAE/F9Fe6GLaXnqyDdmEXc=
github.com/docker/go-units v0.5.0 h1:69rxXcBk27SvSaaxTtLh/8llcHD8vYHT7WSdRZ/jvr4=
github.com/docker/go-units v0.5.0/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk=
github.com/ebitengine/purego v0.8.4 h1:CF7LEKg5FFOsASUj0+QwaXf8Ht6TlFxg09+S9wz0omw=
github.com/ebitengine/purego v0.8.4/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ=
github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg=
github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY=
github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
github.com/go-ole/go-ole v1.2.6 h1:/Fpf6oFPoeFik9ty7siob0G6Ke8QvQEuVcuChpwXzpY=
github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0=
github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/klauspost/compress v1.18.0 h1:c/Cqfb0r+Yi+JtIEq73FWXVkRonBlf0CRNYc8Zttxdo=
github.com/klauspost/compress v1.18.0/go.mod h1:2Pp+KzxcywXVXMr50+X0Q/Lsb43OQHYWRCY2AiWywWQ=
github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 h1:6E+4a0GO5zZEnZ81pIr0yLvtUWk2if982qA3F3QD6H4=
github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0/go.mod h1:zJYVVT2jmtg6P3p1VtQj7WsuWi/y4VnjVBn7F8KPB3I=
github.com/magiconair/properties v1.8.10 h1:s31yESBquKXCV9a/ScB3ESkOjUYYv+X0rg8SYxI99mE=
github.com/magiconair/properties v1.8.10/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0=
github.com/mattn/go-sqlite3 v1.14.32 h1:JD12Ag3oLy1zQA+BNn74xRgaBbdhbNIDYvQUEuuErjs=
github.com/mattn/go-sqlite3 v1.14.32/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y=
github.com/moby/docker-image-spec v1.3.1 h1:jMKff3w6PgbfSa69GfNg+zN/XLhfXJGnEx3Nl2EsFP0=
github.com/moby/docker-image-spec v1.3.1/go.mod h1:eKmb5VW8vQEh/BAr2yvVNvuiJuY6UIocYsFu/DxxRpo=
github.com/moby/go-archive v0.1.0 h1:Kk/5rdW/g+H8NHdJW2gsXyZ7UnzvJNOy6VKJqueWdcQ=
github.com/moby/go-archive v0.1.0/go.mod h1:G9B+YoujNohJmrIYFBpSd54GTUB4lt9S+xVQvsJyFuo=
github.com/moby/patternmatcher v0.6.0 h1:GmP9lR19aU5GqSSFko+5pRqHi+Ohk1O69aFiKkVGiPk=
github.com/moby/patternmatcher v0.6.0/go.mod h1:hDPoyOpDY7OrrMDLaYoY3hf52gNCR/YOUYxkhApJIxc=
github.com/moby/sys/sequential v0.6.0 h1:qrx7XFUd/5DxtqcoH1h438hF5TmOvzC/lspjy7zgvCU=
github.com/moby/sys/sequential v0.6.0/go.mod h1:uyv8EUTrca5PnDsdMGXhZe6CCe8U/UiTWd+lL+7b/Ko=
github.com/moby/sys/user v0.4.0 h1:jhcMKit7SA80hivmFJcbB1vqmw//wU61Zdui2eQXuMs=
github.com/moby/sys/user v0.4.0/go.mod h1:bG+tYYYJgaMtRKgEmuueC0hJEAZWwtIbZTB+85uoHjs=
github.com/moby/sys/userns v0.1.0 h1:tVLXkFOxVu9A64/yh59slHVv9ahO9UIev4JZusOLG/g=
github.com/moby/sys/userns v0.1.0/go.mod h1:IHUYgu/kao6N8YZlp9Cf444ySSvCmDlmzUcYfDHOl28=
github.com/moby/term v0.5.0 h1:xt8Q1nalod/v7BqbG21f8mQPqH+xAaC9C3N3wfWbVP0=
github.com/moby/term v0.5.0/go.mod h1:8FzsFHVUBGZdbDsJw/ot+X+d5HLUbvklYLJ9uGfcI3Y=
github.com/morikuni/aec v1.0.0 h1:nP9CBfwrvYnBRgY6qfDQkygYDmYwOilePFkwzv4dU8A=
github.com/morikuni/aec v1.0.0/go.mod h1:BbKIizmSmc5MMPqRYbxO4ZU0S0+P200+tUnFx7PXmsc=
github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U=
github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM=
github.com/opencontainers/image-spec v1.1.1 h1:y0fUlFfIZhPF1W537XOLg0/fcx6zcHCJwooC2xJA040=
github.com/opencontainers/image-spec v1.1.1/go.mod h1:qpqAh3Dmcf36wStyyWU+kCeDgrGnAve2nCC8+7h8Q0M=
github.com/pganalyze/pg_query_go/v6 v6.1.0 h1:jG5ZLhcVgL1FAw4C/0VNQaVmX1SUJx71wBGdtTtBvls=
github.com/pganalyze/pg_query_go/v6 v6.1.0/go.mod h1:nvTHIuoud6e1SfrUaFwHqT0i4b5Nr+1rPWVds3B5+50=
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c h1:ncq/mPwQF4JjgDlrVEn3C11VoGHZN7m8qihwgMEtzYw=
github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c/go.mod h1:OmDBASR4679mdNQnz2pUhc2G8CO2JrUAVFDRBDP/hJE=
github.com/qdm12/reprint v0.0.0-20200326205758-722754a53494 h1:wSmWgpuccqS2IOfmYrbRiUgv+g37W5suLLLxwwniTSc=
github.com/qdm12/reprint v0.0.0-20200326205758-722754a53494/go.mod h1:yipyliwI08eQ6XwDm1fEwKPdF/xdbkiHtrU+1Hg+vc4=
github.com/shirou/gopsutil/v4 v4.25.5 h1:rtd9piuSMGeU8g1RMXjZs9y9luK5BwtnG7dZaQUJAsc=
github.com/shirou/gopsutil/v4 v4.25.5/go.mod h1:PfybzyydfZcN+JMMjkF6Zb8Mq1A/VcogFFg7hj50W9c=
github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
github.com/stephenafamo/bob v0.50.0 h1:CsG9JSfJt4RLZiuHdf39LK98Jx5QBkNAIymqtVwnCqY=
github.com/stephenafamo/bob v0.50.0/go.mod h1:pz+z6oJa2PU6jGo+uWvaWcbNlXPVwkt5d9nW8kHWfJ0=
github.com/stephenafamo/fakedb v0.0.0-20221230081958-0b86f816ed97 h1:XItoZNmhOih06TC02jK7l3wlpZ0XT/sPQYutDcGOQjg=
github.com/stephenafamo/fakedb v0.0.0-20221230081958-0b86f816ed97/go.mod h1:bM3Vmw1IakoaXocHmMIGgJFYob0vuK+CFWiJHQvz0jQ=
github.com/stephenafamo/scan v0.9.0 h1:11Rf0cW1KjMLoTEa5uNO9FTRFDFc4BgJJi9LIQz1cmQ=
github.com/stephenafamo/scan v0.9.0/go.mod h1:FhIUJ8pLNyex36xGFiazDJJ5Xry0UkAi+RkWRrEcRMg=
github.com/stephenafamo/sqlparser v0.0.0-20260122161205-e324475bd1fc h1:D/IjFvgl7MXcuKnXzGCOAMKTfzopgxdLYIy0HZx+CI4=
github.com/stephenafamo/sqlparser v0.0.0-20260122161205-e324475bd1fc/go.mod h1:2ATW++wFz7Mvc/N+nUtQnU+9VIGAxrn8m9JCLDSWMsQ=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/testcontainers/testcontainers-go v0.38.0 h1:d7uEapLcv2P8AvH8ahLqDMMxda2W9gQN1nRbHS28HBw=
github.com/testcontainers/testcontainers-go v0.38.0/go.mod h1:C52c9MoHpWO+C4aqmgSU+hxlR5jlEayWtgYrb8Pzz1w=
github.com/testcontainers/testcontainers-go/modules/postgres v0.38.0 h1:KFdx9A0yF94K70T6ibSuvgkQQeX1xKlZVF3hEagXEtY=
github.com/testcontainers/testcontainers-go/modules/postgres v0.38.0/go.mod h1:T/QRECND6N6tAKMxF1Za+G2tpwnGEHcODzHRsgIpw9M=
github.com/tetratelabs/wazero v1.9.0 h1:IcZ56OuxrtaEz8UYNRHBrUa9bYeX9oVY93KspZZBf/I=
github.com/tetratelabs/wazero v1.9.0/go.mod h1:TSbcXCfFP0L2FGkRPxHphadXPjo1T6W+CseNNY7EkjM=
github.com/tklauser/go-sysconf v0.3.12 h1:0QaGUFOdQaIVdPgfITYzaTegZvdCjmYO52cSFAEVmqU=
github.com/tklauser/go-sysconf v0.3.12/go.mod h1:Ho14jnntGE1fpdOqQEEaiKRpvIavV0hSfmBq8nJbHYI=
github.com/tklauser/numcpus v0.6.1 h1:ng9scYS7az0Bk4OZLvrNXNSAO2Pxr1XXRAPyjhIx+Fk=
github.com/tklauser/numcpus v0.6.1/go.mod h1:1XfjsgE2zo8GVw7POkMbHENHzVg3GzmoZ9fESEdAacY=
github.com/wasilibs/go-pgquery v0.0.0-20250409022910-10ac41983c07 h1:mJdDDPblDfPe7z7go8Dvv1AJQDI3eQ/5xith3q2mFlo=
github.com/wasilibs/go-pgquery v0.0.0-20250409022910-10ac41983c07/go.mod h1:Ak17IJ037caFp4jpCw/iQQ7/W74Sqpb1YuKJU6HTKfM=
github.com/wasilibs/wazero-helpers v0.0.0-20240620070341-3dff1577cd52 h1:OvLBa8SqJnZ6P+mjlzc2K7PM22rRUPE1x32G9DTPrC4=
github.com/wasilibs/wazero-helpers v0.0.0-20240620070341-3dff1577cd52/go.mod h1:jMeV4Vpbi8osrE/pKUxRZkVaA0EX7NZN0A9/oRzgpgY=
github.com/yuin/goldmark v1.8.6 h1:d0VcaP1sx9GkFVkoW+KtggpGi2KZ965i14b0+bDQST4=
github.com/yuin/goldmark v1.8.6/go.mod h1:ip/1k0VRfGynBgxOz0yCqHrbZXhcjxyuS66Brc7iBKg=
github.com/yusufpapurcu/wmi v1.2.4 h1:zFUKzehAFReQwLys1b/iSMl+JQGSCSjtVqQn9bBrPo0=
github.com/yusufpapurcu/wmi v1.2.4/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0=
go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=
go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 h1:jq9TW8u3so/bN+JPT166wjOI6/vQPF6Xe7nMNIltagk=
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0/go.mod h1:p8pYQP+m5XfbZm9fxtSKAbM6oIllS7s2AfxrChvc7iw=
go.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=
go.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=
go.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=
go.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=
go.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs=
go.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc=
go.yaml.in/yaml/v3 v3.0.5 h1:N6y/pJk8buWs9NY5ERU2HSMfm+IuD/OtfdAnq6kESPw=
go.yaml.in/yaml/v3 v3.0.5/go.mod h1:HVTZu1O7/Vkt2N+BFy8Zza+lnLsABggaTM2ZpNIGuKg=
golang.org/x/crypto v0.37.0 h1:kJNSjF/Xp7kU0iB2Z+9viTPMW4EqqsrywMXLJOOsXSE=
golang.org/x/crypto v0.37.0/go.mod h1:vg+k43peMZ0pUMhYmVAWysMK35e6ioLh3wB8ZCAfbVc=
golang.org/x/exp v0.0.0-20250305212735-054e65f0b394 h1:nDVHiLt8aIbd/VzvPWN6kSOPE7+F/fNFDSXLVYkE/Iw=
golang.org/x/exp v0.0.0-20250305212735-054e65f0b394/go.mod h1:sIifuuw/Yco/y6yb6+bDNfyeQ/MdPUy/hKEMYQV17cM=
golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
google.golang.org/protobuf v1.36.5 h1:tPhr+woSbjfYvY6/GPufUoYizxw1cF/yFoxJ2fmpwlM=
google.golang.org/protobuf v1.36.5/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+45
View File
@@ -0,0 +1,45 @@
package docs
import "time"
var (
adrStatuses = []string{"proposed", "accepted", "rejected", "deprecated", "superseded"}
adrImpls = []string{"not-started", "in-progress", "implemented", "deferred", "not-applicable"}
adrRefs = []refSpec{
{"supersedes", kAdr}, {"superseded_by", kAdr}, {"related", kAdr | kPlan},
{"tracking", kPlan | kURL}, {"implemented_by", kURL | kFile},
}
)
// adr checks the ADR frontmatter and returns its title for the body check.
func (c *checker) adr(r *record, m *fm) (string, bool) {
m.keys("title", "date", "status", "implementation", "summary", "tags", "supersedes", "superseded_by", "related", "tracking", "implemented_by")
title, titleOK := m.text("title")
if d, line, ok := m.scalar("date"); ok {
if _, err := time.Parse(time.DateOnly, d); err != nil || len(d) != len(time.DateOnly) {
c.add(r.path, line, "date must be a valid YYYY-MM-DD date")
} else if d != r.date {
c.add(r.path, line, "date %s does not match the filename date %s", d, r.date)
}
}
status, statusOK := m.enum("status", adrStatuses...)
impl, implOK := m.enum("implementation", adrImpls...)
m.text("summary")
m.tags()
m.refs(adrRefs...)
r.status = status
if statusOK {
if n := len(r.lists["superseded_by"]); status == "superseded" && n == 0 {
m.problemf("status", "status superseded requires superseded_by")
} else if status != "superseded" && n > 0 {
m.problemf("superseded_by", "superseded_by requires status superseded")
}
if status == "rejected" && implOK && impl != "not-applicable" {
m.problemf("implementation", "status rejected requires implementation not-applicable")
}
}
if implOK && impl == "implemented" && len(r.lists["implemented_by"]) == 0 {
m.problemf("implementation", "implementation implemented requires implemented_by")
}
return title, titleOK
}
+322
View File
@@ -0,0 +1,322 @@
package docs
import (
"bytes"
"regexp"
"strings"
"github.com/yuin/goldmark"
"github.com/yuin/goldmark/ast"
"github.com/yuin/goldmark/text"
"github.com/yuin/goldmark/util"
)
var (
adrSections = []string{"Context and Problem Statement", "Considered Options", "Decision Outcome"}
planSections = []string{"Scope", "Steps", "Validation"}
)
var atxRe = regexp.MustCompile(`(?m)^ {0,3}#{1,6}(?:[ \t]|$)`)
type heading struct {
level int
text string
line int
at int // index among the document's top-level nodes
}
type doc struct {
c *checker
r *record
src []byte
startLine int
kids []ast.Node
heads []heading
}
func (d *doc) lineAt(off int) int {
return d.startLine + bytes.Count(d.src[:min(off, len(d.src))], []byte("\n"))
}
// blockEnd is the end offset of the last line under n. Only block nodes have lines.
func blockEnd(n ast.Node) (end int) {
_ = ast.Walk(n, func(c ast.Node, enter bool) (ast.WalkStatus, error) {
if enter && c.Type() == ast.TypeBlock {
for i := range c.Lines().Len() {
end = max(end, c.Lines().At(i).Stop)
}
}
return ast.WalkContinue, nil
})
return end
}
// emptyHeadingAt is the offset of an empty ATX heading, which has no lines: the first `#`
// line at or after from, the end of everything before it.
func (d *doc) emptyHeadingAt(from int) int {
if m := atxRe.FindIndex(d.src[from:]); m != nil {
return from + m[0]
}
return from
}
// lineOf is the line of the first text under n. Without text (an autolink, an image with
// no alt text) it is the line where needle appears in the enclosing block, else the block's first line.
func (d *doc) lineOf(n ast.Node, needle string) int {
var off = -1
_ = ast.Walk(n, func(c ast.Node, enter bool) (ast.WalkStatus, error) {
if t, ok := c.(*ast.Text); ok && enter {
off = t.Segment.Start
return ast.WalkStop, nil
}
return ast.WalkContinue, nil
})
for p := n; off < 0 && p != nil; p = p.Parent() {
if p.Type() == ast.TypeBlock && p.Lines().Len() > 0 {
off = p.Lines().At(0).Start
if i := bytes.Index(d.src[off:p.Lines().At(p.Lines().Len()-1).Stop], []byte(needle)); needle != "" && i >= 0 {
off += i
}
}
}
if off < 0 {
return d.startLine
}
return d.lineAt(off)
}
func (c *checker) body(r *record, src string, startLine int, title string, titleOK bool) {
b := []byte(src)
root := goldmark.DefaultParser().Parse(text.NewReader(b))
d := &doc{c: c, r: r, src: b, startLine: startLine}
from := 0 // end of the blocks seen so far
for n := root.FirstChild(); n != nil; n = n.NextSibling() {
if h, ok := n.(*ast.Heading); ok {
at := from
if h.Lines().Len() > 0 {
at = h.Lines().At(0).Start
} else {
at = d.emptyHeadingAt(from)
from = at + bytes.IndexByte(d.src[at:], '\n') + 1 // the next line; ^ would match mid-line
}
d.heads = append(d.heads, heading{h.Level, strings.TrimSpace(string(h.Lines().Value(b))), d.lineAt(at), len(d.kids)})
}
from = max(from, blockEnd(n))
d.kids = append(d.kids, n)
}
d.placeholders(root)
d.links(root)
d.title(title, titleOK)
if r.kind == "adr" {
for _, name := range adrSections {
d.section(name)
}
d.decisionOutcome()
} else {
for _, name := range planSections {
d.section(name)
}
}
}
// title checks the single leading H1.
func (d *doc) title(title string, titleOK bool) {
h1s := 0
for _, h := range d.heads {
if h.level == 1 {
if h1s++; h1s > 1 {
d.c.add(d.r.path, h.line, "more than one H1")
}
}
}
switch first := d.heads; {
case len(first) == 0 || first[0].level != 1:
d.c.add(d.r.path, d.startLine, "the first heading must be an H1")
case d.r.kind == "plan" && first[0].text == "":
d.c.add(d.r.path, first[0].line, "the H1 (plan title) must not be empty")
case d.r.kind == "adr" && titleOK && first[0].text != title:
d.c.add(d.r.path, first[0].line, "H1 %q must equal title %q", first[0].text, title)
}
}
// extent returns the top-level nodes after heading h up to the next heading of level <= upTo.
func (d *doc) extent(h heading, upTo int) []ast.Node {
end := len(d.kids)
for _, o := range d.heads {
if o.at > h.at && o.level <= upTo {
end = o.at
break
}
}
return d.kids[h.at+1 : end]
}
// section finds the one H2 called name and checks that it has prose.
func (d *doc) section(name string) (heading, bool) {
var found []heading
for _, h := range d.heads {
if h.level == 2 && h.text == name {
found = append(found, h)
}
}
switch {
case len(found) == 0:
d.c.add(d.r.path, 1, "missing required section %q", name)
case len(found) > 1:
d.c.add(d.r.path, found[1].line, "section %q appears more than once", name)
case !d.hasProse(d.extent(found[0], 2)):
d.c.add(d.r.path, found[0].line, "section %q has no prose", name)
return found[0], true
default:
return found[0], true
}
return heading{}, false
}
func (d *doc) decisionOutcome() {
for _, h := range d.heads {
if h.level == 2 && h.text == "Consequences" {
d.c.add(d.r.path, h.line, "Consequences must be a ### subsection of Decision Outcome, not a ## section")
}
}
var outcome []heading
for _, h := range d.heads {
if h.level == 2 && h.text == "Decision Outcome" {
outcome = append(outcome, h)
}
}
if len(outcome) != 1 {
return
}
h := outcome[0]
nodes := d.extent(h, 2)
// Prose before the first subsection is the decision itself.
pre := nodes
for i, n := range nodes {
if h, ok := n.(*ast.Heading); ok && h.Level == 3 {
pre = nodes[:i]
break
}
}
if !d.hasProse(pre) {
d.c.add(d.r.path, h.line, "Decision Outcome needs prose before its first subsection")
}
var cons []heading
for _, s := range d.heads {
if s.level == 3 && s.text == "Consequences" && s.at > h.at && s.at < h.at+len(nodes)+1 {
cons = append(cons, s)
}
}
switch {
case len(cons) == 0:
d.c.add(d.r.path, h.line, "Decision Outcome must contain a ### Consequences subsection")
case len(cons) > 1:
d.c.add(d.r.path, cons[1].line, "### Consequences appears more than once")
case !d.hasProse(d.extent(cons[0], 3)):
d.c.add(d.r.path, cons[0].line, "### Consequences has no prose")
}
}
// hasProse reports whether nodes hold a paragraph with text outside code, images and raw HTML.
func (d *doc) hasProse(nodes []ast.Node) bool {
for _, n := range nodes {
found := false
_ = ast.Walk(n, func(c ast.Node, enter bool) (ast.WalkStatus, error) {
switch c.(type) {
case *ast.Paragraph, *ast.TextBlock:
if enter && strings.TrimSpace(d.inlineText(c)) != "" {
found = true
return ast.WalkStop, nil
}
return ast.WalkSkipChildren, nil
}
return ast.WalkContinue, nil
})
if found {
return true
}
}
return false
}
func (d *doc) inlineText(n ast.Node) string {
var s strings.Builder
for c := n.FirstChild(); c != nil; c = c.NextSibling() {
switch t := c.(type) {
case *ast.Text:
s.Write(t.Segment.Value(d.src))
case *ast.String:
s.Write(t.Value)
case *ast.CodeSpan, *ast.RawHTML, *ast.Image:
default:
s.WriteString(d.inlineText(c))
}
}
return s.String()
}
// codeRanges returns the source ranges of code blocks and code spans.
func codeRanges(root ast.Node) (code [][2]int) {
_ = ast.Walk(root, func(n ast.Node, enter bool) (ast.WalkStatus, error) {
switch n.(type) {
case *ast.FencedCodeBlock, *ast.CodeBlock:
for i := range n.Lines().Len() {
seg := n.Lines().At(i)
code = append(code, [2]int{seg.Start, seg.Stop})
}
case *ast.CodeSpan:
for c := n.FirstChild(); c != nil; c = c.NextSibling() {
if t, ok := c.(*ast.Text); ok {
code = append(code, [2]int{t.Segment.Start, t.Segment.Stop})
}
}
}
return ast.WalkContinue, nil
})
return code
}
// placeholders reports every marker outside code.
func (d *doc) placeholders(root ast.Node) {
code := codeRanges(root)
for off := 0; ; {
i := strings.Index(string(d.src[off:]), marker)
if i < 0 {
return
}
at := off + i
off = at + len(marker)
inCode := false
for _, r := range code {
inCode = inCode || at >= r[0] && at < r[1]
}
if !inCode {
d.c.add(d.r.path, d.lineAt(at), "unfinished placeholder %s", marker)
}
}
}
// dest decodes a link destination as CommonMark does before it is used.
func dest(b []byte) string {
return string(util.ResolveEntityNames(util.ResolveNumericReferences(util.UnescapePunctuations(b))))
}
// links checks every link, image and autolink destination and every reference definition.
func (d *doc) links(root ast.Node) {
_ = ast.Walk(root, func(n ast.Node, enter bool) (ast.WalkStatus, error) {
if !enter {
return ast.WalkContinue, nil
}
switch t := n.(type) {
case *ast.Link:
d.c.checkLink(d.r, d.lineOf(n, "]("+string(t.Destination)), dest(t.Destination))
case *ast.Image:
d.c.checkLink(d.r, d.lineOf(n, "]("+string(t.Destination)), dest(t.Destination))
case *ast.AutoLink:
d.c.checkLink(d.r, d.lineOf(n, "<"+string(t.Label(d.src))), string(t.URL(d.src)))
case *ast.LinkReferenceDefinition:
d.c.checkLink(d.r, d.lineAt(t.Lines().At(0).Start), dest(t.Destination))
}
return ast.WalkContinue, nil
})
}
+135
View File
@@ -0,0 +1,135 @@
// Package docs creates and checks the ADR and plan records described in docs/docs-format.md.
package docs
import (
"bytes"
"embed"
"fmt"
"os"
"path/filepath"
"slices"
"strings"
"unicode/utf8"
)
//go:embed templates/*.md
var templates embed.FS
var dirs = []struct{ kind, dir string }{{"adr", "docs/adr"}, {"plan", "docs/plans"}}
// Problem is one violation of the format. Line is 1 for file-level problems.
type Problem struct {
Path string
Line int
Msg string
}
func (p Problem) String() string { return fmt.Sprintf("%s:%d: %s", p.Path, p.Line, p.Msg) }
// Result is the outcome of Check: the number of records read and the sorted problems.
type Result struct {
Records int
Problems []Problem
}
type record struct {
path, kind, stem, date string
status string
lists map[string][]item
fm *fm
}
type checker struct {
root, realRoot string
problems []Problem
}
func (c *checker) add(path string, line int, format string, args ...any) {
c.problems = append(c.problems, Problem{path, line, fmt.Sprintf(format, args...)})
}
// Check validates every record under root. The error is for I/O failures only.
func Check(root string) (Result, error) {
real, err := filepath.EvalSymlinks(root)
if err != nil {
return Result{}, err
}
c := &checker{root: root, realRoot: real}
var recs []*record
for _, d := range dirs {
if st, err := os.Lstat(filepath.Join(root, d.dir)); os.IsNotExist(err) {
continue
} else if err == nil && !st.IsDir() {
c.add(d.dir, 1, "must be a real directory (symlinks are not allowed)")
continue
} else if r, err := filepath.EvalSymlinks(filepath.Join(root, d.dir)); err == nil && !within(real, r) {
c.add(d.dir, 1, "must be inside the repository (a symlinked parent directory is not allowed)")
continue
}
entries, err := os.ReadDir(filepath.Join(root, d.dir))
if err != nil {
return Result{}, err
}
for _, e := range entries {
name := e.Name()
if strings.HasPrefix(name, ".") || name == "README.md" {
continue
}
rel := d.dir + "/" + name
if !e.Type().IsRegular() {
c.add(rel, 1, "must be a regular file (subdirectories, symlinks and other entries are not allowed)")
continue
}
stem, at, msg := parseName(name)
if msg != "" {
c.add(rel, 1, "%s", msg)
continue
}
r := &record{path: rel, kind: d.kind, stem: stem, date: at.Format("2006-01-02"), lists: map[string][]item{}}
if err := c.record(r); err != nil {
return Result{}, err
}
recs = append(recs, r)
}
}
c.graph(recs)
slices.SortFunc(c.problems, func(a, b Problem) int {
return strings.Compare(fmt.Sprintf("%s\x00%09d\x00%s", a.Path, a.Line, a.Msg), fmt.Sprintf("%s\x00%09d\x00%s", b.Path, b.Line, b.Msg))
})
return Result{len(recs), c.problems}, nil
}
func (c *checker) record(r *record) error {
data, err := os.ReadFile(filepath.Join(c.root, filepath.FromSlash(r.path)))
if err != nil {
return err
}
if bytes.HasPrefix(data, []byte("\xef\xbb\xbf")) {
c.add(r.path, 1, "file must not start with a byte order mark")
return nil
}
if !utf8.Valid(data) {
c.add(r.path, 1, "file must be valid UTF-8")
return nil
}
src := strings.ReplaceAll(string(data), "\r\n", "\n")
front, body, bodyLine, msg := splitFrontmatter(src)
if msg != "" {
c.add(r.path, 1, "%s", msg)
return nil
}
m, ok := c.parseFrontmatter(r, front)
if !ok {
return nil
}
r.fm = m
var title string
var titleOK bool
if r.kind == "adr" {
title, titleOK = c.adr(r, m)
} else {
c.plan(r, m)
}
c.body(r, body, bodyLine, title, titleOK)
return nil
}
+390
View File
@@ -0,0 +1,390 @@
package docs
import (
"fmt"
"os"
"path/filepath"
"regexp"
"strings"
"testing"
)
const (
aID = "20261023T204512345Z-use-queue"
aPath = "docs/adr/" + aID + ".md"
bPath = "docs/adr/20261024T000000000Z-second.md"
pPath = "docs/plans/20261023T210000000Z-adopt-queue.md"
// Line numbers in the expectations below refer to these documents.
adrBase = `---
title: Use Queue
date: 2026-10-23
status: proposed
implementation: not-started
summary: Run jobs on a queue.
tags:
- jobs
supersedes: []
superseded_by: []
related: []
tracking: []
implemented_by: []
---
# Use Queue
## Context and Problem Statement
Jobs block requests.
## Considered Options
* Queue
* Inline
## Decision Outcome
Chosen option: Queue.
### Consequences
* One more service.
`
// bBase is a second ADR (dated 2026-10-24) that may supersede or be superseded.
bBase = `---
title: Second
date: 2026-10-24
status: accepted
implementation: not-started
summary: Second.
tags:
- jobs
supersedes: []
superseded_by: []
related: []
tracking: []
implemented_by: []
---
# Second
## Context and Problem Statement
Why.
## Considered Options
* A
## Decision Outcome
Chosen option: A.
### Consequences
* Some.
`
planBase = `---
status: draft
tracking: []
adrs: []
completion: []
---
# Adopt Queue
## Scope
Move the job.
## Steps
1. Do it.
## Validation
It runs.
`
)
// sub replaces old with new in s once; a stale expectation fails loudly.
func sub(s string, pairs ...string) string {
for i := 0; i < len(pairs); i += 2 {
if !strings.Contains(s, pairs[i]) {
panic("fixture does not contain " + pairs[i])
}
s = strings.Replace(s, pairs[i], pairs[i+1], 1)
}
return s
}
func tree(t *testing.T, files, links map[string]string) string {
t.Helper()
root, outside := t.TempDir(), t.TempDir()
if err := os.WriteFile(filepath.Join(outside, "f.md"), []byte("x"), 0o644); err != nil {
t.Fatal(err)
}
for p, content := range files {
full := filepath.Join(root, p)
if strings.HasSuffix(p, "/") {
must(t, os.MkdirAll(full, 0o755))
continue
}
must(t, os.MkdirAll(filepath.Dir(full), 0o755))
must(t, os.WriteFile(full, []byte(content), 0o644))
}
for p, target := range links {
must(t, os.MkdirAll(filepath.Dir(filepath.Join(root, p)), 0o755))
must(t, os.Symlink(strings.Replace(target, "@outside", outside, 1), filepath.Join(root, p)))
}
return root
}
func must(t *testing.T, err error) {
t.Helper()
if err != nil {
t.Fatal(err)
}
}
var wantRe = regexp.MustCompile(`^(.*?:\d+): (.*)$`)
// expect requires got and want to pair up one to one. A want is "path:line: message substring"; the path may be a suffix.
func expect(t *testing.T, got []Problem, want []string) {
t.Helper()
left := append([]Problem(nil), got...)
for _, w := range want {
m := wantRe.FindStringSubmatch(w)
found := false
for i, p := range left {
if strings.HasSuffix(fmt.Sprintf("%s:%d", p.Path, p.Line), m[1]) && strings.Contains(p.Msg, m[2]) {
left = append(left[:i], left[i+1:]...)
found = true
break
}
}
if !found {
t.Errorf("missing problem %q in %v", w, got)
}
}
for _, p := range left {
t.Errorf("unexpected problem %s", p)
}
}
var support = map[string]string{
bPath: bBase,
pPath: planBase,
"docs/spec.txt": "spec",
"docs/sp ace.md": "space",
}
// withSupport adds the shared targets to a case's files.
func withSupport(files map[string]string) map[string]string {
all := map[string]string{}
for k, v := range support {
all[k] = v
}
for k, v := range files {
all[k] = v
}
return all
}
func TestCheck(t *testing.T) {
long := strings.Repeat("a", 81)
tests := []struct {
name string
files map[string]string
links map[string]string
want []string
}{
// 1. Files and directories
{name: "dot entries and README are skipped", files: map[string]string{"docs/adr/.DS_Store": "x", "docs/adr/README.md": "x", "docs/plans/README.md": "x"}},
{name: "subdirectory", files: map[string]string{"docs/adr/sub/": ""}, want: []string{"docs/adr/sub:1: regular file"}},
{name: "non-md file", files: map[string]string{"docs/plans/notes.txt": "x"}, want: []string{"docs/plans/notes.txt:1: name must be"}},
{name: "template-like name", files: map[string]string{"docs/adr/template.md": "x"}, want: []string{"docs/adr/template.md:1: name must be"}},
{name: "symlinked record", files: map[string]string{"docs/spec.txt": "x"}, links: map[string]string{"docs/adr/20261023T204512345Z-s.md": "@outside/f.md"}, want: []string{"20261023T204512345Z-s.md:1: regular file"}},
{name: "CRLF accepted", files: map[string]string{aPath: strings.ReplaceAll(adrBase, "\n", "\r\n")}},
{name: "BOM", files: map[string]string{aPath: "\xef\xbb\xbf" + adrBase}, want: []string{aPath + ":1: byte order mark"}},
{name: "invalid UTF-8", files: map[string]string{aPath: adrBase + "\xff\n"}, want: []string{aPath + ":1: UTF-8"}},
// 2. Names and IDs
{name: "invalid timestamp", files: map[string]string{"docs/adr/20261323T204512345Z-x.md": adrBase}, want: []string{"20261323T204512345Z-x.md:1: invalid UTC timestamp"}},
{name: "slug double hyphen", files: map[string]string{"docs/adr/20261023T204512345Z-a--b.md": adrBase}, want: []string{"a--b.md:1: slug must be"}},
{name: "slug uppercase", files: map[string]string{"docs/adr/20261023T204512345Z-Ab.md": adrBase}, want: []string{"Ab.md:1: slug must be"}},
{name: "slug trailing hyphen", files: map[string]string{"docs/adr/20261023T204512345Z-ab-.md": adrBase}, want: []string{"ab-.md:1: slug must be"}},
{name: "slug 80 characters", files: map[string]string{"docs/adr/20261023T204512345Z-" + long[:80] + ".md": adrBase}},
{name: "slug 81 characters", files: map[string]string{"docs/adr/20261023T204512345Z-" + long + ".md": adrBase}, want: []string{".md:1: longer than 80"}},
{name: "duplicate ID across directories", files: map[string]string{"docs/adr/20261023T210000000Z-adopt-queue.md": adrBase, pPath: planBase},
want: []string{"docs/adr/20261023T210000000Z-adopt-queue.md:1: duplicate ID", pPath + ":1: duplicate ID"}},
// 3. Frontmatter
{name: "no frontmatter", files: map[string]string{aPath: "# Use Queue\n"}, want: []string{aPath + ":1: --- frontmatter"}},
{name: "unterminated frontmatter", files: map[string]string{aPath: "---\ntitle: x\n"}, want: []string{aPath + ":1: not closed"}},
{name: "empty frontmatter", files: map[string]string{aPath: "---\n---\n# x\n"}, want: []string{aPath + ":2: empty"}},
{name: "frontmatter is a list", files: map[string]string{aPath: "---\n- a\n---\n"}, want: []string{aPath + ":2: mapping"}},
{name: "invalid YAML", files: map[string]string{aPath: sub(adrBase, "title: Use Queue", "title: [")}, want: []string{aPath + ":3: invalid YAML"}},
{name: "multiple YAML documents", files: map[string]string{aPath: sub(adrBase, "title: Use Queue\n", "title: Use Queue\n...\nx: y\n")}, want: []string{aPath + ":2: single YAML document"}},
{name: "anchor and alias", files: map[string]string{aPath: sub(adrBase, "supersedes: []\nsuperseded_by: []", "supersedes: &a []\nsuperseded_by: *a")}, want: []string{aPath + ":9: anchors", aPath + ":10: aliases"}},
{name: "explicit tag", files: map[string]string{aPath: sub(adrBase, "summary: Run", "summary: !!str Run")}, want: []string{aPath + ":6: explicit"}},
{name: "unknown key", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by: []\nextra: x")}, want: []string{aPath + ":14: unknown key"}},
{name: "missing key", files: map[string]string{aPath: sub(adrBase, "related: []\n", "")}, want: []string{aPath + ":1: missing key \"related\""}},
{name: "duplicate key", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by: []\nsummary: again")}, want: []string{aPath + ":14: duplicate key"}},
{name: "null tilde", files: map[string]string{aPath: sub(adrBase, "summary: Run jobs on a queue.", "summary: ~")}, want: []string{aPath + ":6: must not be null"}},
{name: "null empty", files: map[string]string{aPath: sub(adrBase, "summary: Run jobs on a queue.", "summary:")}, want: []string{aPath + ":6: must not be null"}},
{name: "null word", files: map[string]string{aPath: sub(adrBase, "summary: Run jobs on a queue.", "summary: Null")}, want: []string{aPath + ":6: must not be null"}},
{name: "scalars are literal text", files: map[string]string{aPath: sub(adrBase, "title: Use Queue", "title: 2026", "# Use Queue", "# 2026", "date: 2026-10-23", `date: "2026-10-23"`, "summary: Run jobs on a queue.", `summary: "null"`)}},
{name: "null lowercase", files: map[string]string{aPath: sub(adrBase, "summary: Run jobs on a queue.", "summary: null")}, want: []string{aPath + ":6: must not be null"}},
{name: "null uppercase", files: map[string]string{aPath: sub(adrBase, "summary: Run jobs on a queue.", "summary: NULL")}, want: []string{aPath + ":6: must not be null"}},
{name: "list item is null", files: map[string]string{aPath: sub(adrBase, "related: []", "related:\n - ~")}, want: []string{aPath + ":12: must not be null"}},
// 3.1 ADR keys
{name: "empty title", files: map[string]string{aPath: sub(adrBase, "title: Use Queue", `title: ""`)}, want: []string{aPath + ":2: title must be a non-empty single line"}},
{name: "multi-line summary", files: map[string]string{aPath: sub(adrBase, "summary: Run jobs on a queue.", "summary: |\n a\n b")}, want: []string{aPath + ":6: summary must be a non-empty single line"}},
{name: "title is a list", files: map[string]string{aPath: sub(adrBase, "title: Use Queue", "title: [a]")}, want: []string{aPath + ":2: title must be a string"}},
{name: "invalid date", files: map[string]string{aPath: sub(adrBase, "date: 2026-10-23", "date: 2026-13-40")}, want: []string{aPath + ":3: valid YYYY-MM-DD"}},
{name: "date differs from filename", files: map[string]string{aPath: sub(adrBase, "date: 2026-10-23", "date: 2026-10-24")}, want: []string{aPath + ":3: does not match"}},
{name: "invalid status", files: map[string]string{aPath: sub(adrBase, "status: proposed", "status: done")}, want: []string{aPath + ":4: status must be one of"}},
{name: "invalid implementation", files: map[string]string{aPath: sub(adrBase, "implementation: not-started", "implementation: done")}, want: []string{aPath + ":5: implementation must be one of"}},
{name: "empty tags", files: map[string]string{aPath: sub(adrBase, "tags:\n - jobs", "tags: []")}, want: []string{aPath + ":7: tags must not be empty"}},
{name: "tags is a string", files: map[string]string{aPath: sub(adrBase, "tags:\n - jobs", "tags: jobs")}, want: []string{aPath + ":7: tags must be a list"}},
{name: "bad tag", files: map[string]string{aPath: sub(adrBase, " - jobs", " - Bad_Tag")}, want: []string{aPath + ":8: tag"}},
{name: "duplicate tag", files: map[string]string{aPath: sub(adrBase, " - jobs", " - jobs\n - jobs")}, want: []string{aPath + ":9: duplicate tag"}},
// 3.2 Plan keys
{name: "plan has unknown title key", files: map[string]string{pPath: sub(planBase, "status: draft", "status: draft\ntitle: x")}, want: []string{pPath + ":3: unknown key"}},
{name: "plan invalid status", files: map[string]string{pPath: sub(planBase, "status: draft", "status: done")}, want: []string{pPath + ":2: status must be one of"}},
// 3.3 References
{name: "related accepts ADR and plan", files: map[string]string{aPath: sub(adrBase, "related: []", "related:\n - /"+bPath+"\n - /"+pPath)}},
{name: "ADR tracking accepts URL and plan", files: map[string]string{aPath: sub(adrBase, "tracking: []", "tracking:\n - https://example.com/issues/1\n - /"+pPath)}},
{name: "ADR tracking rejects ADR path", files: map[string]string{aPath: sub(adrBase, "tracking: []", "tracking:\n - /"+bPath)}, want: []string{aPath + ":13: tracking"}},
{name: "plan tracking rejects path", files: map[string]string{pPath: sub(planBase, "tracking: []", "tracking:\n - /"+aPath)}, want: []string{pPath + ":4: tracking"}},
{name: "plan tracking accepts URL", files: map[string]string{pPath: sub(planBase, "tracking: []", "tracking:\n - https://example.com/issues/1")}},
{name: "plan adrs accepts ADR", files: map[string]string{aPath: adrBase, pPath: sub(planBase, "adrs: []", "adrs:\n - /"+aPath)}},
{name: "plan adrs rejects plan", files: map[string]string{pPath: sub(planBase, "adrs: []", "adrs:\n - /"+pPath)}, want: []string{pPath + ":5: adrs"}},
{name: "implemented_by accepts URL and file", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by:\n - https://example.com/pr/1\n - /docs/spec.txt")}},
{name: "implemented_by missing file", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by:\n - /docs/missing.txt")}, want: []string{aPath + ":14: does not exist"}},
{name: "reference to missing ADR", files: map[string]string{aPath: sub(adrBase, "related: []", "related:\n - /docs/adr/20261023T000000000Z-gone.md")}, want: []string{aPath + ":12: does not exist"}},
{name: "duplicate reference", files: map[string]string{aPath: sub(adrBase, "related: []", "related:\n - /"+bPath+"\n - /"+bPath)}, want: []string{aPath + ":13: duplicate reference"}},
{name: "self reference", files: map[string]string{aPath: sub(adrBase, "related: []", "related:\n - /"+aPath)}, want: []string{aPath + ":12: itself"}},
{name: "bare issue number", files: map[string]string{aPath: sub(adrBase, "tracking: []", "tracking:\n - \"#123\"")}, want: []string{aPath + ":13: not durable"}},
{name: "owner repo issue number", files: map[string]string{aPath: sub(adrBase, "tracking: []", "tracking:\n - example/repo#123")}, want: []string{aPath + ":13: not durable"}},
{name: "this PR placeholder", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by:\n - This PR")}, want: []string{aPath + ":14: not durable"}},
{name: "fragment in frontmatter", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by:\n - /docs/spec.txt#x")}, want: []string{aPath + ":14: fragments"}},
{name: "credentials in frontmatter URL", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by:\n - https://u:p@example.com/x")}, want: []string{aPath + ":14: credentials"}},
{name: "mailto in frontmatter", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by:\n - mailto:a@example.com")}, want: []string{aPath + ":14: scheme"}},
{name: "anchor in frontmatter", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by:\n - \"#anchor\"")}, want: []string{aPath + ":14: relative"}},
{name: "symlink escape in frontmatter", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by:\n - /docs/out/f.md")}, links: map[string]string{"docs/out": "@outside"}, want: []string{aPath + ":14: outside the repository"}},
{name: "percent-encoded self reference", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by:\n - /docs/adr/20261023T204512345Z-use%2Dqueue.md")}, want: []string{aPath + ":14: itself"}},
{name: "supersedes rejects plan path", files: map[string]string{aPath: sub(adrBase, "status: proposed", "status: accepted", "supersedes: []", "supersedes:\n - /"+pPath)}, want: []string{aPath + ":10: supersedes"}},
{name: "relative path in frontmatter", files: map[string]string{aPath: sub(adrBase, "implemented_by: []", "implemented_by:\n - ../docs/spec.txt")}, want: []string{aPath + ":14: relative"}},
// 4. Status
{name: "superseded needs superseded_by", files: map[string]string{aPath: sub(adrBase, "status: proposed", "status: superseded")}, want: []string{aPath + ":4: requires superseded_by"}},
{name: "superseded_by needs superseded", files: map[string]string{aPath: sub(adrBase, "superseded_by: []", "superseded_by:\n - /"+bPath), bPath: sub(bBase, "supersedes: []", "supersedes:\n - /"+aPath)}, want: []string{aPath + ":10: requires status superseded"}},
{name: "rejected needs not-applicable", files: map[string]string{aPath: sub(adrBase, "status: proposed", "status: rejected")}, want: []string{aPath + ":5: not-applicable"}},
{name: "rejected not-applicable", files: map[string]string{aPath: sub(adrBase, "status: proposed", "status: rejected", "implementation: not-started", "implementation: not-applicable")}},
{name: "implemented needs implemented_by", files: map[string]string{aPath: sub(adrBase, "implementation: not-started", "implementation: implemented")}, want: []string{aPath + ":5: requires implemented_by"}},
{name: "implemented with implemented_by", files: map[string]string{aPath: sub(adrBase, "implementation: not-started", "implementation: implemented", "implemented_by: []", "implemented_by:\n - https://example.com/pr/1")}},
{name: "active plan needs tracking", files: map[string]string{pPath: sub(planBase, "status: draft", "status: active")}, want: []string{pPath + ":2: requires tracking"}},
{name: "active plan valid", files: map[string]string{pPath: sub(planBase, "status: draft", "status: active", "tracking: []", "tracking:\n - https://example.com/issues/1")}},
{name: "active plan with completion", files: map[string]string{pPath: sub(planBase, "status: draft", "status: active", "tracking: []", "tracking:\n - https://example.com/issues/1", "completion: []", "completion:\n - https://example.com/pr/1")}, want: []string{pPath + ":6: completion must be empty"}},
{name: "draft plan with completion", files: map[string]string{pPath: sub(planBase, "completion: []", "completion:\n - https://example.com/pr/1")}, want: []string{pPath + ":5: completion must be empty"}},
{name: "completed plan needs completion", files: map[string]string{pPath: sub(planBase, "status: draft", "status: completed")}, want: []string{pPath + ":2: requires completion"}},
{name: "cancelled plan needs completion", files: map[string]string{pPath: sub(planBase, "status: draft", "status: cancelled")}, want: []string{pPath + ":2: requires completion"}},
{name: "completed plan valid", files: map[string]string{pPath: sub(planBase, "status: draft", "status: completed", "completion: []", "completion:\n - https://example.com/pr/1")}},
// 5. Supersession
{name: "supersession valid", files: map[string]string{
aPath: sub(adrBase, "status: proposed", "status: superseded", "superseded_by: []", "superseded_by:\n - /"+bPath),
bPath: sub(bBase, "supersedes: []", "supersedes:\n - /"+aPath)}},
{name: "supersedes not reciprocated", files: map[string]string{aPath: sub(adrBase, "status: proposed", "status: accepted", "supersedes: []", "supersedes:\n - /"+bPath)}, want: []string{aPath + ":10: must list this record in superseded_by"}},
{name: "superseded_by not reciprocated", files: map[string]string{aPath: sub(adrBase, "status: proposed", "status: superseded", "superseded_by: []", "superseded_by:\n - /"+bPath)}, want: []string{aPath + ":11: must list this record in supersedes"}},
{name: "superseder is proposed", files: map[string]string{
aPath: sub(adrBase, "supersedes: []", "supersedes:\n - /"+bPath),
bPath: sub(bBase, "status: accepted", "status: superseded", "superseded_by: []", "superseded_by:\n - /"+aPath)}, want: []string{aPath + ":9: must be accepted"}},
{name: "superseder is deprecated", files: map[string]string{
aPath: sub(adrBase, "status: proposed", "status: superseded", "superseded_by: []", "superseded_by:\n - /"+bPath),
bPath: sub(bBase, "status: accepted", "status: deprecated", "supersedes: []", "supersedes:\n - /"+aPath)}},
{name: "superseder is rejected", files: map[string]string{
aPath: sub(adrBase, "status: proposed", "status: rejected", "implementation: not-started", "implementation: not-applicable", "supersedes: []", "supersedes:\n - /"+bPath),
bPath: sub(bBase, "status: accepted", "status: superseded", "superseded_by: []", "superseded_by:\n - /"+aPath)}, want: []string{aPath + ":9: must be accepted"}},
{name: "supersession cycle", files: map[string]string{
aPath: sub(adrBase, "status: proposed", "status: superseded", "supersedes: []", "supersedes:\n - /"+bPath, "superseded_by: []", "superseded_by:\n - /"+bPath),
bPath: sub(bBase, "status: accepted", "status: superseded", "supersedes: []", "supersedes:\n - /"+aPath, "superseded_by: []", "superseded_by:\n - /"+aPath)}, want: []string{bPath + ":10: cycle"}},
// 6. Body
{name: "no H1", files: map[string]string{aPath: sub(adrBase, "# Use Queue\n\n", "")}, want: []string{aPath + ":15: first heading must be an H1"}},
{name: "H1 differs from title", files: map[string]string{aPath: sub(adrBase, "# Use Queue", "# Other")}, want: []string{aPath + ":16: must equal title"}},
{name: "two H1s", files: map[string]string{aPath: adrBase + "\n# Again\n"}, want: []string{aPath + ":35: more than one H1"}},
{name: "missing required section", files: map[string]string{aPath: sub(adrBase, "## Considered Options\n\n* Queue\n* Inline\n\n", "")}, want: []string{aPath + ":1: missing required section \"Considered Options\""}},
{name: "repeated section", files: map[string]string{aPath: adrBase + "\n## Considered Options\n\nMore.\n"}, want: []string{aPath + ":35: appears more than once"}},
{name: "heading in code does not count", files: map[string]string{aPath: sub(adrBase, "## Considered Options", "```\n## Considered Options\n```")}, want: []string{aPath + ":1: missing required section \"Considered Options\""}},
{name: "section with only a comment", files: map[string]string{aPath: sub(adrBase, "* Queue\n* Inline", "<!-- none -->")}, want: []string{aPath + ":22: has no prose"}},
{name: "section with only code", files: map[string]string{aPath: sub(adrBase, "* Queue\n* Inline", "```\nQueue\n```")}, want: []string{aPath + ":22: has no prose"}},
{name: "section with only inline code", files: map[string]string{aPath: sub(adrBase, "* Queue\n* Inline", "`Queue`")}, want: []string{aPath + ":22: has no prose"}},
{name: "subsection prose counts for the section", files: map[string]string{aPath: sub(adrBase, "Jobs block requests.", "### Detail\n\nJobs block requests.")}},
{name: "setext, closing hashes and blockquote", files: map[string]string{aPath: sub(adrBase, "## Context and Problem Statement", "## Context and Problem Statement ##", "## Considered Options\n\n* Queue\n* Inline", "Considered Options\n------\n\n> Queue or inline.")}},
{name: "extra sections allowed", files: map[string]string{aPath: adrBase + "\n## More Information\n\nSee above.\n"}},
{name: "Consequences as H2", files: map[string]string{aPath: sub(adrBase, "### Consequences", "## Consequences")},
want: []string{aPath + ":31: not a ## section", aPath + ":27: must contain a ### Consequences"}},
{name: "missing Consequences", files: map[string]string{aPath: sub(adrBase, "### Consequences\n\n* One more service.\n", "")}, want: []string{aPath + ":27: must contain a ### Consequences"}},
{name: "repeated Consequences", files: map[string]string{aPath: adrBase + "\n### Consequences\n\nAgain.\n"}, want: []string{aPath + ":35: appears more than once"}},
{name: "Consequences without prose", files: map[string]string{aPath: sub(adrBase, "* One more service.", "<!-- later -->")}, want: []string{aPath + ":31: has no prose"}},
{name: "Decision Outcome without own prose", files: map[string]string{aPath: sub(adrBase, "Chosen option: Queue.\n\n", "")}, want: []string{aPath + ":27: needs prose before"}},
{name: "plan missing section", files: map[string]string{pPath: sub(planBase, "## Steps\n\n1. Do it.\n\n", "")}, want: []string{pPath + ":1: missing required section \"Steps\""}},
{name: "plan empty H1", files: map[string]string{pPath: sub(planBase, "# Adopt Queue", "#")}, want: []string{pPath + ":8: H1"}},
{name: "empty ADR H1 is on its own line", files: map[string]string{aPath: sub(adrBase, "# Use Queue", "#")}, want: []string{aPath + ":16: must equal title"}},
{name: "empty H2 after a paragraph", files: map[string]string{aPath: adrBase + "\nText.\n\n##\n"}},
{name: "H1 after an empty H2 after a paragraph", files: map[string]string{aPath: adrBase + "\nText.\n\n##\n#\n"}, want: []string{aPath + ":38: more than one H1"}},
{name: "empty H1 after a thematic break", files: map[string]string{aPath: adrBase + "\n***\n#\n"}, want: []string{aPath + ":36: more than one H1"}},
{name: "two empty H1s", files: map[string]string{aPath: adrBase + "\n#\n#\n"}, want: []string{aPath + ":35: more than one H1", aPath + ":36: more than one H1"}},
{name: "headings inside blockquotes and lists do not count", files: map[string]string{aPath: adrBase + "\n> ## Consequences\n\n* ## Decision Outcome\n"}},
{name: "H4 does not end the Decision Outcome prose", files: map[string]string{aPath: sub(adrBase, "Chosen option: Queue.", "#### Detail\n\nChosen.")}},
{name: "plan second H1", files: map[string]string{pPath: planBase + "\n# Again\n"}, want: []string{pPath + ":22: more than one H1"}},
{name: "plan repeated section", files: map[string]string{pPath: planBase + "\n## Scope\n\nMore.\n"}, want: []string{pPath + ":22: appears more than once"}},
{name: "plan section without prose", files: map[string]string{pPath: sub(planBase, "1. Do it.", "<!-- later -->")}, want: []string{pPath + ":14: has no prose"}},
{name: "plan Outcome is optional", files: map[string]string{pPath: planBase + "\n## Outcome\n\nDone.\n"}},
// 6.3 Placeholders
{name: "marker in body", files: map[string]string{aPath: sub(adrBase, "Jobs block requests.", "{{docs:todo}}")}, want: []string{aPath + ":20: unfinished placeholder"}},
{name: "marker in comment", files: map[string]string{aPath: adrBase + "\n<!-- {{docs:todo}} -->\n"}, want: []string{aPath + ":35: unfinished placeholder"}},
{name: "marker in code", files: map[string]string{aPath: adrBase + "\nUse `{{docs:todo}}` as the marker.\n\n```\n{{docs:todo}}\n```\n"}},
{name: "TODO and TBD are fine", files: map[string]string{aPath: adrBase + "\nTODO and TBD.\n"}},
{name: "marker in frontmatter string", files: map[string]string{aPath: sub(adrBase, "summary: Run jobs on a queue.", `summary: "{{docs:todo}}"`)}, want: []string{aPath + ":6: unfinished placeholder"}},
{name: "marker as tag reports only the marker", files: map[string]string{aPath: sub(adrBase, " - jobs", ` - "{{docs:todo}}"`)}, want: []string{aPath + ":8: unfinished placeholder"}},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
res, err := Check(tree(t, withSupport(tt.files), tt.links))
must(t, err)
expect(t, res.Problems, tt.want)
})
}
}
func TestCheckSymlinkedDocsDir(t *testing.T) {
res, err := Check(tree(t, nil, map[string]string{"docs/plans": "@outside"}))
must(t, err)
expect(t, res.Problems, []string{"docs/plans:1: real directory"})
}
func TestCheckSymlinkedDocsParent(t *testing.T) {
root := tree(t, nil, map[string]string{"docs": "@outside"})
out, err := os.Readlink(filepath.Join(root, "docs"))
must(t, err)
must(t, os.MkdirAll(filepath.Join(out, "adr"), 0o755))
res, err := Check(root)
must(t, err)
expect(t, res.Problems, []string{"docs/adr:1: inside the repository"})
}
func TestCheckEmptyRoot(t *testing.T) {
res, err := Check(t.TempDir())
must(t, err)
if res.Records != 0 || len(res.Problems) != 0 {
t.Fatalf("got %+v", res)
}
}
+229
View File
@@ -0,0 +1,229 @@
package docs
import (
"errors"
"io"
"regexp"
"slices"
"strconv"
"strings"
"go.yaml.in/yaml/v3"
)
const marker = "{{docs:todo}}"
var yamlLineRe = regexp.MustCompile(`line (\d+)`)
type field struct{ key, val *yaml.Node }
type item struct {
v string
line int
}
// fm reads the typed fields of one record's frontmatter mapping.
type fm struct {
c *checker
r *record
f map[string]field
}
// splitFrontmatter returns the frontmatter text, the body and the file line the body starts on.
func splitFrontmatter(src string) (front, body string, bodyLine int, msg string) {
lines := strings.Split(src, "\n")
if lines[0] != "---" {
return "", "", 0, "file must start with a --- frontmatter line"
}
for i := 1; i < len(lines); i++ {
if lines[i] == "---" {
return strings.Join(lines[1:i], "\n"), strings.Join(lines[i+1:], "\n"), i + 2, ""
}
}
return "", "", 0, "frontmatter is not closed by a --- line"
}
// parseFrontmatter decodes the mapping and rejects anything but plain keys and values.
func (c *checker) parseFrontmatter(r *record, front string) (*fm, bool) {
report := func(line int, format string, args ...any) { c.add(r.path, line, format, args...) }
dec := yaml.NewDecoder(strings.NewReader(front))
var doc, extra yaml.Node
if err := dec.Decode(&doc); err != nil || len(doc.Content) == 0 {
if err == nil || errors.Is(err, io.EOF) {
report(2, "frontmatter is empty")
} else {
line := 2
if m := yamlLineRe.FindStringSubmatch(err.Error()); m != nil {
n, _ := strconv.Atoi(m[1])
line += n - 1
}
report(line, "invalid YAML: %v", strings.TrimPrefix(err.Error(), "yaml: "))
}
return nil, false
}
if err := dec.Decode(&extra); !errors.Is(err, io.EOF) {
report(2, "frontmatter must be a single YAML document")
return nil, false
}
root := doc.Content[0]
if root.Kind != yaml.MappingNode {
report(root.Line+1, "frontmatter must be a mapping")
return nil, false
}
ok := true
var walk func(n *yaml.Node)
walk = func(n *yaml.Node) {
switch {
case n.Kind == yaml.AliasNode:
report(n.Line+1, "YAML aliases are not allowed")
ok = false
case n.Anchor != "":
report(n.Line+1, "YAML anchors are not allowed")
ok = false
case n.Style&yaml.TaggedStyle != 0:
report(n.Line+1, "explicit YAML tags are not allowed")
ok = false
}
for _, ch := range n.Content {
walk(ch)
}
}
walk(root)
m := &fm{c: c, r: r, f: map[string]field{}}
for i := 0; i+1 < len(root.Content); i += 2 {
k, v := root.Content[i], root.Content[i+1]
if k.Kind != yaml.ScalarNode {
report(k.Line+1, "keys must be plain strings")
ok = false
} else if _, dup := m.f[k.Value]; dup {
report(k.Line+1, "duplicate key %q", k.Value)
ok = false
} else {
m.f[k.Value] = field{k, v}
}
markers(v, report)
}
return m, ok
}
// markers reports an unfinished placeholder in any string value or list item.
func markers(n *yaml.Node, report func(int, string, ...any)) {
if n.Kind == yaml.ScalarNode && strings.Contains(n.Value, marker) {
report(n.Line+1, "unfinished placeholder %s", marker)
}
for _, ch := range n.Content {
markers(ch, report)
}
}
// keys reports missing and unknown keys.
func (m *fm) keys(want ...string) {
for _, k := range want {
if _, ok := m.f[k]; !ok {
m.c.add(m.r.path, 1, "missing key %q", k)
}
}
for k, f := range m.f {
if !slices.Contains(want, k) {
m.c.add(m.r.path, f.key.Line+1, "unknown key %q", k)
}
}
}
func (m *fm) line(key string) int {
if f, ok := m.f[key]; ok {
return f.key.Line + 1
}
return 1
}
func (m *fm) isNull(key string, n *yaml.Node) bool {
if n.Kind == yaml.ScalarNode && n.Tag == "!!null" {
m.c.add(m.r.path, n.Line+1, "%s must not be null", key)
return true
}
return false
}
// scalar returns the literal text of a non-null scalar value.
func (m *fm) scalar(key string) (string, int, bool) {
f, ok := m.f[key]
if !ok || m.isNull(key, f.val) {
return "", 0, false
}
if f.val.Kind != yaml.ScalarNode {
m.c.add(m.r.path, f.key.Line+1, "%s must be a string", key)
return "", 0, false
}
return f.val.Value, f.val.Line + 1, true
}
// text is a non-empty single-line string.
func (m *fm) text(key string) (string, bool) {
v, line, ok := m.scalar(key)
if ok && (strings.TrimSpace(v) == "" || strings.ContainsAny(v, "\r\n")) {
m.c.add(m.r.path, line, "%s must be a non-empty single line", key)
return v, false
}
return v, ok
}
func (m *fm) enum(key string, allowed ...string) (string, bool) {
v, line, ok := m.scalar(key)
if ok && !slices.Contains(allowed, v) {
m.c.add(m.r.path, line, "%s must be one of %s", key, strings.Join(allowed, ", "))
return v, false
}
return v, ok
}
// list returns the items of a sequence of non-null scalars.
func (m *fm) list(key string) ([]item, bool) {
f, ok := m.f[key]
if !ok || m.isNull(key, f.val) {
return nil, false
}
if f.val.Kind != yaml.SequenceNode {
m.c.add(m.r.path, f.key.Line+1, "%s must be a list", key)
return nil, false
}
var items []item
for _, n := range f.val.Content {
if m.isNull(key, n) {
continue
}
if n.Kind != yaml.ScalarNode {
m.c.add(m.r.path, n.Line+1, "%s items must be strings", key)
continue
}
items = append(items, item{n.Value, n.Line + 1})
}
m.r.lists[key] = items
return items, true
}
// tags checks the ADR tags list.
func (m *fm) tags() {
items, ok := m.list("tags")
if !ok {
return
}
if len(items) == 0 {
m.c.add(m.r.path, m.line("tags"), "tags must not be empty")
}
seen := map[string]bool{}
for _, it := range items {
switch {
case it.v == marker:
case !slugRe.MatchString(it.v):
m.c.add(m.r.path, it.line, "tag %q must be lowercase a-z0-9 words joined by single hyphens", it.v)
case seen[it.v]:
m.c.add(m.r.path, it.line, "duplicate tag %q", it.v)
}
seen[it.v] = true
}
}
func (m *fm) problemf(key, format string, args ...any) {
m.c.add(m.r.path, m.line(key), format, args...)
}
+71
View File
@@ -0,0 +1,71 @@
package docs
import (
"slices"
"strings"
)
// graph checks cross-record rules: unique IDs and supersession.
func (c *checker) graph(recs []*record) {
byStem := map[string][]*record{}
byPath := map[string]*record{}
for _, r := range recs {
byStem[r.stem] = append(byStem[r.stem], r)
byPath["/"+r.path] = r
}
for _, group := range byStem {
for _, r := range group {
for _, o := range group {
if o != r {
c.add(r.path, 1, "duplicate ID %s, also used by %s", r.stem, o.path)
}
}
}
}
adrs := recs[:0:0]
for _, r := range recs {
if r.kind == "adr" && r.fm != nil {
adrs = append(adrs, r)
}
}
for _, r := range adrs {
if len(r.lists["supersedes"]) > 0 && !slices.Contains([]string{"accepted", "superseded", "deprecated"}, r.status) {
c.add(r.path, r.fm.line("supersedes"), "a record that supersedes another must be accepted, superseded or deprecated, not %s", r.status)
}
for _, e := range [][2]string{{"supersedes", "superseded_by"}, {"superseded_by", "supersedes"}} {
for _, it := range r.lists[e[0]] {
if o := byPath[it.v]; o != nil && o.kind == "adr" && !slices.ContainsFunc(o.lists[e[1]], func(x item) bool { return x.v == "/"+r.path }) {
c.add(r.path, it.line, "%s lists %s, which must list this record in %s", e[0], it.v, e[1])
}
}
}
}
// Cycles over supersedes edges: report once, on the first record (in path order) that closes one.
const (
visiting = 1
done = 2
)
state := map[*record]int{}
var visit func(r *record)
visit = func(r *record) {
state[r] = visiting
for _, it := range r.lists["supersedes"] {
o := byPath[it.v]
if o == nil || o.kind != "adr" {
continue
}
switch state[o] {
case visiting:
c.add(r.path, it.line, "supersession cycle through %s", strings.TrimPrefix(it.v, "/"))
case 0:
visit(o)
}
}
state[r] = done
}
for _, r := range adrs {
if state[r] == 0 {
visit(r)
}
}
}
+131
View File
@@ -0,0 +1,131 @@
package docs
import (
"encoding/json"
"errors"
"fmt"
"os"
"path/filepath"
"regexp"
"strings"
"time"
)
const (
timestampLayout = "20060102T150405.000Z"
maxSlug = 80
)
var (
nameRe = regexp.MustCompile(`^(\d{8}T\d{9}Z)-(.+)\.md$`)
slugRe = regexp.MustCompile(`^[a-z0-9]+(?:-[a-z0-9]+)*$`)
)
// parseName validates a record filename and returns its stem, UTC timestamp
// and a problem message (empty when valid).
func parseName(name string) (stem string, at time.Time, msg string) {
m := nameRe.FindStringSubmatch(name)
if m == nil {
return "", at, "name must be YYYYMMDDTHHMMSSmmmZ-slug.md"
}
at, err := time.Parse(timestampLayout, m[1][:15]+"."+m[1][15:])
if err != nil {
return "", at, "name has an invalid UTC timestamp"
}
switch {
case !slugRe.MatchString(m[2]):
return "", at, "slug must be lowercase a-z0-9 words joined by single hyphens"
case len(m[2]) > maxSlug:
return "", at, fmt.Sprintf("slug is longer than %d characters", maxSlug)
}
return strings.TrimSuffix(name, ".md"), at, ""
}
// slugify lowercases title and joins its ASCII letter and digit runs with hyphens.
func slugify(title string) string {
var b strings.Builder
for _, r := range strings.ToLower(title) {
if r >= 'a' && r <= 'z' || r >= '0' && r <= '9' {
b.WriteRune(r)
} else if b.Len() > 0 && !strings.HasSuffix(b.String(), "-") {
b.WriteByte('-')
}
}
s := b.String()
return strings.Trim(s[:min(len(s), maxSlug)], "-")
}
var closingRe = regexp.MustCompile(`(^|[ \t])#+$`)
// New creates a record of the given kind ("adr" or "plan") under root and
// returns its root-relative slash path. The file is created exclusively; the
// timestamp advances by 1 ms on a collision.
func New(root, kind, title string, now time.Time) (string, error) {
title = strings.TrimSpace(title)
if title == "" || strings.ContainsAny(title, "\r\n") {
return "", errors.New("title must be non-empty and a single line")
}
if closingRe.MatchString(title) {
return "", errors.New(`title must not end in a "#" run: it would be read as a closing sequence of the H1`)
}
slug := slugify(title)
if slug == "" {
return "", errors.New("title needs at least one ASCII letter or digit for the file name")
}
var dir string
for _, d := range dirs {
if d.kind == kind {
dir = d.dir
}
}
tmpl, err := templates.ReadFile("templates/" + kind + ".md")
if err != nil {
return "", fmt.Errorf("unknown record type %q", kind)
}
quoted, err := json.Marshal(title) // JSON strings are valid YAML double-quoted scalars
if err != nil {
return "", err
}
used, err := stems(root)
if err != nil {
return "", err
}
if err := os.MkdirAll(filepath.Join(root, dir), 0o755); err != nil {
return "", err
}
at := now.UTC().Truncate(time.Millisecond)
for ; ; at = at.Add(time.Millisecond) {
stem := strings.Replace(at.Format(timestampLayout), ".", "", 1) + "-" + slug
if used[stem] {
continue
}
rel := dir + "/" + stem + ".md"
f, err := os.OpenFile(filepath.Join(root, filepath.FromSlash(rel)), os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0o644)
if errors.Is(err, os.ErrExist) {
continue
}
if err != nil {
return "", err
}
content := strings.NewReplacer("@TITLE_YAML@", string(quoted), "@TITLE@", title, "@DATE@", at.Format(time.DateOnly)).Replace(string(tmpl))
_, werr := f.WriteString(content)
return rel, errors.Join(werr, f.Close())
}
}
// stems returns the IDs of every record-named file in both directories.
func stems(root string) (map[string]bool, error) {
used := map[string]bool{}
for _, d := range dirs {
entries, err := os.ReadDir(filepath.Join(root, d.dir))
if err != nil && !errors.Is(err, os.ErrNotExist) {
return nil, err
}
for _, e := range entries {
if stem, _, msg := parseName(e.Name()); msg == "" {
used[stem] = true
}
}
}
return used, nil
}
+130
View File
@@ -0,0 +1,130 @@
package docs
import (
"os"
"path/filepath"
"strings"
"testing"
)
// TestLinkDestinations covers the section 7 rules through one body link.
func TestLinkDestinations(t *testing.T) {
tests := []struct{ dest, want string }{ // want "" means valid
{"/docs/spec.txt", ""},
{"/docs/spec.txt#frag", ""},
{"/docs/sp%20ace.md", ""},
{"#anchor", ""},
{"mailto:a@example.com", ""},
{"https://example.com/a?b=1#c", ""},
{`/docs/spec\.txt`, ""},
{"/docs/spec&#46;txt", ""},
{"/docs/spec&period;txt", ""},
{`/docs\\spec.txt`, "backslash"},
{"/docs/SPEC.txt", "does not exist"},
{"/Docs/spec.txt", "does not exist"},
{"foo.md", "relative"},
{"./foo.md", "relative"},
{"../docs/spec.txt", "relative"},
{"/docs/../docs/spec.txt", `".."`},
{"/docs/%2e%2e/docs/spec.txt", `".."`},
{`/docs\spec.txt`, "backslash"},
{`C:\spec.txt`, "backslash"},
{"//example.com/x", "protocol-relative"},
{"/docs/spec.txt?x=1", "queries"},
{"/docs/%zz", "percent-encoding"},
{"/docs/missing.txt", "does not exist"},
{"/Users/me/spec.txt", "does not exist"},
{"/docs", "not a regular file"},
{"/docs/out/f.md", "outside the repository"},
{"file:///etc/passwd", "scheme"},
{"ftp://example.com/x", "scheme"},
{"javascript:alert(1)", "scheme"},
{"https://u:p@example.com/x", "credentials"},
{"https:///nohost", "host"},
{"<>", "empty"},
}
for _, tt := range tests {
t.Run(tt.dest, func(t *testing.T) {
dest := tt.dest
if strings.ContainsAny(dest, " ") {
dest = "<" + dest + ">"
}
doc := adrBase + "\nSee [x](" + dest + ").\n"
res, err := Check(tree(t, withSupport(map[string]string{aPath: doc}), map[string]string{"docs/out": "@outside"}))
must(t, err)
var want []string
if tt.want != "" {
want = []string{aPath + ":35: " + tt.want}
}
expect(t, res.Problems, want)
})
}
}
// TestLinkForms covers which Markdown constructs are link destinations.
func TestLinkForms(t *testing.T) {
tests := []struct {
name, body string
want []string
}{
{"image", "![x](foo.md)", []string{":35: relative"}},
{"autolink", "<ftp://example.com/x>", []string{":35: scheme"}},
{"reference link and definition", "[x][r]\n\n[r]: foo.md", []string{":35: relative", ":37: relative"}},
{"duplicate definition is checked", "[a]: /docs/spec.txt\n\n[a]: ../bad.md", []string{":37: relative"}},
{"definition in a blockquote", "> [Zed]: ../bad.md", []string{":35: relative"}},
{"definition-like line in code", "```\n[a]: x\n```\n\n[a]: ../bad.md", []string{":39: relative"}},
{"definition-like paragraph continuation", "Some text\n[a]: ../x.md\n\n[a]: ../bad.md", []string{":36: relative", ":38: relative"}}, // [a] in the text is a reference link
{"definition-like line in an HTML comment", "<!--\n[a]: x\n-->\n\n[a]: ../bad.md", []string{":39: relative"}},
{"autolink on a later line", "Para one\nline two\n<ftp://example.com/x>", []string{":37: scheme"}},
{"image without alt on a later line", "Para one\nline two\n![](foo.md)", []string{":37: relative"}},
{"unused definition", "[r]: foo.md", []string{":35: relative"}},
{"link in a list", "* [x](foo.md)", []string{":35: relative"}},
{"bare URL and raw HTML are not checked", "http://u:p@example.com and @user #123 abc1234\n\n<a href=\"foo.md\">x</a>", nil},
{"link in code is not a link", "`[x](foo.md)`\n\n```\n[x](foo.md)\n```", nil},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
res, err := Check(tree(t, withSupport(map[string]string{aPath: adrBase + "\n" + tt.body + "\n"}), nil))
must(t, err)
var want []string
for _, w := range tt.want {
want = append(want, aPath+w)
}
expect(t, res.Problems, want)
})
}
}
// TestSpecExamples keeps the minimal examples in docs/docs-format.md valid.
func TestSpecExamples(t *testing.T) {
spec, err := os.ReadFile("../../docs/docs-format.md")
must(t, err)
root := t.TempDir()
parts := strings.Split(string(spec[strings.Index(string(spec), "## 9."):]), "```markdown\n")
if len(parts) != 3 {
t.Fatalf("expected two examples, got %d", len(parts)-1)
}
// The path of each example is the backticked name on the line before its fence.
heads := strings.Split(string(spec[strings.Index(string(spec), "## 9."):]), "\n")
var paths []string
for _, l := range heads {
if strings.HasPrefix(l, "`docs/") {
paths = append(paths, strings.Trim(l, "`:"))
}
}
if len(paths) != 2 {
t.Fatalf("expected two example paths, got %v", paths)
}
for i, part := range parts[1:] {
body, _, _ := strings.Cut(part, "```")
full := filepath.Join(root, paths[i])
must(t, os.MkdirAll(filepath.Dir(full), 0o755))
must(t, os.WriteFile(full, []byte(body), 0o644))
}
res, err := Check(root)
must(t, err)
expect(t, res.Problems, nil)
if res.Records != 2 {
t.Fatalf("records = %d", res.Records)
}
}
+104
View File
@@ -0,0 +1,104 @@
package docs
import (
"os"
"path/filepath"
"strings"
"testing"
"time"
)
var now = time.Date(2026, 10, 23, 20, 45, 12, 345_000_000, time.UTC)
// TestNewTemplates checks that fresh records fail only on their markers and
// become valid once those are replaced.
func TestNewTemplates(t *testing.T) {
for _, tt := range []struct {
kind, path string
markers int
}{
{"adr", "docs/adr/20261023T204512345Z-use-x-y.md", 6},
{"plan", "docs/plans/20261023T204512345Z-use-x-y.md", 3},
} {
t.Run(tt.kind, func(t *testing.T) {
root := t.TempDir()
path, err := New(root, tt.kind, `Use "X" & Y`, now)
must(t, err)
if path != tt.path {
t.Fatalf("path = %s", path)
}
res, err := Check(root)
must(t, err)
if len(res.Problems) != tt.markers {
t.Fatalf("got %v, want %d marker problems", res.Problems, tt.markers)
}
for _, p := range res.Problems {
if !strings.Contains(p.Msg, marker) {
t.Errorf("not a marker problem: %s", p)
}
}
data, err := os.ReadFile(filepath.Join(root, path))
must(t, err)
must(t, os.WriteFile(filepath.Join(root, path), []byte(strings.ReplaceAll(string(data), marker, "x")), 0o644))
res, err = Check(root)
must(t, err)
expect(t, res.Problems, nil)
})
}
}
func TestNewCollisions(t *testing.T) {
root := t.TempDir()
first, err := New(root, "adr", "Same", now)
must(t, err)
second, err := New(root, "adr", "Same", now)
must(t, err)
// The same stem in the other directory also advances the timestamp.
third, err := New(root, "plan", "Same", now)
must(t, err)
want := []string{
"docs/adr/20261023T204512345Z-same.md",
"docs/adr/20261023T204512346Z-same.md",
"docs/plans/20261023T204512347Z-same.md",
}
for i, got := range []string{first, second, third} {
if got != want[i] {
t.Errorf("file %d = %s, want %s", i, got, want[i])
}
}
// Advancing across midnight keeps the date equal to the filename.
root = t.TempDir()
_, err = New(root, "adr", "Edge", time.Date(2026, 10, 23, 23, 59, 59, 999_000_000, time.UTC))
must(t, err)
got, err := New(root, "adr", "Edge", time.Date(2026, 10, 23, 23, 59, 59, 999_000_000, time.UTC))
must(t, err)
if got != "docs/adr/20261024T000000000Z-edge.md" {
t.Fatalf("got %s", got)
}
res, err := Check(root)
must(t, err)
for _, p := range res.Problems {
if !strings.Contains(p.Msg, marker) {
t.Errorf("unexpected %s", p)
}
}
}
func TestNewRejectsBadTitles(t *testing.T) {
for _, title := range []string{"", " ", "a\nb", "!!!", "Drop C #", "#", "C ##"} {
if path, err := New(t.TempDir(), "adr", title, now); err == nil {
t.Errorf("title %q created %s", title, path)
}
}
}
func TestSlugify(t *testing.T) {
for in, want := range map[string]string{"Use X, Y & Z!": "use-x-y-z", " --Hello-- ": "hello", "Ünï": "n"} {
if got := slugify(in); got != want {
t.Errorf("slugify(%q) = %q, want %q", in, got, want)
}
}
if got := slugify(strings.Repeat("ab ", 40)); len(got) != maxSlug || strings.HasSuffix(got, "-") {
t.Errorf("long slug = %q", got)
}
}
+23
View File
@@ -0,0 +1,23 @@
package docs
var planRefs = []refSpec{{"tracking", kURL}, {"adrs", kAdr}, {"completion", kURL | kFile}}
func (c *checker) plan(r *record, m *fm) {
m.keys("status", "tracking", "adrs", "completion")
status, ok := m.enum("status", "draft", "active", "completed", "cancelled")
m.refs(planRefs...)
r.status = status
if !ok {
return
}
closed := status == "completed" || status == "cancelled"
if status == "active" && len(r.lists["tracking"]) == 0 {
m.problemf("status", "status active requires tracking")
}
if closed && len(r.lists["completion"]) == 0 {
m.problemf("status", "status %s requires completion", status)
}
if !closed && len(r.lists["completion"]) > 0 {
m.problemf("completion", "completion must be empty while status is %s", status)
}
}
+194
View File
@@ -0,0 +1,194 @@
package docs
import (
"fmt"
"net/url"
"os"
"path/filepath"
"regexp"
"slices"
"strings"
)
// kinds is the set of reference forms a frontmatter key accepts.
type kinds uint8
const (
kAdr kinds = 1 << iota
kPlan
kURL
kFile
)
type refSpec struct {
key string
kinds kinds
}
var (
schemeRe = regexp.MustCompile(`^([A-Za-z][A-Za-z0-9+.-]*):`)
durableRe = regexp.MustCompile(`^([A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+)?#\d+$`)
idPattern = `\d{8}T\d{9}Z-[a-z0-9]+(?:-[a-z0-9]+)*`
adrPathRe = regexp.MustCompile(`^/docs/adr/` + idPattern + `\.md$`)
planPathRe = regexp.MustCompile(`^/docs/plans/` + idPattern + `\.md$`)
)
type ref struct {
path string // decoded repo-root path; empty for URLs and anchors
remote bool
}
// parseRef checks the syntax of a reference. body allows #anchors, mailto: and #fragments.
func parseRef(v string, body bool) (ref, string) {
if v == "" {
return ref{}, "empty reference"
}
if strings.Contains(v, `\`) {
return ref{}, "backslashes are not allowed"
}
if body && v[0] == '#' {
return ref{}, ""
}
if m := schemeRe.FindStringSubmatch(v); m != nil {
switch strings.ToLower(m[1]) {
case "http", "https":
u, err := url.Parse(v)
switch {
case err != nil || u.Hostname() == "":
return ref{}, "URL must have a host"
case u.User != nil:
return ref{}, "URL must not contain credentials"
}
return ref{remote: true}, ""
case "mailto":
if body {
return ref{}, ""
}
}
return ref{}, fmt.Sprintf("scheme %q is not allowed", m[1])
}
if v[0] != '/' {
return ref{}, "relative paths are not allowed; use a repo-root path starting with /"
}
if strings.HasPrefix(v, "//") {
return ref{}, "protocol-relative references are not allowed"
}
p, frag, hasFrag := strings.Cut(v, "#")
if hasFrag && !body {
return ref{}, "fragments are not allowed here (" + frag + ")"
}
if strings.Contains(p, "?") {
return ref{}, "queries are not allowed"
}
dec, err := url.PathUnescape(p)
if err != nil {
return ref{}, "invalid percent-encoding"
}
if slices.Contains(strings.Split(dec, "/"), "..") || strings.Contains(dec, `\`) {
return ref{}, `".." segments and backslashes are not allowed`
}
return ref{path: dec}, ""
}
// exists reports why a repo-root path is not a regular file inside the repository.
func (c *checker) exists(p string) string {
// Match each component's case exactly, so case-insensitive filesystems agree with Linux.
dir := c.root
for _, part := range strings.Split(p, "/") {
if part == "" || part == "." {
continue
}
entries, err := os.ReadDir(dir)
if err != nil || !slices.ContainsFunc(entries, func(e os.DirEntry) bool { return e.Name() == part }) {
return "target " + p + " does not exist"
}
dir = filepath.Join(dir, part)
}
real, err := filepath.EvalSymlinks(filepath.Join(c.root, filepath.FromSlash(p)))
if err != nil {
return "target " + p + " does not exist"
}
if !within(c.realRoot, real) {
return "target " + p + " resolves outside the repository"
}
if st, err := os.Stat(real); err != nil || !st.Mode().IsRegular() {
return "target " + p + " is not a regular file"
}
return ""
}
// checkLink validates a body link destination.
func (c *checker) checkLink(r *record, line int, dest string) {
ref, msg := parseRef(dest, true)
if msg == "" && ref.path != "" {
msg = c.exists(ref.path)
}
if msg != "" {
c.add(r.path, line, "link %q: %s", dest, msg)
}
}
// refs validates the reference lists of a record against their specs.
func (m *fm) refs(specs ...refSpec) {
self := "/" + m.r.path
for _, spec := range specs {
items, ok := m.list(spec.key)
if !ok {
continue
}
seen := map[string]bool{}
for _, it := range items {
if it.v == marker {
continue
}
if msg := m.checkRef(spec, it.v, self); msg != "" {
m.c.add(m.r.path, it.line, "%s: %s", spec.key, msg)
} else if seen[it.v] {
m.c.add(m.r.path, it.line, "%s: duplicate reference %q", spec.key, it.v)
}
seen[it.v] = true
}
}
}
func (m *fm) checkRef(spec refSpec, v, self string) string {
if durableRe.MatchString(v) || slices.Contains([]string{"this pr", "this pull request", "this commit"}, strings.ToLower(v)) {
return fmt.Sprintf("%q is not durable; use a full URL", v)
}
r, msg := parseRef(v, false)
if msg != "" {
return msg
}
k := spec.kinds
switch {
case r.remote:
if k&kURL == 0 {
return "URLs are not accepted here; accepts " + k.String()
}
return ""
case k&kFile == 0 && !(k&kAdr != 0 && adrPathRe.MatchString(v)) && !(k&kPlan != 0 && planPathRe.MatchString(v)):
return fmt.Sprintf("%q is not accepted here; accepts %s", v, k)
case r.path == self:
return "a record must not reference itself"
}
return m.c.exists(r.path)
}
func (k kinds) String() string {
var s []string
for _, e := range []struct {
k kinds
s string
}{{kAdr, "/docs/adr/<id>.md"}, {kPlan, "/docs/plans/<id>.md"}, {kURL, "http(s) URLs"}, {kFile, "repo-root file paths"}} {
if k&e.k != 0 {
s = append(s, e.s)
}
}
return strings.Join(s, ", ")
}
// within reports whether the real path p is root or lies under it.
func within(root, p string) bool {
rel, err := filepath.Rel(root, p)
return err == nil && rel != ".." && !strings.HasPrefix(rel, ".."+string(filepath.Separator))
}
+32
View File
@@ -0,0 +1,32 @@
---
title: @TITLE_YAML@
date: @DATE@
status: proposed
implementation: not-started
summary: "{{docs:todo}}"
tags:
- "{{docs:todo}}"
supersedes: []
superseded_by: []
related: []
tracking: []
implemented_by: []
---
# @TITLE@
## Context and Problem Statement
{{docs:todo}}
## Considered Options
{{docs:todo}}
## Decision Outcome
{{docs:todo}}
### Consequences
{{docs:todo}}
+20
View File
@@ -0,0 +1,20 @@
---
status: draft
tracking: []
adrs: []
completion: []
---
# @TITLE@
## Scope
{{docs:todo}}
## Steps
{{docs:todo}}
## Validation
{{docs:todo}}
+216
View File
@@ -0,0 +1,216 @@
package page
import (
"bytes"
"encoding/base64"
"encoding/json"
"fmt"
"io"
"strconv"
"time"
"unicode/utf8"
"uuid"
)
const maxCursorBytes = 16384
// CursorError identifies malformed, version, sort, value, or size cursor failures via
// Kind. It intentionally omits cursor payloads from its message.
type CursorError struct{ Kind string }
// Error implements error without including cursor contents.
func (e *CursorError) Error() string { return "page: cursor " + e.Kind }
// ValueError identifies an unsupported concrete type or invalid supported value
// at Position in the row key, without exposing the value itself.
type ValueError struct {
Position int
Type string
}
// Error implements error without including key values.
func (e *ValueError) Error() string {
return fmt.Sprintf("page: invalid key value at %d (%s)", e.Position, e.Type)
}
type envelope struct {
Version int `json:"v"`
Sort string `json:"sort"`
Values [][2]string `json:"values"`
}
func encodeCursor(sortID string, values []any) (string, error) {
e := envelope{Version: 1, Sort: sortID, Values: make([][2]string, len(values))}
for i, v := range values {
pair, ok := encodeValue(v)
if !ok {
return "", &ValueError{Position: i, Type: fmt.Sprintf("%T", v)}
}
e.Values[i] = pair
}
data, err := json.Marshal(e)
if err != nil {
return "", &CursorError{Kind: "malformed"}
}
if base64.RawURLEncoding.EncodedLen(len(data)) > maxCursorBytes {
return "", &CursorError{Kind: "size"}
}
return base64.RawURLEncoding.EncodeToString(data), nil
}
func encodeValue(value any) ([2]string, bool) {
var tag, payload string
switch v := value.(type) {
case int:
tag, payload = "int", strconv.FormatInt(int64(v), 10)
case int8:
tag, payload = "int8", strconv.FormatInt(int64(v), 10)
case int16:
tag, payload = "int16", strconv.FormatInt(int64(v), 10)
case int32:
tag, payload = "int32", strconv.FormatInt(int64(v), 10)
case int64:
tag, payload = "int64", strconv.FormatInt(v, 10)
case string:
if !utf8.ValidString(v) {
return [2]string{}, false
}
tag, payload = "string", v
case time.Time:
v = v.UTC()
if v.Year() < 0 || v.Year() > 9999 {
return [2]string{}, false
}
tag, payload = "time", v.Format(time.RFC3339Nano)
case uuid.UUID:
tag, payload = "uuid", v.String()
default:
return [2]string{}, false
}
return [2]string{tag, payload}, true
}
func decodeCursor(token string, sort Sort) ([]any, error) {
failure := func(kind string) ([]any, error) { return nil, &CursorError{Kind: kind} }
if len(token) > maxCursorBytes {
return failure("size")
}
data, err := base64.RawURLEncoding.Strict().DecodeString(token)
if err != nil || !utf8.Valid(data) || base64.RawURLEncoding.EncodeToString(data) != token {
return failure("malformed")
}
// invariant: exactly three distinct envelope fields; struct decoding alone permits duplicates.
decoder := json.NewDecoder(bytes.NewReader(data))
start, err := decoder.Token()
if err != nil || start != json.Delim('{') {
return failure("malformed")
}
fields := make(map[string]json.RawMessage, 3)
for decoder.More() {
name, err := decoder.Token()
if err != nil {
return failure("malformed")
}
key, ok := name.(string)
if !ok || (key != "v" && key != "sort" && key != "values") {
return failure("malformed")
}
if _, exists := fields[key]; exists {
return failure("malformed")
}
var raw json.RawMessage
if decoder.Decode(&raw) != nil {
return failure("malformed")
}
fields[key] = raw
}
if _, err := decoder.Token(); err != nil || len(fields) != 3 {
return failure("malformed")
}
if _, err := decoder.Token(); err != io.EOF {
return failure("malformed")
}
var version int
if bytes.Equal(fields["v"], []byte("null")) || json.Unmarshal(fields["v"], &version) != nil {
return failure("malformed")
}
if version != 1 {
return failure("version")
}
var id string
if !jsonString(fields["sort"], &id) {
return failure("malformed")
}
if id != sort.ID {
return failure("sort")
}
var entries []json.RawMessage
if len(fields["values"]) == 0 || fields["values"][0] != '[' || json.Unmarshal(fields["values"], &entries) != nil || len(entries) != len(sort.Columns) {
return failure("malformed")
}
values := make([]any, len(entries))
for i, entry := range entries {
var pair []json.RawMessage
if len(entry) == 0 || entry[0] != '[' || json.Unmarshal(entry, &pair) != nil || len(pair) != 2 {
return failure("malformed")
}
var tag, payload string
if !jsonString(pair[0], &tag) || !jsonString(pair[1], &payload) {
return failure("malformed")
}
value, ok := decodeValue(tag, payload)
if !ok {
return failure("value")
}
values[i] = value
}
return values, nil
}
func jsonString(raw json.RawMessage, value *string) bool {
return len(raw) > 0 && raw[0] == '"' && json.Unmarshal(raw, value) == nil && utf8.ValidString(*value)
}
func decodeValue(tag, payload string) (any, bool) {
switch tag {
case "int", "int8", "int16", "int32", "int64":
bits := strconv.IntSize
switch tag {
case "int8":
bits = 8
case "int16":
bits = 16
case "int32":
bits = 32
case "int64":
bits = 64
}
n, err := strconv.ParseInt(payload, 10, bits)
if err != nil || strconv.FormatInt(n, 10) != payload {
return nil, false
}
switch tag {
case "int":
return int(n), true
case "int8":
return int8(n), true
case "int16":
return int16(n), true
case "int32":
return int32(n), true
default:
return n, true
}
case "string":
return payload, utf8.ValidString(payload)
case "time":
t, err := time.Parse(time.RFC3339Nano, payload)
t = t.UTC()
return t, err == nil && t.Year() >= 0 && t.Year() <= 9999
case "uuid":
id, err := uuid.Parse(payload)
return id, err == nil && id.String() == payload
default:
return nil, false
}
}
+220
View File
@@ -0,0 +1,220 @@
package page
import (
"encoding/base64"
"encoding/json"
"errors"
"math"
"reflect"
"strings"
"testing"
"time"
"uuid"
"github.com/stephenafamo/bob"
"github.com/stephenafamo/bob/dialect/psql"
pd "github.com/stephenafamo/bob/dialect/psql/dialect"
"github.com/stephenafamo/bob/expr"
)
func scalarSort() Sort {
return Sort{ID: "scalar/v1", Columns: []Column{{Expression: expr.Quote("id"), Unique: true}}}
}
func TestSupportedValues(t *testing.T) {
instant := time.Date(2026, 10, 27, 12, 34, 56, 123456789, time.FixedZone("odd", 3661))
values := []any{
int(0), int(math.MaxInt), int(math.MinInt), int8(math.MinInt8), int8(math.MaxInt8),
int16(math.MinInt16), int16(math.MaxInt16), int32(math.MinInt32), int32(math.MaxInt32),
int64(math.MinInt64), int64(math.MaxInt64), int64(9007199254740993), "", "こんにちは\x00' OR 1=1 --",
instant, time.Date(0, 1, 1, 0, 0, 0, 0, time.UTC), time.Date(9999, 12, 31, 23, 59, 59, 999999999, time.UTC),
uuid.MustParse("01234567-89ab-cdef-0123-456789abcdef"), uuid.Nil(),
}
for _, value := range values {
t.Run(reflect.TypeOf(value).String(), func(t *testing.T) {
token, err := encodeCursor("scalar/v1", []any{value})
if err != nil {
t.Fatal(err)
}
decoded, err := decodeCursor(token, scalarSort())
if err != nil {
t.Fatal(err)
}
expected := value
if v, ok := value.(time.Time); ok {
expected = v.UTC()
}
if !reflect.DeepEqual(decoded, []any{expected}) {
t.Fatalf("type/value: got %#v want %#v", decoded, expected)
}
p, err := Prepare(scalarSort(), func(v any) []any { return []any{v} }, Request{Cursor: token}, Limits{Default: 1, Maximum: 2})
if err != nil {
t.Fatal(err)
}
q := psql.Select(Mod[*pd.SelectQuery](p))
_, args, err := bob.Build(t.Context(), q)
if err != nil || !reflect.DeepEqual(args, decoded) {
t.Fatalf("bound values: %#v %v", args, err)
}
if tm, ok := expected.(time.Time); ok {
data, _ := base64.RawURLEncoding.DecodeString(token)
if !strings.Contains(string(data), tm.Format(time.RFC3339Nano)) {
t.Fatalf("non-UTC timestamp: %s", data)
}
}
})
}
}
func TestUnsupportedValues(t *testing.T) {
type named int64
n := 1
values := []any{nil, named(1), uint(1), uint64(1), float64(1), true, &n, []byte("x"), struct{}{}, "\xff", time.Date(-1, 1, 1, 0, 0, 0, 0, time.UTC), time.Date(10000, 1, 1, 0, 0, 0, 0, time.UTC)}
for _, value := range values {
p, err := Prepare(scalarSort(), func(v any) []any { return []any{v} }, Request{}, Limits{Default: 1, Maximum: 2})
if err != nil {
t.Fatal(err)
}
result, err := p.Page([]any{value})
var valueError *ValueError
if !errors.As(err, &valueError) || valueError.Position != 0 || !reflect.DeepEqual(result, Page[any]{}) {
t.Fatalf("%T: %+v %v", value, result, err)
}
}
type alias = int64
if _, err := encodeCursor("scalar/v1", []any{alias(1)}); err != nil {
t.Fatal(err)
}
}
func TestMalformedCursors(t *testing.T) {
valid := `{"v":1,"sort":"scalar/v1","values":[["int64","1"]]}`
cases := []struct{ data, kind string }{
{`null`, "malformed"}, {`[]`, "malformed"}, {`{`, "malformed"},
{valid + ` {}`, "malformed"},
{strings.Replace(valid, `"v":1`, `"v":2`, 1), "version"},
{strings.Replace(valid, `"v":1`, `"v":null`, 1), "malformed"},
{strings.Replace(valid, `"v":1`, `"v":1,"v":1`, 1), "malformed"},
{strings.Replace(valid, `"v":1,`, ``, 1), "malformed"},
{strings.Replace(valid, `"v":1`, `"v":1,"columns":[]`, 1), "malformed"},
{strings.Replace(valid, `scalar/v1`, `other/v1`, 1), "sort"},
{strings.Replace(valid, `"scalar/v1"`, `null`, 1), "malformed"},
{strings.Replace(valid, `[["int64","1"]]`, `null`, 1), "malformed"},
{strings.Replace(valid, `[["int64","1"]]`, `[]`, 1), "malformed"},
{strings.Replace(valid, `[["int64","1"]]`, `[["int64","1"],["int64","2"]]`, 1), "malformed"},
}
for _, entry := range []string{`null`, `{}`, `{"type":"int64","value":"1"}`, `[]`, `["int64"]`, `["int64","1","x"]`, `[null,"1"]`, `["int64",null]`, `["int64",1]`, `[1,"1"]`} {
cases = append(cases, struct{ data, kind string }{strings.Replace(valid, `["int64","1"]`, entry, 1), "malformed"})
}
for _, pair := range [][2]string{{"what", "1"}, {"int8", "128"}, {"int8", "-129"}, {"int16", "32768"}, {"int32", "2147483648"}, {"int64", "9223372036854775808"}, {"int", "999999999999999999999"}, {"int64", "01"}, {"int64", "+1"}, {"int64", "-0"}, {"int64", "1.0"}, {"time", "10000-01-01T00:00:00Z"}, {"time", "yesterday"}, {"time", "9999-12-31T23:59:59-01:00"}, {"time", "0000-01-01T00:00:00+01:00"}, {"uuid", "broken"}} {
data, _ := json.Marshal(pair)
cases = append(cases, struct{ data, kind string }{strings.Replace(valid, `["int64","1"]`, string(data), 1), "value"})
}
for i, tc := range cases {
_, err := decodeCursor(base64.RawURLEncoding.EncodeToString([]byte(tc.data)), scalarSort())
var ce *CursorError
if !errors.As(err, &ce) || ce.Kind != tc.kind {
t.Fatalf("case %d %s: %v", i, tc.data, err)
}
}
for _, token := range []string{"!", "====", base64.RawURLEncoding.EncodeToString([]byte(valid)) + "\n", base64.RawURLEncoding.EncodeToString([]byte("\xff"))} {
if _, err := decodeCursor(token, scalarSort()); err == nil {
t.Fatalf("accepted %q", token)
}
}
// A well-formed edit is a new seek boundary, not an authentication failure.
edited := strings.Replace(valid, `"1"`, `"9007199254740993"`, 1)
got, err := decodeCursor(base64.RawURLEncoding.EncodeToString([]byte(edited)), scalarSort())
if err != nil || got[0] != int64(9007199254740993) {
t.Fatalf("edited boundary: %v %v", got, err)
}
}
func TestCursorSize(t *testing.T) {
// Find the exact final-envelope boundary instead of assuming an overhead size.
var at string
var length int
for length = 12000; length < 12400; length++ {
token, err := encodeCursor("scalar/v1", []any{strings.Repeat("x", length)})
if err == nil && len(token) == maxCursorBytes {
at = token
break
}
}
if at == "" {
t.Fatal("exact boundary not found")
}
if _, err := decodeCursor(at, scalarSort()); err != nil {
t.Fatal(err)
}
var ce *CursorError
if _, err := decodeCursor(at+"A", scalarSort()); !errors.As(err, &ce) || ce.Kind != "size" {
t.Fatalf("received limit: %v", err)
}
p, err := Prepare(scalarSort(), func(v string) []any { return []any{v} }, Request{}, Limits{Default: 1, Maximum: 2})
if err != nil {
t.Fatal(err)
}
result, err := p.Page([]string{strings.Repeat("x", length+1)})
if !errors.As(err, &ce) || ce.Kind != "size" || !reflect.DeepEqual(result, Page[string]{}) {
t.Fatalf("emitted limit: %+v %v", result, err)
}
if _, err := encodeCursor("scalar/v1", []any{strings.Repeat("x", length-1)}); err != nil {
t.Fatal(err)
}
// Failure in an overflow row also invalidates the entire page.
result, err = p.Page([]string{"valid", strings.Repeat("x", length+1)})
if !errors.As(err, &ce) || !reflect.DeepEqual(result, Page[string]{}) {
t.Fatalf("overflow: %+v %v", result, err)
}
}
func TestPrepareAndKeyValidation(t *testing.T) {
limits := Limits{Default: 2, Maximum: 3}
badSorts := []Sort{{}, {ID: "x"}, {ID: "x", Columns: []Column{{Unique: true}}}, {ID: "x", Columns: []Column{{Expression: expr.Quote("id"), Direction: Order(2), Unique: true}}}, {ID: "x", Columns: []Column{{Expression: expr.Quote("id")}}}}
key := func(v int) []any { return []any{v} }
for _, sort := range badSorts {
if _, err := Prepare(sort, key, Request{}, limits); err == nil {
t.Fatalf("accepted sort: %+v", sort)
}
}
if _, err := Prepare[int](scalarSort(), nil, Request{}, limits); err == nil {
t.Fatal("nil key accepted")
}
for _, l := range []Limits{{}, {Default: 2, Maximum: 1}, {Default: 1, Maximum: math.MaxInt}} {
if _, err := Prepare(scalarSort(), key, Request{}, l); err == nil {
t.Fatalf("accepted limits %+v", l)
}
}
for _, r := range []Request{{Size: -1}, {Direction: Direction(2)}} {
if _, err := Prepare(scalarSort(), key, r, limits); err == nil {
t.Fatal("bad request accepted")
}
}
for _, size := range []int{0, 1, 3, 4, math.MaxInt} {
p, err := Prepare(scalarSort(), key, Request{Size: size}, limits)
want := min(size, 3)
if size == 0 {
want = 2
}
if err != nil || p.size != want {
t.Fatalf("size %d: %+v %v", size, p, err)
}
}
for _, badLength := range []int{0, 2} {
p, err := Prepare(scalarSort(), func(v int) []any {
if v == 9 {
return make([]any, badLength)
}
return []any{v}
}, Request{Size: 1}, limits)
if err != nil {
t.Fatal(err)
}
result, err := p.Page([]int{1, 9})
var ke *KeyError
if !errors.As(err, &ke) || ke.Expected != 1 || ke.Actual != badLength || !reflect.DeepEqual(result, Page[int]{}) {
t.Fatalf("key: %+v %v", result, err)
}
}
}
+69
View File
@@ -0,0 +1,69 @@
package page_test
import (
"context"
"errors"
"fmt"
"github.com/stephenafamo/bob"
"github.com/stephenafamo/bob/dialect/sqlite"
sd "github.com/stephenafamo/bob/dialect/sqlite/dialect"
"github.com/stephenafamo/bob/dialect/sqlite/sm"
"github.com/stephenafamo/bob/expr"
"github.com/stephenafamo/scan"
"go.auvem.com/corestack/page"
)
func Example() {
ctx := context.Background()
db, err := bob.Open("sqlite3", ":memory:")
if err != nil {
panic(err)
}
defer db.Close()
db.SetMaxOpenConns(1)
if _, err := db.ExecContext(ctx, "CREATE TABLE orders (id BIGINT PRIMARY KEY, priority BIGINT NOT NULL, tenant BIGINT NOT NULL)"); err != nil {
panic(err)
}
if _, err := db.ExecContext(ctx, "INSERT INTO orders VALUES (1,10,7),(2,10,7),(3,5,7),(4,20,8)"); err != nil {
panic(err)
}
type Order struct {
ID int64
Priority int64
}
sort := page.Sort{ID: "orders/priority/v1", Columns: []page.Column{
{Expression: expr.Quote("priority"), Direction: page.Desc},
{Expression: expr.Quote("id"), Direction: page.Asc, Unique: true},
}}
// With Bob-generated models, use their column references for these expressions.
// The key must independently match their order and actual stored value types.
key := func(o Order) []any { return []any{o.Priority, o.ID} }
p, err := page.Prepare(sort, key, page.Request{Size: 2}, page.Limits{Default: 2, Maximum: 100})
if err != nil {
panic(err)
}
q := sqlite.Select(sm.Columns("id", "priority"), sm.From("orders"), page.Mod[*sd.SelectQuery](p))
q.Apply(sm.Where(sqlite.Quote("tenant").EQ(sqlite.Arg(int64(7)))))
rows, err := bob.All(ctx, db, q, scan.StructMapper[Order]())
if err != nil {
panic(err)
}
result, err := p.Page(rows)
if err != nil {
panic(err)
}
fmt.Println(result.Items, result.HasNext, result.HasPrevious)
// Continue with Forward + result.EndCursor, or Backward + result.StartCursor.
// A mismatched key returns no partial Page, including for an overflow row.
bad, err := page.Prepare(sort, func(o Order) []any { return []any{o.ID} }, page.Request{}, page.Limits{Default: 2, Maximum: 100})
if err != nil {
panic(err)
}
_, err = bad.Page(rows)
var keyError *page.KeyError
fmt.Println(errors.As(err, &keyError), keyError.Expected, keyError.Actual)
// Output:
// [{1 10} {2 10}] true false
// true 2 1
}
+184
View File
@@ -0,0 +1,184 @@
// Package page provides transport-neutral keyset pagination for Bob SELECT queries.
// Callers own authorization, non-null stored sort values, and correspondence between
// Sort columns and the typed row key. The final column must itself be unique in the
// selected relation. Mixed directions are supported; null sort values are not.
//
// Sort IDs version the expressions, directions, key types and comparison semantics.
// Cursors expose values and allow edits; they are seek boundaries, not credentials.
// Concurrent writes or changed filters can skip or repeat rows between requests.
// Code generation may eventually align Sort and key; handwritten pairs have no
// compile-time field/type correspondence guarantee.
//
// Keys support exactly int, int8, int16, int32, int64, string, time.Time and the
// standard uuid.UUID. Named types, unsigned values, pointers and null wrappers
// require explicit caller conversion. Timestamps normalize to UTC with nanosecond
// precision. Versioned JSON cursors use unpadded base64url, limited to 16,384 bytes
// after encoding; unsupported values and malformed cursors return typed errors.
package page
import (
"fmt"
"slices"
"unicode/utf8"
"github.com/stephenafamo/bob"
)
// Order is a column's canonical ordering direction.
type Order uint8
const (
// Asc orders smaller values first.
Asc Order = iota
// Desc orders larger values first.
Desc
)
// Column declares a trusted, non-null SQL expression and its canonical direction.
// Unique asserts that this column alone is unique, including across joins.
type Column struct {
Expression bob.Expression
Direction Order
Unique bool
}
// Sort is an immutable, caller-owned ordering contract. Change ID when its
// expressions, order, key types, uniqueness or comparison semantics change.
type Sort struct {
ID string
Columns []Column
}
// Direction selects which side of an optional anchor to fetch.
type Direction uint8
const (
// Forward maps to first/after and is the default direction.
Forward Direction = iota
// Backward maps to last/before; returned items retain canonical sort order.
Backward
)
// Request carries a transport-independent page request. Zero Size uses the
// configured default; excessive sizes clamp to Maximum. Empty Cursor has no anchor.
type Request struct {
Direction Direction
Size int
Cursor string
}
// Limits configures page sizes; require 1 <= Default <= Maximum < max int.
type Limits struct {
Default int
Maximum int
}
// KeyError identifies a programmer error in the row key's arity.
type KeyError struct {
Expected int
Actual int
}
// Error implements error with the expected and actual key lengths.
func (e *KeyError) Error() string {
return fmt.Sprintf("page: key length %d, expected %d", e.Actual, e.Expected)
}
// Page contains canonical-order items and cursors for their first and last rows.
// Empty pages have empty cursors. Overflow determines the fetch-direction flag;
// anchor presence determines the opposite flag, even for empty/stale results.
// The opposite flag does not prove another row exists.
type Page[T any] struct {
Items []T
StartCursor string
EndCursor string
HasNext bool
HasPrevious bool
}
// Prepared holds validated pagination and the typed row key. Construct with Prepare.
// Treat Sort expressions and the key's captured state as immutable while in use.
type Prepared[T any] struct {
sort Sort
key func(T) []any
direction Direction
size int
anchor []any
}
// Prepare validates a request before a Bob mod can be applied. key must return
// exactly one supported concrete value per Sort column, in the same order, using
// actual stored/scanned values (including database timestamp precision).
func Prepare[T any](sort Sort, key func(T) []any, request Request, limits Limits) (*Prepared[T], error) {
if sort.ID == "" || !utf8.ValidString(sort.ID) || len(sort.Columns) == 0 {
return nil, fmt.Errorf("page: sort needs a valid ID and columns")
}
for i, c := range sort.Columns {
if c.Expression == nil || c.Direction > Desc {
return nil, fmt.Errorf("page: invalid sort column %d", i)
}
}
if !sort.Columns[len(sort.Columns)-1].Unique {
return nil, fmt.Errorf("page: final sort column must be unique")
}
if key == nil {
return nil, fmt.Errorf("page: nil key function")
}
if limits.Default < 1 || limits.Maximum < limits.Default || limits.Maximum == int(^uint(0)>>1) {
return nil, fmt.Errorf("page: invalid limits")
}
if request.Direction > Backward || request.Size < 0 {
return nil, fmt.Errorf("page: invalid request direction or size")
}
size := request.Size
if size == 0 {
size = limits.Default
}
size = min(size, limits.Maximum)
sort.Columns = slices.Clone(sort.Columns)
p := &Prepared[T]{sort: sort, key: key, direction: request.Direction, size: size}
if request.Cursor != "" {
var err error
p.anchor, err = decodeCursor(request.Cursor, sort)
if err != nil {
return nil, err
}
}
return p, nil
}
// Page validates all fetched rows, including overflow, and assembles a page.
// Pass rows in query order, with at most size+1 rows. It copies retained items;
// backward pagination never reverses the caller's slice. Errors return no page.
func (p *Prepared[T]) Page(rows []T) (Page[T], error) {
var zero Page[T]
if len(rows) > p.size+1 {
return zero, fmt.Errorf("page: too many fetched rows")
}
cursors := make([]string, len(rows))
for i, row := range rows {
key := p.key(row)
if len(key) != len(p.sort.Columns) {
return zero, &KeyError{Expected: len(p.sort.Columns), Actual: len(key)}
}
var err error
cursors[i], err = encodeCursor(p.sort.ID, key)
if err != nil {
return zero, err
}
}
overflow := len(rows) > p.size
n := min(len(rows), p.size)
result := Page[T]{Items: slices.Clone(rows[:n])}
if n > 0 {
result.StartCursor, result.EndCursor = cursors[0], cursors[n-1]
}
if p.direction == Backward {
slices.Reverse(result.Items)
result.StartCursor, result.EndCursor = result.EndCursor, result.StartCursor
result.HasPrevious, result.HasNext = overflow, len(p.anchor) > 0
} else {
result.HasNext, result.HasPrevious = overflow, len(p.anchor) > 0
}
return result, nil
}
+68
View File
@@ -0,0 +1,68 @@
package page
import (
"context"
"fmt"
"github.com/stephenafamo/bob"
"github.com/stephenafamo/bob/clause"
"github.com/stephenafamo/bob/expr"
"github.com/stephenafamo/scan"
)
// Mod applies validated keyset WHERE, ORDER BY and integer LIMIT size+1 to native
// PostgreSQL, SQLite or MySQL selects. Apply once to a query with no existing
// ORDER BY, LIMIT, OFFSET or FETCH; do not override pagination afterward.
// Callers may compose additional WHERE filters before or after this mod.
func Mod[Q interface {
AppendWhere(...any)
AppendOrder(bob.Expression)
SetLimit(any)
}, T any](p *Prepared[T]) bob.Mod[Q] {
return bob.ModFunc[Q](func(q Q) {
var alternatives []bob.Expression
for i, c := range p.sort.Columns {
desc := c.Direction == Desc
if p.direction == Backward {
desc = !desc
}
direction, operator := "ASC", ">"
if desc {
direction, operator = "DESC", "<"
}
q.AppendOrder(clause.OrderDef{Expression: c.Expression, Direction: direction})
if len(p.anchor) == 0 {
continue
}
terms := make([]bob.Expression, 0, i+1)
for j := 0; j < i; j++ {
terms = append(terms, expr.OP("=", p.sort.Columns[j].Expression, expr.Arg(p.anchor[j])))
}
terms = append(terms, expr.OP(operator, c.Expression, expr.Arg(p.anchor[i])))
alternatives = append(alternatives, grouped(terms, " AND "))
}
// authz: group the seek disjunction so caller filters constrain every branch.
if len(alternatives) > 0 {
q.AppendWhere(grouped(alternatives, " OR "))
}
q.SetLimit(p.size + 1)
})
}
func grouped(expressions []bob.Expression, separator string) bob.Expression {
return expr.Join{Exprs: []bob.Expression{
expr.Raw("("), expr.Join{Exprs: expressions, Sep: separator}, expr.Raw(")"),
}, Sep: expr.NoSep}
}
// Count executes a separate caller-built, authorized count query returning one
// int64 column. It never rewrites a paginated query or infers grouped/distinct
// semantics. Nothing runs unless called.
func Count(ctx context.Context, executor bob.Executor, query bob.Query) (int64, error) {
// authz: callers supply the same authorized relation as their item query.
count, err := bob.One(ctx, executor, query, scan.SingleColumnMapper[int64])
if err != nil {
return 0, fmt.Errorf("page: count: %w", err)
}
return count, nil
}
+189
View File
@@ -0,0 +1,189 @@
package page_test
import (
"database/sql"
"os"
"reflect"
"errors"
"testing"
_ "github.com/lib/pq"
_ "github.com/mattn/go-sqlite3"
"github.com/stephenafamo/bob"
"github.com/stephenafamo/bob/dialect/mysql"
md "github.com/stephenafamo/bob/dialect/mysql/dialect"
mm "github.com/stephenafamo/bob/dialect/mysql/sm"
"github.com/stephenafamo/bob/dialect/psql"
pd "github.com/stephenafamo/bob/dialect/psql/dialect"
pm "github.com/stephenafamo/bob/dialect/psql/sm"
"github.com/stephenafamo/bob/dialect/sqlite"
sd "github.com/stephenafamo/bob/dialect/sqlite/dialect"
"github.com/stephenafamo/bob/dialect/sqlite/sm"
"github.com/stephenafamo/bob/expr"
"github.com/stephenafamo/scan"
"go.auvem.com/corestack/page"
)
type item struct {
ID int64
Score int64
}
func itemSort() page.Sort {
return page.Sort{ID: "items/score/v1", Columns: []page.Column{
{Expression: expr.Quote("score"), Direction: page.Desc},
{Expression: expr.Quote("id"), Direction: page.Asc, Unique: true},
}}
}
func itemKey(i item) []any { return []any{i.Score, i.ID} }
func TestSQLiteFlow(t *testing.T) {
db, err := bob.Open("sqlite3", ":memory:")
if err != nil {
t.Fatal(err)
}
defer db.Close()
databaseFlow(t, db, false)
}
func TestPostgresFlow(t *testing.T) {
dsn := os.Getenv("PAGE_POSTGRES_DSN")
if dsn == "" {
if os.Getenv("PAGE_REQUIRE_POSTGRES") != "" {
t.Fatal("PAGE_POSTGRES_DSN is required")
}
t.Skip("set PAGE_POSTGRES_DSN to run PostgreSQL integration")
}
db, err := bob.Open("postgres", dsn)
if err != nil {
t.Fatal(err)
}
defer db.Close()
databaseFlow(t, db, true)
}
func databaseFlow(t *testing.T, db bob.DB, postgres bool) {
t.Helper()
db.SetMaxOpenConns(1)
for _, statement := range []string{
"CREATE TEMP TABLE items (id BIGINT PRIMARY KEY, score BIGINT NOT NULL, tenant BIGINT NOT NULL)",
"INSERT INTO items VALUES (1,30,1),(2,30,1),(3,20,1),(4,10,1),(5,5,2),(6,30,2)",
} {
if _, err := db.ExecContext(t.Context(), statement); err != nil {
t.Fatal(err)
}
}
fetch := func(direction page.Direction, size int, cursor string) page.Page[item] {
t.Helper()
p, err := page.Prepare(itemSort(), itemKey, page.Request{Direction: direction, Size: size, Cursor: cursor}, page.Limits{Default: 2, Maximum: 3})
if err != nil {
t.Fatal(err)
}
var q bob.Query
if postgres {
query := psql.Select(pm.Columns("id", "score"), pm.From("items"), pm.Where(psql.Quote("tenant").EQ(psql.Arg(int64(1)))))
query.Apply(page.Mod[*pd.SelectQuery](p))
query.Apply(pm.Where(psql.Quote("score").GT(psql.Arg(int64(0)))))
q = query
} else {
query := sqlite.Select(sm.Columns("id", "score"), sm.From("items"), sm.Where(sqlite.Quote("tenant").EQ(sqlite.Arg(int64(1)))))
query.Apply(page.Mod[*sd.SelectQuery](p))
query.Apply(sm.Where(sqlite.Quote("score").GT(sqlite.Arg(int64(0)))))
q = query
}
rows, err := bob.All(t.Context(), db, q, scan.StructMapper[item]())
if err != nil {
t.Fatal(err)
}
before := append([]item(nil), rows...)
result, err := p.Page(rows)
if err != nil {
t.Fatal(err)
}
if !reflect.DeepEqual(before, rows) {
t.Fatal("Page mutated fetched slice")
}
return result
}
check := func(got page.Page[item], ids []int64, next, previous bool) {
t.Helper()
actual := make([]int64, len(got.Items))
for i, row := range got.Items {
actual[i] = row.ID
}
if !reflect.DeepEqual(actual, ids) || got.HasNext != next || got.HasPrevious != previous {
t.Fatalf("got IDs %v next=%v previous=%v; want %v %v %v", actual, got.HasNext, got.HasPrevious, ids, next, previous)
}
if len(ids) == 0 && (got.StartCursor != "" || got.EndCursor != "") {
t.Fatal("empty page has cursors")
}
if len(ids) > 0 && (got.StartCursor == "" || got.EndCursor == "") {
t.Fatal("missing cursors")
}
}
first := fetch(page.Forward, 2, "")
check(first, []int64{1, 2}, true, false)
second := fetch(page.Forward, 2, first.EndCursor)
check(second, []int64{3, 4}, false, true)
check(fetch(page.Forward, 2, second.EndCursor), []int64{}, false, true)
last := fetch(page.Backward, 2, "")
check(last, []int64{3, 4}, false, true)
previous := fetch(page.Backward, 2, last.StartCursor)
check(previous, []int64{1, 2}, true, false)
check(fetch(page.Backward, 2, previous.StartCursor), []int64{}, true, false)
check(fetch(page.Forward, 0, ""), []int64{1, 2}, true, false)
check(fetch(page.Forward, 1000, ""), []int64{1, 2, 3}, true, false)
// A cursor describes a value boundary even after its row is deleted.
if _, err := db.ExecContext(t.Context(), "DELETE FROM items WHERE id=2"); err != nil {
t.Fatal(err)
}
check(fetch(page.Forward, 2, first.EndCursor), []int64{3, 4}, false, true)
var countQuery, emptyQuery bob.Query
if postgres {
countQuery = psql.Select(pm.Columns("count(*)"), pm.From("items"), pm.Where(psql.Quote("tenant").EQ(psql.Arg(1))))
emptyQuery = psql.Select(pm.Columns("id"), pm.From("items"), pm.Where(psql.Quote("id").LT(psql.Arg(0))))
} else {
countQuery = sqlite.Select(sm.Columns("count(*)"), sm.From("items"), sm.Where(sqlite.Quote("tenant").EQ(sqlite.Arg(1))))
emptyQuery = sqlite.Select(sm.Columns("id"), sm.From("items"), sm.Where(sqlite.Quote("id").LT(sqlite.Arg(0))))
}
count, err := page.Count(t.Context(), db, countQuery)
if err != nil || count != 3 {
t.Fatalf("count %d: %v", count, err)
}
if _, err := page.Count(t.Context(), db, emptyQuery); !errors.Is(err, sql.ErrNoRows) {
t.Fatalf("count error lost cause: %v", err)
}
_, err = page.Prepare(itemSort(), itemKey, page.Request{Cursor: "not!base64"}, page.Limits{Default: 2, Maximum: 3})
var cursorError *page.CursorError
if !errors.As(err, &cursorError) {
t.Fatalf("invalid cursor: %v", err)
}
bad, err := page.Prepare(itemSort(), func(item) []any { return []any{int64(1)} }, page.Request{}, page.Limits{Default: 2, Maximum: 3})
if err != nil {
t.Fatal(err)
}
result, err := bad.Page([]item{{ID: 1}})
var keyError *page.KeyError
if !errors.As(err, &keyError) || !reflect.DeepEqual(result, page.Page[item]{}) {
t.Fatalf("key failure: %+v %v", result, err)
}
if _, err := db.ExecContext(t.Context(), "DELETE FROM items"); err != nil {
t.Fatal(err)
}
check(fetch(page.Forward, 2, ""), []int64{}, false, false)
check(fetch(page.Backward, 2, ""), []int64{}, false, false)
check(fetch(page.Forward, 2, first.EndCursor), []int64{}, false, true)
check(fetch(page.Backward, 2, last.StartCursor), []int64{}, true, false)
}
func TestMySQLModComposition(t *testing.T) {
p, err := page.Prepare(itemSort(), itemKey, page.Request{}, page.Limits{Default: 2, Maximum: 3})
if err != nil {
t.Fatal(err)
}
q := mysql.Select(mm.Columns("id", "score"), mm.From("items"), page.Mod[*md.SelectQuery](p))
q.Apply(mm.Where(mysql.Quote("tenant").EQ(mysql.Arg(int64(1)))))
// Compile-time composition only; MySQL runtime behavior needs a database test.
}