Documentation
¶
Overview ¶
Command oldnames fails when a name the pre-1.0 API redesign removed (docs/design/api-v1.md, section 10.2) appears in bide's Go code, its godoc, or its documentation: the transitional names (RunMessage, Build, ResolveHaltRef, ...), the string entry points they replaced (RunSaga, RunResult, ...), the pause aliases, the Durable interface and its shims, the old Tool method set's SpecOf, the context decorators, the mcp package's old path, and agent.ScriptedModel.
It scans every .go, go.mod and .md file below the root, except this command (which must name them), CHANGELOG.md and its fragments (changes/unreleased), the release notes (docs/releases) and the dated design records (docs/design), which describe the API as it was. With -godoc, it also runs `go doc -all` on every public package of every module and checks its output, the API as a user reads it, for the same names and for the word "transitional".
Usage, from the repository root:
go run ./internal/tools/oldnames [-root dir] [-godoc]
The exit status is 0 when clean, 1 on findings, and 2 when the check could not run.
Source Files