//! Central registry of diagnostic codes.
//!
//! This is the single source of truth for the `bynk.*` codes the compiler can
//! emit. The reference page `site/src/content/docs/book/reference/diagnostics.md` is generated
//! from [`render_markdown`], and the test `tests/diagnostics_registry.rs`
//! asserts that this table matches exactly the set of codes used across the
//! compiler source — so a new code cannot be introduced without documenting it
//! here, and a removed code cannot linger in the docs.
//!
//! Each entry is a `(code, summary)` pair, optionally tagged with the grammar
//! production(s) it constrains (`grammar_symbol`), and carries a severity
//! (`Error` unless built via the crate-private `warn` helper). The category
//! shown in the generated reference is derived from the second dotted segment
//! of the code; the grammar weave (`docs/grammar-semantics.json`, the
//! `{{#grammar-semantics}}` directive, and the diagnostics page's Construct
//! column) is generated from `grammar_symbol`.
use crate::error::Severity;
/// One documented diagnostic: its stable code and a one-line summary of the
/// cause. Richer "cause and fix" material for the common diagnostics lives in
/// the troubleshooting how-to guides.
pub struct DiagnosticInfo {
pub code: &'static str,
pub summary: &'static str,
/// The grammar production(s) this diagnostic constrains, by `tree-sitter`
/// rule name (e.g. `http_handler`). This is the single source of the
/// "static semantics" weave: a grammar-reference entry embeds the
/// diagnostics for a rule via `{{#grammar-semantics <rule>}}`, generated
/// from here. Empty for diagnostics with no single governing construct
/// (e.g. `bynk.boundary.structural_mismatch`). Every non-empty name is
/// checked against the grammar by `tests/diagnostics_registry.rs`.
pub grammar_symbol: &'static [&'static str],
/// This code's severity (ADR 0117): `Error` rejects the program; `Warning`
/// surfaces but never fails the build. The single source of truth for
/// [`crate::error::Severity::for_error`], which looks a code up here
/// instead of hardcoding its own copy of the (small) warning set —
/// `tests/diagnostics_registry.rs` asserts the two never drift apart.
/// Defaults to `Error` via the crate-private `d`/`dg` constructors; only
/// the crate-private `warn` helper's call sites override it.
pub severity: Severity,
}
/// The hosted Book, the stable target for `codeDescription` links (#853,
/// DECISION C). No trailing slash — an [`Explain::page`] path (which begins
/// with `/`) is appended directly.
pub const BOOK_BASE_URL: &str = "https://bynk-lang.org";
/// A curated, offline-complete explanation of a diagnostic code (#853).
///
/// This is the compiler-owned `code → { blurb, href }` table (DECISION A): the
/// `blurb`/`example` are the offline answer `bynk explain` prints, while
/// `page`/`anchor` compose the hosted-Book href the LSP hangs off the code as a
/// clickable `codeDescription` link (DECISION C). Only the highest-traffic,
/// newcomer-facing codes are curated; every other code simply has no entry and
/// falls back gracefully — no link, no error (DECISION B).
///
/// The mapping points at *existing* Book concept pages rather than duplicating
/// their prose; the reference-page generator ([`render_markdown`]) links every
/// explained code at its `page`/`anchor` as an in-site link, so
/// `astro build`'s link checker fails if a page moves or an anchor is renamed —
/// the doc-drift guard the rest of the site already relies on.
pub struct Explain {
/// The diagnostic code this explains. Must be a real [`REGISTRY`] code
/// (enforced by `tests/diagnostics_registry.rs`).
pub code: &'static str,
/// A longer-form paragraph: what the rule is and, crucially, *why* it
/// exists. This is the offline-complete answer — useful without network.
pub blurb: &'static str,
/// A minimal example of the violation and its fix.
pub example: &'static str,
/// The target Book page as a site-root-relative path, no extension and no
/// trailing slash, e.g. `/book/reference/types`. Used verbatim as an
/// in-site link by [`render_markdown`] (so the site link checker guards it)
/// and prefixed with [`BOOK_BASE_URL`] for the hosted `codeDescription`.
pub page: &'static str,
/// The in-page heading anchor (slug), or `""` for the page top.
pub anchor: &'static str,
}
impl Explain {
/// The hosted-Book URL for this explanation: [`BOOK_BASE_URL`] + the page
/// (Starlight serves pages with a trailing slash) + `#anchor` when set.
pub fn href(&self) -> String {
let mut url = format!("{BOOK_BASE_URL}{}/", self.page);
if !self.anchor.is_empty() {
url.push('#');
url.push_str(self.anchor);
}
url
}
/// The site-root-relative link used inside the generated reference page,
/// e.g. `/book/reference/types/#record-types`. Same shape as [`href`], sans
/// the host, so the in-site link checker resolves it.
///
/// [`href`]: Explain::href
pub fn in_site_link(&self) -> String {
let mut link = format!("{}/", self.page);
if !self.anchor.is_empty() {
link.push('#');
link.push_str(self.anchor);
}
link
}
}
/// The curated explanations, keyed by code (DECISION B: highest-traffic,
/// newcomer-facing codes first). Kept sorted by code; every `code` must be a
/// real [`REGISTRY`] entry and every `page` an existing Book page — both
/// enforced by `tests/diagnostics_registry.rs`.
pub const EXPLANATIONS: &[Explain] = &[
Explain {
code: "bynk.given.undeclared_capability",
blurb: "A handler may only use a capability it has itself declared with \
`given`. Effects in Bynk are explicit: the `given` clause is the \
handler's honest, checkable statement of every capability it \
reaches for, so a reader (and the compiler) can see a handler's \
full reach from its signature alone. Using a capability that is \
not in `given` is the missing half of that contract.",
example: "on get \"/now\" -> Text { // ✗ uses Clock without declaring it\n \
Clock.now()\n}\n\n\
on get \"/now\" given Clock -> Text { // ✓ declared, then used\n \
Clock.now()\n}",
page: "/book/guides/effects-and-capabilities/understand-the-capability-model",
anchor: "",
},
Explain {
code: "bynk.given.unknown_capability",
blurb: "A `given` clause names a capability that no provider declares. A \
capability is a typed interface to the outside world; it has to be \
*declared* (as a `capability`, or brought in from a consumed \
context) before a handler can ask for it. This usually means a \
typo in the capability name, or a missing `uses`/`consumes` that \
would bring the capability into scope.",
example: "on get \"/\" given Clok -> Text { … } // ✗ no capability named `Clok`\n\n\
on get \"/\" given Clock -> Text { … } // ✓ matches the declared capability",
page: "/book/reference/capabilities",
anchor: "declaring-a-capability",
},
Explain {
code: "bynk.http.error_status_position",
blurb: "An `ErrorStatus` name such as `Forbidden` stands for a status only as \
`RawError`'s first argument, where the compiler turns it into the \
number it answers. It is not a type, so a status can't be stored or \
passed to a helper. Name the status where the response is built, and \
let a helper build the body.",
example: "fn refusal(status: ErrorStatus, msg: String) -> HttpResult[()] { … } // ✗\n\n\
fn problem(msg: String) -> Bytes { Bytes.fromUtf8(msg) }\n\
RawError(Forbidden, problem(\"no access\"), \"text/plain\") // ✓",
page: "/book/reference/http",
anchor: "error-bodies",
},
Explain {
code: "bynk.http.raw_body_unbounded",
blurb: "A `@raw` route hands the handler its request body as untouched octets, \
buffered in memory up to a cap. With no cap there is no bound on that \
buffer, which is the denial of service request body limits exist to \
stop, so a raw route must have one: a `@limit(maxBody:)` on the \
handler, or a `limits { maxBody = … }` on the service.",
example: "@raw(contentType: \"image/png\") // ✗ no cap anywhere\n\
on POST(\"/avatars\") (body: Bytes) -> Effect[HttpResult[String]] { … }\n\n\
@raw(contentType: \"image/png\") // ✓ capped\n\
@limit(maxBody: 5_000_000)\n\
on POST(\"/avatars\") (body: Bytes) -> Effect[HttpResult[String]] { … }",
page: "/book/reference/http",
anchor: "raw-request-bodies",
},
Explain {
code: "bynk.provider.agent_call_undeclared_capability",
blurb: "A provider calls an agent handler, and the handler needs a capability \
the provider's `given` does not list. A handler's `given` is \
widened to cover the agent handlers it calls, but a provider's is \
not. The provider is constructed with exactly the capabilities in \
its `given`, and those are all it can hand on to the agent. So the \
provider must list everything the agent handler needs: the \
handler's own `given`, and the `given` of any agent handler it \
calls in turn.",
example: "agent Index {\n \
key name: String\n \
store hits: Cell[Int]\n \
on call withdraw() -> Effect[()] given Files { … }\n}\n\n\
provides Takedown = Bucket given Clock { // ✗ `withdraw` needs `Files`\n \
fn take(name: String) -> Effect[()] { Index(name).withdraw() }\n}\n\n\
provides Takedown = Bucket given Clock, Files { // ✓\n \
fn take(name: String) -> Effect[()] { Index(name).withdraw() }\n}",
page: "/book/guides/effects-and-capabilities/compose-a-provider",
anchor: "the-rules",
},
Explain {
code: "bynk.registry.withdrawn",
blurb: "Your `bynk.lock` locks a version that its registry has withdrawn. A \
withdrawal is a takedown — for a legal request or confirmed malware — \
so unlike a yank, which keeps a version for locked builds, the \
registry has deleted its archive and there is nothing to fetch. The \
message quotes the registry's reason. A machine that already has the \
tree in its store keeps building; elsewhere, move off the version \
with `bynk update` and the dependency's alias. The reason is unsigned, so when it was \
read through a mirror the message says the origin wasn't consulted.",
example: "error[bynk.registry.withdrawn]: `acme/money` 1.4.2 was withdrawn by \
registry `acme-internal`: \"removed at the copyright holder's request\"\n \
= note: `bynk.lock` locks this version; choose another with `bynk update money`\n\n\
$ bynk update money # resolves to the newest version not withdrawn",
page: "/book/guides/projects-build-and-deployment/run-a-private-registry",
anchor: "withdraw-a-version",
},
Explain {
code: "bynk.requires.unapproved",
blurb: "An adapter in a git or registry dependency requires an npm package \
your project hasn't approved. A dependency's adapters bring their \
npm packages into your build's `package.json`, and the next \
`npm install` runs whatever those packages run; so an npm package \
from someone else's code enters only after you approve it once. \
The approval is one package at one range, recorded in `bynk.lock` \
(`approved = true`), so a changed range asks again. Your own \
adapters and path dependencies need no approval.",
example: "# bynk.lock, as a fetch wrote it — the build fails until approved\n\
[[npm]]\npackage = \"jose\"\nrange = \"^5.2.0\"\n\
required-by = [\"acme/money:tokens\"]\n\n\
# after `bynk approve jose` — the build passes\n\
[[npm]]\npackage = \"jose\"\nrange = \"^5.2.0\"\n\
required-by = [\"acme/money:tokens\"]\napproved = true",
page: "/book/guides/projects-build-and-deployment/share-code-between-projects",
anchor: "approve-a-dependencys-npm-packages",
},
Explain {
code: "bynk.resolve.missing_field",
blurb: "A record must be constructed with every one of its fields. Bynk \
records have no defaults and no partial construction: a value of a \
record type is only valid once all its fields are present, so a \
downstream reader never has to wonder whether a field was set. \
Omitting a field is therefore an error, not a fill-in-later.",
example: "type User = { name: Text, age: Int }\n\n\
User { name: \"Ada\" } // ✗ missing `age`\n\
User { name: \"Ada\", age: 36 } // ✓ every field present",
page: "/book/reference/types",
anchor: "record-types",
},
Explain {
code: "bynk.resolve.unknown_field",
blurb: "A field access names a field the record type does not have. A \
record's fields are fixed by its type declaration; only those \
names exist on the value. This is usually a typo in the field \
name, or an access meant for a different type.",
example: "type User = { name: Text }\n\n\
user.nmae // ✗ no field `nmae`\n\
user.name // ✓ the declared field",
page: "/book/reference/types",
anchor: "record-types",
},
Explain {
code: "bynk.resolve.unknown_name",
blurb: "A name was referenced that is not in scope. Every name in Bynk \
must be introduced before use — as a `let` binding, a parameter, \
a `fn`, a type, or a member brought in through `uses`/`consumes`. \
An unknown name is typically a typo, a missing declaration, or a \
reference to something defined in a module that has not been \
brought into scope.",
example: "let greeting = \"hi\"\n\
greetng // ✗ no name `greetng` in scope\n\
greeting // ✓ the bound name",
page: "/book/guides/program-structure/how-a-program-is-shaped",
anchor: "",
},
Explain {
code: "bynk.resolve.unknown_type",
blurb: "A type name was referenced that does not exist. Types must be \
declared (with `type`), be one of Bynk's built-in types, or be \
brought into scope from another module before they can be named. \
An unknown type is usually a typo or a missing declaration/import.",
example: "fn greet(u: Usr) -> Text { … } // ✗ no type `Usr`\n\
fn greet(u: User) -> Text { … } // ✓ the declared type",
page: "/book/reference/types",
anchor: "",
},
Explain {
code: "bynk.types.claims_at_boundary",
blurb: "An `Oidc` actor's binder carries the verified token's claims (`who.claims`) for the \
handler that received the token. They are read there and never kept: a \
`TokenClaims` can't be a field, or cross a call, a message or an agent. Read the \
claim you need and keep that `String`.",
example: "type Seen = { claims: TokenClaims } // ✗\n\n\
let repo = w.claims.get(\"repository\") // ✓ keep the String",
page: "/book/reference/actors",
anchor: "reading-claims",
},
];
/// The curated explanation for a diagnostic `code`, or `None` when the code has
/// no explanation yet (the designed graceful-fallback state, DECISION B).
pub fn explain(code: &str) -> Option<&'static Explain> {
EXPLANATIONS.iter().find(|e| e.code == code)
}
/// The hosted diagnostic index page (the generated `reference/diagnostics`
/// page), the link target for a code with no curated [`Explain`] page.
pub const INDEX_PATH: &str = "/book/reference/diagnostics/";
/// The anchor slug of a category's `## <title>` heading on the generated
/// diagnostic index (Starlight/github-slugger shape: lowercase, spaces to
/// hyphens, punctuation dropped), e.g. `"type-checking"`.
fn category_anchor(cat: &str) -> String {
category_title(cat)
.chars()
.filter_map(|c| match c {
' ' => Some('-'),
c if c.is_alphanumeric() || c == '-' => Some(c.to_ascii_lowercase()),
_ => None,
})
.collect()
}
/// The hosted-Book link for any diagnostic `code`: the curated
/// [`Explain::href`] when one exists (what the LSP's `codeDescription` uses),
/// otherwise the diagnostic index, deep-linked to the code's category section
/// when the code is a registry code (a non-registry code, e.g. a host-synthetic
/// one, links the index top).
pub fn href(code: &str) -> String {
if let Some(e) = explain(code) {
return e.href();
}
let mut url = format!("{BOOK_BASE_URL}{INDEX_PATH}");
if lookup(code).is_some() {
url.push('#');
url.push_str(&category_anchor(category(code)));
}
url
}
/// Look up a code's registry entry by exact match — the one place
/// [`crate::error::Severity::for_error`] reads a code's severity, instead of
/// hardcoding its own copy of the (small) warning set.
pub fn lookup(code: &str) -> Option<&'static DiagnosticInfo> {
REGISTRY.iter().find(|d| d.code == code)
}
/// Every diagnostic code the compiler emits, sorted by code.
pub const REGISTRY: &[DiagnosticInfo] = &[
d(
"bynk.actor.bearer_identity_not_string_constructible",
"A `Bearer` actor's identity is not a string-constructible type.",
),
d(
"bynk.actor.bearer_missing_secret",
"A `Bearer` actor does not name its signing secret.",
),
d(
"bynk.actor.binder_shadows_param",
"A `by` actor binder collides with a handler parameter of the same name.",
),
d(
"bynk.actor.by_on_agent",
"A `by` actor clause was placed on an agent `on call` handler, which has no actor.",
),
d(
"bynk.actor.duplicate_sum_scheme",
"Two peers in a multi-actor sum share an authentication scheme.",
),
d(
"bynk.actor.foreign_context_name_unkeyable",
"A context declaring a `Foreign` actor has a name no call key can be named from.",
),
d(
"bynk.actor.foreign_duplicate_secret",
"A `Foreign` actor's secret is also another actor's secret in the same context.",
),
d(
"bynk.actor.foreign_identity_unsupported",
"A `Foreign` actor declares an `identity`.",
),
d(
"bynk.actor.foreign_missing_secret",
"A `Foreign` actor does not name the secret its calls are signed with.",
),
d(
"bynk.actor.foreign_name_is_context_name",
"A `Foreign` actor's name could be read as a context's name.",
),
d(
"bynk.actor.foreign_reserved_secret",
"A `Foreign` actor's secret uses a `BYNK_CALL_` edge key's name.",
),
d(
"bynk.actor.foreign_secret_not_string",
"A `Foreign` actor's secret is not a string.",
),
d(
"bynk.actor.identity_not_sealed",
"An actor identity type is not a context-ownable (sealed) value type.",
),
d(
"bynk.actor.missing_by_on_http",
"An HTTP handler lacks the required `by` actor clause.",
),
d(
"bynk.actor.oidc_identity_not_string_constructible",
"An `Oidc` actor's identity is not a string-constructible type.",
),
d(
"bynk.actor.oidc_missing_audience",
"An `Oidc` actor does not name its `audience`.",
),
d(
"bynk.actor.oidc_missing_issuer",
"An `Oidc` actor does not name its `issuer`.",
),
d(
"bynk.actor.oidc_missing_jwks",
"An `Oidc` actor does not name its `jwks` endpoint.",
),
d(
"bynk.actor.oidc_not_in_sum",
"An `Oidc` actor appears as a member of a multi-actor sum.",
),
d(
"bynk.actor.oidc_trust_from_is_secret",
"An `Oidc` actor's `trustFrom` names an environment variable that an actor uses as its `secret`.",
),
d(
"bynk.actor.oidc_trust_from_not_string",
"An `Oidc` actor's `trustFrom` isn't a string naming an environment variable.",
),
d(
"bynk.actor.outside_context",
"An `actor` was declared outside a context (e.g. in a commons).",
),
d(
"bynk.actor.refinement_base_unsupported",
"A refinement actor's base is not a `Bearer` actor (no claims to authorise against).",
),
d(
"bynk.actor.refinement_in_sum",
"A refinement actor appears as a member of a multi-actor sum.",
),
d(
"bynk.actor.refinement_predicate_unsupported",
"A refinement actor's `where` predicate is outside the closed claim-predicate set.",
),
d(
"bynk.actor.scheme_not_admissible",
"An actor's scheme is not admissible on this handler's protocol.",
),
d(
"bynk.actor.signature_identity_unsupported",
"A `Signature` actor declared an `identity`, which is not yet supported.",
),
d(
"bynk.actor.signature_missing_header",
"A `Signature` actor does not name its signature header.",
),
d(
"bynk.actor.signature_missing_secret",
"A `Signature` actor does not name its signing secret.",
),
d(
"bynk.actor.signature_requires_body",
"A `Signature` handler does not take a `body` parameter.",
),
d(
"bynk.actor.signature_tolerance_without_timestamp",
"A `Signature` actor set `tolerance` without a `timestamp` header.",
),
d(
"bynk.actor.sum_requires_binder",
"A multi-actor sum `by` clause has no binder to match the resolved actor.",
),
d(
"bynk.actor.unknown_actor",
"A handler's `by` clause names an actor that is not declared.",
),
d(
"bynk.actor.unknown_scheme",
"An actor declares an authentication scheme that is not compiler-known.",
),
d(
"bynk.actor.unreachable_sum_arm",
"A multi-actor sum has an arm unreachable after a catch-all (`None`) peer.",
),
dg(
"bynk.adapter.consumes_context",
"An `adapter` consumed a context; adapter dependencies are adapter-to-adapter.",
&["consumes_decl"],
),
dg(
"bynk.adapter.consumes_requires_selection",
"An `adapter` used a whole-unit or aliased `consumes`; adapters must select capabilities with `consumes U { Cap, … }`.",
&["consumes_decl"],
),
dg(
"bynk.adapter.disallowed_item",
"An `adapter` declared a `service`, `agent`, or other item it may not contain.",
&["adapter_decl"],
),
dg(
"bynk.adapter.duplicate_binding",
"An `adapter` declared more than one `binding` clause.",
&["binding_decl"],
),
dg(
"bynk.adapter.include_duplicate",
"An adapter `binding … includes [ … ]` list names one file more than once.",
&["binding_decl"],
),
dg(
"bynk.adapter.include_kind",
"An adapter `binding … includes [ … ]` entry is not a `.wasm` file; only WebAssembly modules can be included.",
&["binding_decl"],
),
dg(
"bynk.adapter.include_missing",
"An adapter `binding … includes [ … ]` entry names a file that could not be read.",
&["binding_decl"],
),
dg(
"bynk.adapter.include_outside",
"An adapter `binding … includes [ … ]` path is absolute or climbs out of the adapter's directory with `..`.",
&["binding_decl"],
),
dg(
"bynk.adapter.no_binding",
"An `adapter` declares an external provider but no `binding` module to supply it.",
&["adapter_decl"],
),
dg(
"bynk.adapter.provider_has_body",
"A provider inside an `adapter` has a Bynk body; adapter providers must be external.",
&["provider_decl"],
),
d(
"bynk.agent.class_conflict",
"An agent class has more than one fate: it is renamed twice, both renamed and removed, or renamed onto a class that already has its own recorded history in `bynk.schema.lock`.",
),
d(
"bynk.agent.class_removed",
"An agent class recorded in `bynk.schema.lock` is no longer declared, so a deployment's stored instances of it would be orphaned. If the class was never deployed, delete its `[agents]` entry from the lock; renaming or removing a deployed class gets its own declaration in a later state-migrations slice.",
),
dg(
"bynk.agent.construction_arity",
"An agent was constructed with the wrong number of key arguments.",
&["agent_decl"],
),
dg(
"bynk.agent.handler_arity",
"An agent handler was called with the wrong number of arguments.",
&["agent_decl"],
),
dg(
"bynk.agent.handler_not_found",
"Called a handler the agent does not declare.",
&["agent_decl"],
),
dg(
"bynk.agent.key_mismatch",
"An agent key argument has the wrong type.",
&["agent_decl"],
),
warn(d(
"bynk.agent.migrate_below_floor",
"A `migrate` step reads a schema version below the agent's floor. A complete `bynk migrate sweep` raised the floor past it, so no stored instance can hold that version: the step emits nothing and can be deleted (warning).",
)),
d(
"bynk.agent.migrate_duplicate",
"Two `migrate` steps in one agent read the same schema version.",
),
d(
"bynk.agent.migrate_duplicate_assignment",
"A `migrate` step assigns the same `store` field more than once; each field takes at most one value per step (record-literal semantics).",
),
d(
"bynk.agent.migrate_impure",
"A `migrate` step uses an effect, a capability, `?`, `expect`, or the agent's `key`; steps are pure and key-free so a migration sweep can run them by object ID.",
),
d(
"bynk.agent.migrate_incomplete",
"A `migrate` step does not account for every change between its version and the current shape: a removed field must be read (`old.f`) or dropped, and a retyped or re-kinded field must be assigned (or dropped, for a `Set`, `Log` or `Cache` field).",
),
d(
"bynk.agent.migrate_shape_mismatch",
"A `migrate` step's declared old shape (or a `drop`) names a field the lock does not record at that version, or records with a different structure.",
),
d(
"bynk.agent.migrate_unknown_version",
"A `migrate` step reads a schema version the lock does not record below the agent's current version.",
),
d(
"bynk.agent.non_additive_state_change",
"An agent's stored state changed in a way deployed data cannot be read through — a `store` field was removed, retyped (including inside a stored record or sum), or changed storage kind. A renamed field is a removed field plus an added one. If the class was never deployed, delete its `[agents]` entry from `bynk.schema.lock`; otherwise widen rather than narrow, or stage the change through a new field.",
),
dg(
"bynk.agent.outside_context",
"An `agent` was declared outside a context.",
&["agent_decl"],
),
warn(d(
"bynk.agent.refinement_changed",
"A stored `store` field's refinement changed while its structure did not. A widening is safe; a narrowing faults on load for any stored value that no longer satisfies it (`RehydrationViolation`), so migrate the data first (warning).",
)),
d(
"bynk.agent.removed_live",
"A `removed agent` declaration names a class that is still declared; removing a class deletes its stored data.",
),
d(
"bynk.agent.replaces_live",
"`agent New replaces Old` names an `Old` that is still declared; a rename moves the old class's data to the new one.",
),
d(
"bynk.agent.replaces_unknown",
"`agent New replaces Old` names an `Old` that `bynk.schema.lock` does not record for this context, so there is no recorded class to rename.",
),
dg(
"bynk.agent.return_not_effect",
"An agent handler's return type is not an `Effect`.",
&["agent_decl"],
),
d(
"bynk.agent.state_name_conflict",
"A type is named `<Agent>State` beside agent `<Agent>`; that name is the agent's state record (its `Cell` fields), which its handlers and invariants see in place of the type.",
),
warn(d(
"bynk.agent.version_without_path",
"A schema version between the agent's floor and its current version has no way forward: no `migrate` step covers it and its path to the current shape is not entirely additive, so a stored record at that version faults on load with `NoMigrationPath` (warning).",
)),
dg(
"bynk.agents.bad_state_initialiser",
"An agent `store` field initialiser is not a static value of the field's type.",
&["store_field"],
),
dg(
"bynk.agents.non_zeroable_state_field",
"An agent `store` field has no initialiser and no implicit zero value.",
&["store_field"],
),
d(
"bynk.asset.duplicate",
"An `asset` name is declared more than once in the same unit.",
),
d(
"bynk.asset.invalid_at_path",
"An `asset`'s `at` path is not a URL path naming one file, or lies under `/_assets/` or `/_bynk/`.",
),
warn(d(
"bynk.asset.may_shadow_route",
"A parameterised HTTP route matches a fixed asset path, so it never sees requests for that path (a warning).",
)),
d(
"bynk.asset.missing_file",
"An `asset` names a file that is not in the project's `assets/` folder.",
),
d(
"bynk.asset.needs_project",
"A single-file build met an `asset` declaration; assets need a project build.",
),
warn(d(
"bynk.asset.not_served",
"A deployable Bundle build met an `asset`; a Bundle ships no files, so its `.url` would not be served (a warning).",
)),
d(
"bynk.asset.outside_assets_dir",
"An `asset` path does not name a file in the project's `assets/` folder.",
),
d(
"bynk.asset.outside_context_or_commons",
"An `asset` declaration appears outside a context or commons.",
),
d(
"bynk.asset.path_conflict",
"Two different asset files would be served at one fixed path by the same Worker.",
),
d(
"bynk.asset.shadows_route",
"A fixed asset path equals a literal HTTP route, which the platform-served asset makes unreachable.",
),
d(
"bynk.asset.unreadable_file",
"An `asset` names a file in the project's `assets/` folder that could not be read.",
),
d(
"bynk.asset.unsafe_path",
"An `asset` path is empty, absolute, or contains a `..` segment.",
),
d(
"bynk.boundary.ambiguous_type",
"A value's type is declared, with different shapes, by more than one consumed context, so its fields cannot be read.",
),
d(
"bynk.boundary.structural_mismatch",
"Data crossing a context boundary did not match the expected shape.",
),
dg(
"bynk.capability.base_not_instantiable",
"A derived capability's base is not a platform resource that can be instantiated.",
&["capability_decl"],
),
dg(
"bynk.capability.derived_outside_context",
"A derived capability was declared outside a context.",
&["capability_decl"],
),
dg(
"bynk.capability.instance_only",
"A platform capability that is used only through named instances (`Service`, `R2`, `RateLimit`, `EdgeCache`) was used bare, in a `given` clause.",
&["given_clause"],
),
dg(
"bynk.capability.invalid_option",
"A derived capability's option is not one string literal, is given twice, or (`@worker`) is not a Worker name outside the project.",
&["capability_decl"],
),
dg(
"bynk.capability.missing_option",
"A derived capability lacks an option its base requires, such as a `Service` instance's `@worker`.",
&["capability_decl"],
),
dg(
"bynk.capability.not_provided",
"On the Workers target, a capability a context requires has no provider in it.",
&["given_clause"],
),
dg(
"bynk.capability.op_arity",
"A capability operation was called with the wrong number of arguments.",
&["capability_decl"],
),
dg(
"bynk.capability.outside_context",
"A `capability` was declared outside a context.",
&["capability_decl"],
),
dg(
"bynk.capability.provider_agent_cross_context",
"On the Workers target, a context requires a capability whose provider, in another context, constructs that context's agents; the consumer's Worker would build the provider without a binding for those agents' Durable Objects.",
&["given_clause"],
),
dg(
"bynk.capability.unknown_base",
"A derived capability's base is not a capability the context consumes.",
&["capability_decl"],
),
dg(
"bynk.capability.unknown_operation",
"Referenced an operation the capability does not declare.",
&["capability_decl"],
),
dg(
"bynk.capability.unknown_option",
"A derived capability carries an option its base does not take.",
&["capability_decl"],
),
d(
"bynk.cell.invalid_target",
"A `:=` write targets something that is not a `store Cell` field.",
),
d(
"bynk.cell.self_reference",
"A `:=` right-hand side reads the cell being written (a read-modify-write); use `.update`.",
),
d(
"bynk.cloudflare.edge_cache_duplicate",
"A context declares a second `EdgeCache` instance; the edge cache is one setting for the whole Worker.",
),
d(
"bynk.cloudflare.edge_cache_exported",
"An exported capability reaches an `EdgeCache` instance through its provider's `given`; a consuming context would build it in its own Worker, whose purge misses this one's cache.",
),
d(
"bynk.cloudflare.edge_cache_in_agent",
"An agent handler reaches an `EdgeCache` instance, directly or through a provider's `given`; an agent's purge would not reach the Worker's cache.",
),
d(
"bynk.cloudflare.edge_cache_in_queue",
"A queue consumer reaches an `EdgeCache` instance; purge from a service handler instead.",
),
d(
"bynk.cloudflare.edge_cache_in_schedule",
"An `on schedule` handler reaches an `EdgeCache` instance; a cron run's purge is accepted but clears nothing from the fetch cache, so purge from a service handler.",
),
d(
"bynk.cloudflare.edge_cache_public_authenticated",
"In a context with `EdgeCache`, a `@cache(scope: public)` route is served by an actor that authenticates; its response would be shared at the edge with every caller.",
),
dg(
"bynk.consumes.alias_conflict",
"Two `consumes` aliases collide.",
&["consumes_decl"],
),
dg(
"bynk.consumes.capability_name_clash",
"Two flattened `consumes U { Cap }` capabilities collide, or one clashes with a local capability.",
&["consumes_decl"],
),
dg(
"bynk.consumes.name_conflict",
"A `consumes` name collides with another name in scope.",
&["consumes_decl"],
),
dg(
"bynk.consumes.self_reference",
"A context `consumes` itself.",
&["consumes_decl"],
),
dg(
"bynk.consumes.service_arity",
"A consumed service was called with the wrong number of arguments.",
&["consumes_decl"],
),
dg(
"bynk.consumes.signature_type_unconsumed",
"A cross-context call reaches a service whose signature names a type the consumed context itself consumes from a third context, which the caller does not consume.",
&["consumes_decl"],
),
dg(
"bynk.consumes.target_is_commons",
"`consumes` targets a `commons` instead of a context.",
&["consumes_decl"],
),
dg(
"bynk.consumes.type_alias_capability",
"A capability was aliased in `consumes U { Cap as Alias }`; only exported types can be aliased.",
&["consumes_decl"],
),
dg(
"bynk.consumes.type_alias_conflict",
"A `consumes U { T as Alias }` alias collides with a type or value in scope, or with another alias.",
&["consumes_decl"],
),
dg(
"bynk.consumes.type_alias_repeated",
"An exported type is aliased more than once, or is selected both bare and aliased, in `consumes U { … }`.",
&["consumes_decl"],
),
dg(
"bynk.consumes.type_alias_unknown_export",
"`consumes U { T as Alias }` names a type `U` does not export.",
&["consumes_decl"],
),
dg(
"bynk.consumes.unknown_context",
"`consumes` names a context that does not exist.",
&["consumes_decl"],
),
dg(
"bynk.consumes.unknown_service",
"Called a service the consumed context does not declare.",
&["consumes_decl"],
),
d(
"bynk.context.consumes_cycle",
"Contexts form a `consumes` dependency cycle.",
),
d(
"bynk.context.duplicate_binding",
"A Worker would declare two bindings with the same name, such as an agent `Kv` and the `bynk.cloudflare` KV namespace (both `KV`).",
),
d(
"bynk.context.external_construction",
"A context-owned type was constructed from outside that context.",
),
d(
"bynk.context.external_decode",
"A context decoded a type another context owns and exports opaque, through `Json.decode`, `Json.decodeSql` or a `Codable` witness. Decoding creates a value, which only the owning context may do; its codec would check no more than the base type.",
),
dg(
"bynk.context.external_provider",
"A bodiless (external) provider was declared outside an `adapter`.",
&["provider_decl"],
),
d(
"bynk.context.opaque_inspection",
"An opaquely-exported type was inspected from outside its context.",
),
d(
"bynk.context.rebrand_construction",
"A variant of a `uses`-sourced commons sum type was constructed directly inside a context, where the emitter's per-context rebrand leaves its constructors out of scope.",
),
d(
"bynk.contract.duplicate_name",
"A function declares two contract clauses (`requires`/`ensures`) with the same name.",
),
d(
"bynk.contract.impure_predicate",
"A contract predicate uses an effectful or test-only construct; a contract clause must be pure.",
),
d(
"bynk.contract.not_bool",
"A contract predicate does not have type `Bool`.",
),
d(
"bynk.contract.restated_by_test",
"A `case`/`property` merely restates a contract clause already declared at the function; the test is redundant.",
),
d(
"bynk.contract.result_in_requires",
"A precondition (`requires`) references `result`; the return value is only in scope inside an `ensures`.",
),
dg(
"bynk.cron.bad_params",
"A cron handler declares more than one parameter, or a non-`Int` one.",
&["cron_handler"],
),
dg(
"bynk.cron.duplicate_schedule",
"Two cron handlers declare the same schedule.",
&["cron_handler"],
),
dg(
"bynk.cron.invalid_schedule",
"A cron expression is not five whitespace-separated fields.",
&["cron_handler"],
),
dg(
"bynk.cron.return_not_effect_result",
"A cron handler does not return `Effect[Result[(), E]]`.",
&["cron_handler"],
),
d(
"bynk.d1.migration_name",
"A file in the project's `migrations/` folder isn't `migrations/<database>/NNNN_<name>.sql`, or shares its number with another migration of the same database.",
),
d(
"bynk.d1.migration_unreadable",
"A `D1` migration in the project's `migrations/` folder can't be read, or isn't UTF-8 text.",
),
warn(d(
"bynk.d1.migrations_unused",
"A directory in the project's `migrations/` folder matches no `D1` instance's database name, so its migrations are never applied, usually because the capability was renamed (warning).",
)),
d(
"bynk.dependency.path_outside_root",
"A path dependency declared by a dependency resolves outside the workspace; a dependency's own path dependencies are honoured only between members of one workspace.",
),
d(
"bynk.deploy.contract_skew",
"A worker was compiled against a contract its live dependencies no longer provide, or no longer provides the contract its live callers were compiled against, so `bynk deploy --context` refuses to ship it.",
),
d(
"bynk.deploy.foreign_contract_skew",
"A build breaks the contract a declared foreign caller's client was generated at, as pinned in `bynk.foreign.toml`, so `bynk deploy` refuses to ship it.",
),
// LSP-only (#2459): published by `bynk-lsp` as a hint (or warning, per the
// `bynk.docLinks.reportUnresolved` setting); the compiler never emits it.
warn(d(
"bynk.doc.unresolved_link",
"A `[Name]` doc link resolves to nothing in the unit's scope (editor hint only).",
)),
d(
"bynk.duration.literal_overflow",
"A `Duration` literal (`<int>.<unit>`) exceeds the representable millisecond range.",
),
dg(
"bynk.effect.bind_in_pure_context",
"An `<-` bind was used in a pure (non-effectful) context.",
&["effect_let_stmt"],
),
dg(
"bynk.effect.bind_on_non_effect",
"An `<-` bind was applied to a non-`Effect` value.",
&["effect_let_stmt"],
),
d(
"bynk.effect.capability_in_pure_context",
"A capability was used in a pure context.",
),
d(
"bynk.effect.cross_context_in_pure_context",
"A cross-context call was made in a pure context.",
),
dg(
"bynk.effect.do_in_pure_context",
"A `do` statement was used in a pure (non-effectful) context.",
&["do_stmt"],
),
dg(
"bynk.effect.do_on_non_effect",
"A `do` statement was applied to a non-`Effect` value.",
&["do_stmt"],
),
dg(
"bynk.effect.do_requires_unit",
"A `do` statement was applied to a valued `Effect[T]`; `do` performs a unit effect, so a real result would be dropped — use `let _ <- e` instead.",
&["do_stmt"],
),
dg(
"bynk.effect.fn_value_in_pure_context",
"An effectful function value was called in a pure context; like a capability call, it is legal only where the enclosing body is effectful.",
&["call"],
),
d(
"bynk.effect.unbound_effect",
"An `Effect` value in an effectful body was built but not bound with `<-`, sequenced with `do` or returned — in a plain `let`, a list element or a constructor payload — so it runs eagerly and unawaited (#1658).",
),
d(
"bynk.embed.binary_content",
"An `embed` names a file with a NUL byte, so it is binary, not text.",
),
d(
"bynk.embed.duplicate",
"An `embed` name is declared more than once in the same unit.",
),
d(
"bynk.embed.invalid_encoding",
"An `embed` names a file that is not valid UTF-8.",
),
d(
"bynk.embed.missing_file",
"An `embed` names a file that is not in the project's `embeds/` folder.",
),
d(
"bynk.embed.needs_project",
"A single-file build met an `embed` declaration, which needs a project's `embeds/` folder.",
),
d(
"bynk.embed.outside_context_or_commons",
"An `embed` declaration appears outside a context or commons.",
),
d(
"bynk.embed.outside_embeds_dir",
"An `embed` names a file outside the project's `embeds/` folder.",
),
d(
"bynk.embed.too_large",
"An `embed` names a file over 256 KiB, or the project's embedded files total over 1 MiB.",
),
d(
"bynk.embed.unreadable_file",
"An `embed` names a file in the project's `embeds/` folder that could not be read.",
),
d(
"bynk.embed.unsafe_path",
"An `embed` path is empty, absolute, or contains a `..` segment.",
),
d(
"bynk.event.bad_params",
"An `on event` handler declared the wrong number of parameters, or a second parameter whose type is not `EventEnvelope` — it takes the event payload and, optionally, the runtime envelope.",
),
d(
"bynk.event.bad_schema_dispatch",
"A `via schema(...)` dispatch clause's argument is malformed — it must be a positive `Int` literal, a range of positive `Int` literals, or `_`.",
),
d(
"bynk.event.bad_schema_version",
"An event's `@schema(N)` annotation is malformed — `N` must be a single, positive, positional `Int` literal, and `@schema` may appear at most once on an event.",
),
dg(
"bynk.event.duplicate_handler",
"A `from Events` service declares more than one `on event` handler; it has exactly one.",
&["event_handler"],
),
d(
"bynk.event.emit_not_an_event",
"`Events.emit[E]` named a type `E` that is declared in this context, but is not itself an `event` — only an `event` type may be emitted.",
),
d(
"bynk.event.emit_outside_owner",
"`Events.emit[E]` named an event `E` not declared in the emitting context — only an event's declaring context may emit it.",
),
d(
"bynk.event.handler_param_type_mismatch",
"An `on event(e: T)` handler's declared parameter type does not match its `from Events(E)` header's event type.",
),
d(
"bynk.event.non_additive_schema_change",
"An event's field shape changed in a way the schema registry cannot evolve additively — a field was removed, retyped, added without a default, or lost a default it previously had. Give the new shape a new event type name, or make the change additive.",
),
d(
"bynk.event.outside_context",
"An `event` was declared outside a context.",
),
d(
"bynk.event.pattern_duplicate_field",
"A `from Events(E { ... })` subscription pattern listed the same field more than once.",
),
d(
"bynk.event.pattern_type_mismatch",
"A `from Events(E { ... })` subscription pattern field's matched value is not compatible with that field's declared type.",
),
d(
"bynk.event.pattern_unknown_field",
"A `from Events(E { ... })` subscription pattern named a field that `E` does not declare.",
),
d(
"bynk.event.pattern_unknown_variant",
"A `from Events(E { ... })` subscription pattern's variant value names a variant that does not exist on the field's declared sum type.",
),
d(
"bynk.event.pattern_variant_payload",
"A `from Events(E { ... })` subscription pattern's variant value names a variant that carries a payload — only nullary variants are admitted, since testing the tag alone would silently ignore the payload.",
),
dg(
"bynk.event.return_not_effect_unit",
"An `on event` handler returns an `Effect` of something other than `()`; emission is fire-and-forget, so it returns `Effect[()]`.",
&["event_handler"],
),
d(
"bynk.event.schema_version_mismatch",
"An event's `@schema(N)` annotation disagrees with the version the schema registry computes from the event's build history.",
),
d(
"bynk.event.unknown_annotation",
"An `event` declaration carried an `@`-annotation other than `@schema` — event annotations are a closed set.",
),
d(
"bynk.event.unknown_subscription",
"A `from Events(E)` subscription named `E`, which is not a declared event in this context or any consumed context.",
),
d(
"bynk.exec.unavailable",
"A call to, or reference to, a function that hands work to the execution context (`~>`, `within` or `race`, directly or through the functions it calls) appears where no execution context exists: an agent handler, a WebSocket handler or a provider operation.",
),
dg(
"bynk.expect.faults_not_effect",
"A fault claim's subject (`expect <call> faults`) is not an effectful call: a value, or a call whose type is not `Effect[_]`.",
&["faults_expr"],
),
dg(
"bynk.expect.not_bool",
"`expect` was given a non-`Bool` predicate.",
&["expect_expr"],
),
dg(
"bynk.expect.outside_case",
"`expect` was used outside a `case` body.",
&["expect_expr"],
),
dg(
"bynk.exports.capability_not_provided",
"An exported capability has no provider in its context.",
&["exports_decl"],
),
dg(
"bynk.exports.conflicting_visibility",
"A type is exported with conflicting visibilities.",
&["exports_decl"],
),
dg(
"bynk.exports.derived_capability",
"`exports capability` names a derived capability, whose instance stays with its context.",
&["exports_decl"],
),
dg(
"bynk.exports.duplicate_export",
"The same name is exported more than once.",
&["exports_decl"],
),
dg(
"bynk.exports.duplicate_in_clause",
"A name appears twice in one `exports` clause.",
&["exports_decl"],
),
dg(
"bynk.exports.undeclared_capability",
"`exports capability` names a capability that is not declared.",
&["exports_decl"],
),
dg(
"bynk.exports.undeclared_type",
"`exports` names a type that is not declared.",
&["exports_decl"],
),
warn(d(
"bynk.fault.todo",
"A `todo(message)` placeholder: the code type-checks but faults when it runs. A non-failing warning, so `check --deny-warnings` refuses unfinished code in CI (warning).",
)),
dg(
"bynk.fixture.binary_content",
"A suite's `fixture` names a file that contains a NUL byte, so it is binary, not text.",
&["fixture_decl"],
),
dg(
"bynk.fixture.duplicate",
"A suite declares two `fixture`s of the same name.",
&["fixture_decl"],
),
dg(
"bynk.fixture.invalid_encoding",
"A suite's `fixture` names a file that is not valid UTF-8.",
&["fixture_decl"],
),
dg(
"bynk.fixture.missing_file",
"A suite's `fixture` names a file that is not in the project's `fixtures/` folder.",
&["fixture_decl"],
),
dg(
"bynk.fixture.outside_fixtures_dir",
"A suite's `fixture` names a file outside the project's `fixtures/` folder.",
&["fixture_decl"],
),
dg(
"bynk.fixture.too_large",
"A suite's `fixture` names a file over the 4 MiB limit for one fixture file.",
&["fixture_decl"],
),
dg(
"bynk.fixture.unreadable_file",
"A suite's `fixture` names a listed file that could not be read.",
&["fixture_decl"],
),
dg(
"bynk.fixture.unsafe_path",
"A suite's `fixture` path is empty, absolute or contains a `..` segment.",
&["fixture_decl"],
),
warn(dg(
"bynk.fixture.unused",
"A suite declares a `fixture` that none of its cases, properties or helpers uses (warning).",
&["fixture_decl"],
)),
d(
"bynk.fmt.comment_loss",
"The formatter would drop a comment, so it leaves the file unchanged.",
),
d(
"bynk.fmt.mixed_comment_syntax",
"A file mixes the retired `--` comment or `--|` doc spellings with a line that reads differently under the old and new comment rules (#2203), so the formatter leaves it unchanged.",
),
d(
"bynk.fmt.roundtrip",
"The formatter's output does not re-parse to the same program, so it leaves the file unchanged.",
),
dg(
"bynk.generics.ambiguous_instantiation",
"A generic function with an `Ord` bound is used as a value, and its type arguments cannot be determined from the type expected at that reference; annotate the expected type (constrained-generics slice 1).",
&["fn_decl"],
),
dg(
"bynk.generics.bound_on_capability_op",
"A generic capability operation's type parameter carries a bound other than `Key` or `Codable`; operations take only those two (constrained-generics slices 2 and 3).",
&["capability_op"],
),
dg(
"bynk.generics.codable_op_return",
"A capability operation\'s `Codable` type parameter appears in its return type. A `Codable` parameter is encoded at the call site; decoding a provider\'s reply raises a question this slice does not answer (what a failed decode of stored data means), so typed reads are deferred (constrained-generics slice 3).",
&["capability_op"],
),
dg(
"bynk.generics.duplicate_type_param",
"A `type` or `fn` declares the same type-parameter name more than once (v0.157, ADR 0183).",
&[],
),
dg(
"bynk.generics.generic_non_record",
"A `type` declaration carries type parameters on a refined or opaque body; only a record (`type Name[T] = { … }`) or sum (`type Name[T] = | … | …`) body may be generic (v0.157/#593, ADRs 0183/0197).",
&["type_decl"],
),
dg(
"bynk.generics.generic_record_at_boundary",
"A `Val[…]` fabricates a value of a generic type; per-instantiation value fabrication is not yet wired (ADR 0197). Since v0.174 a generic-record instantiation may otherwise cross a boundary through its monomorphised codec.",
&[],
),
dg(
"bynk.generics.generic_sum_embeds",
"A generic sum type carries an `embeds` clause; embedding into a generic sum is not supported (#593).",
&["type_decl"],
),
dg(
"bynk.generics.method_on_generic_type",
"A *static* method on a generic type never mentions one of the type's parameters in its parameter or return types, so no call could determine it from the arguments or the expected type. Mention the parameter in the signature, or make the method a free function (constrained-generics slice 4; instance methods are supported, #594).",
&["fn_decl"],
),
dg(
"bynk.generics.missing_codable_bound",
"A type parameter is encoded or decoded with `Json.encode`/`Json.decode`, or passed to a `Codable`-bounded parameter of another generic or of a capability operation, but is not declared `Codable` (`[T: Codable]`, or `where A: Codable` for a receiver type\'s parameter). The diagnostic carries a machine-applicable fix that declares `Codable`, beside an existing `Eq`, which `Codable` does not imply (constrained-generics slice 3).",
&["fn_decl"],
),
dg(
"bynk.generics.missing_eq_bound",
"A type parameter is compared with `==`/`!=`, or passed to an `Eq`-bounded parameter of another generic, but is not declared `Eq` (`[T: Eq]`, or `where A: Eq` for a receiver type's parameter). The diagnostic carries a machine-applicable fix (ADR 0430, amended by constrained-generics slice 0).",
&["fn_decl"],
),
dg(
"bynk.generics.missing_key_bound",
"A type parameter keys a `Map` or `Set` (a `Map` key, a `Set` element, a `distinct`/`groupBy`/join key), or is passed to a `Key`-bounded parameter of another generic, but is not declared `Key` (`[K: Key]`, or `where A: Key` for a receiver type's parameter; on the type for a generic type's own parameter). The diagnostic carries a machine-applicable fix that declares `Key`, replacing an existing `Eq`, which `Key` implies (constrained-generics slice 2).",
&["fn_decl"],
),
dg(
"bynk.generics.missing_ord_bound",
"A type parameter is ordered (`<`, `<=`, `>`, `>=`, an ordering kernel key), or passed to an `Ord`-bounded parameter of another generic, but is not declared `Ord` (`[T: Ord]`, or `where A: Ord` for a receiver type's parameter). The diagnostic carries a machine-applicable fix that declares `Ord`, replacing an existing `Eq`, which `Ord` implies (constrained-generics slice 1).",
&["fn_decl"],
),
dg(
"bynk.generics.recursive_generic_at_boundary",
"A recursive generic record (one that transitively contains itself, through any wrapper or generic argument) appears at a boundary; it has no finite set of monomorphised codecs, so it is not yet boundary-serialisable (ADR 0197).",
&[],
),
warn(dg(
"bynk.generics.redundant_eq_bound",
"A type parameter is declared both `Eq` and `Ord` (or `Eq` and `Key`); `Ord` and `Key` imply `Eq`, so the `Eq` is redundant. The diagnostic carries a machine-applicable fix that removes it (constrained-generics slices 1 and 2, warning).",
&["fn_decl"],
)),
dg(
"bynk.generics.type_arg_count",
"A user-declared generic type is applied to the wrong number of type arguments, or a generic type is named without its `[…]` arguments (v0.157, ADR 0183).",
&["applied_type_ref"],
),
dg(
"bynk.generics.type_arg_mismatch",
"Inferred or explicit type arguments conflict, have the wrong arity, target a non-generic function, or a type parameter shadows a declared type.",
&["call"],
),
dg(
"bynk.generics.uninferable_type_arg",
"A generic function's type parameter could not be inferred from the arguments and was not given explicitly (`name[T](…)`); a bare generic function also cannot be passed as a value in v0.20a.",
&["call"],
),
dg(
"bynk.generics.unknown_constraint",
"A bound names something that is not a constraint; `Eq` is the only one.",
&["type_param"],
),
dg(
"bynk.generics.unknown_where_param",
"A method's `where` clause bounds a name that is not a type parameter of the method or of its receiver type.",
&["where_clause"],
),
dg(
"bynk.given.cross_context_unknown_capability",
"`given B.Cap` names a capability the consumed context does not export.",
&["given_clause"],
),
dg(
"bynk.given.fn_outside_context",
"A function in a commons (or a suite) declares `given`; only a context function can.",
&["given_clause"],
),
dg(
"bynk.given.fn_unsupported",
"A `given` clause on a method, on a function that does not return `Effect[T]`, or naming `Events`.",
&["given_clause"],
),
dg(
"bynk.given.missing_for_call",
"A call to a function that declares `given` from a body that does not declare those capabilities.",
&["given_clause"],
),
dg(
"bynk.given.undeclared_capability",
"A handler uses a capability it did not declare with `given`.",
&["given_clause"],
),
dg(
"bynk.given.unknown_capability",
"`given` names a capability that does not exist.",
&["given_clause"],
),
warn(dg(
"bynk.given.unused_capability",
"A `given` capability is never used (warning).",
&["given_clause"],
)),
d(
"bynk.held.branch_divergence",
"Branches of a conditional leave a held value (e.g. `Connection[F]`) in inconsistent ownership states — one consumes or stores it, another leaves it owned (§2.9.5, real-time track slice 2).",
),
d(
"bynk.held.consume_on_borrow",
"A consuming operation (`close`/`put`/`take`) is called on a *borrowed* held reference — borrows admit only non-consuming operations like `send` (§2.9.3, real-time track slice 2).",
),
d(
"bynk.held.leak",
"A held value (`Connection[F]`) is still owned at scope exit — it must be disposed (stored, closed, or transferred) before the handler or function returns (§2.9.1, real-time track slice 2).",
),
d(
"bynk.held.query_accessor_on_held_map",
"A key-aware query accessor (`.entries`/`.keys`/`.values`) is used on a held `Map[K, Connection]` — a held resource is iterated with the broadcast ops (`forEach`/`parTraverse`), not a key query.",
),
d(
"bynk.held.unsupported_map_op",
"A held `Map[K, Connection]` is given an `update`/`upsert` — a held resource cannot be transformed by a `(Connection) -> Connection` function; use `put`/`get`/`remove` (real-time track slice 3b-ii).",
),
d(
"bynk.held.unsupported_storage",
"A held value (`Connection[F]`) is stored in a `Set`/`Log`/`Cache` — held values may only live in `Cell[Option[Connection]]` or `Map[K, Connection]` (§2.9.3, real-time track slice 2).",
),
d(
"bynk.held.use_after_consume",
"A held value (`Connection[F]`) is used after a consuming operation (`close`/`put`/`take`) ended its lifetime (§2.9.2, real-time track slice 2).",
),
d(
"bynk.history.not_an_agent",
"A `for all run: History[T]` names a `T` that is not an agent — only an agent has handlers to sequence and reachable states to observe (testing track slice 7, ADR 0155).",
),
d(
"bynk.history.not_generable",
"A `for all run: History[Agent]` targets an agent with a handler parameter whose type cannot be generated (e.g. a `Matches` refinement), so its call-history cannot be driven (testing track slice 7, ADR 0155).",
),
d(
"bynk.history.outside_property",
"`History[Agent]` appears outside a `property`'s `for all` binding — it is a test-only generator, not a value type (testing track slice 7, ADR 0155).",
),
d(
"bynk.history.restates_invariant",
"A history property merely re-checks a guarantee a declared `invariant`/`transition` already enforces on every reached state (testing track slice 7, ADR 0155).",
),
dg(
"bynk.http.body_on_get_or_delete",
"A GET or DELETE handler declares a `body` parameter.",
&["http_handler"],
),
d(
"bynk.http.cache_bad_immutable",
"A `@cache` annotation's `immutable` is not a `Bool` literal.",
),
d(
"bynk.http.cache_bad_max_age",
"A `@cache` annotation's `maxAge` is missing or not a positive `Duration` literal.",
),
d(
"bynk.http.cache_bad_scope",
"A `@cache` annotation's `scope` is not `public` or `private`.",
),
d(
"bynk.http.cache_duplicate",
"A handler carries more than one `@cache` annotation.",
),
d(
"bynk.http.cache_max_age_fractional_seconds",
"A `@cache` annotation's `maxAge` is positive but does not resolve to a whole number of seconds.",
),
d(
"bynk.http.cache_on_non_get",
"A `@cache` annotation is placed on a handler that is not `on http GET`.",
),
d(
"bynk.http.cache_unknown_arg",
"A `@cache` annotation has an argument outside the closed set (`maxAge`/`scope`/`immutable`).",
),
d(
"bynk.http.cors_invalid_field",
"A `cors` policy field (`headers`/`credentials`/`maxAge`) has the wrong value shape.",
),
d(
"bynk.http.cors_invalid_origins",
"A `cors` policy's `origins` is missing, empty, or not a list of string literals.",
),
d(
"bynk.http.cors_not_http",
"A `cors { }` policy appears on a service that is not `from http`.",
),
d(
"bynk.http.cors_unknown_field",
"A `cors { }` policy declares a field outside the closed set.",
),
d(
"bynk.http.cors_wildcard_credentials",
"A `cors` policy combines `credentials: true` with the wildcard origin `[\"*\"]`.",
),
dg(
"bynk.http.duplicate_rejected",
"A `from http` service declares `on rejected` more than once.",
&["rejected_handler"],
),
dg(
"bynk.http.duplicate_route",
"Two handlers share the same method and route.",
&["http_handler"],
),
d(
"bynk.http.error_status_position",
"An `ErrorStatus` name is used anywhere but as `RawError`'s first argument.",
),
dg(
"bynk.http.extra_param",
"A handler parameter is not a path parameter, `body`, `headers` or `query`.",
&["http_handler"],
),
dg(
"bynk.http.headers_wrong_type",
"An HTTP handler's `headers` parameter is not typed `RequestHeaders`.",
&["http_handler"],
),
dg(
"bynk.http.invalid_path",
"An HTTP route path is malformed.",
&["http_handler"],
),
d(
"bynk.http.json_duplicate",
"A handler carries more than one `@json` annotation.",
),
d(
"bynk.http.json_invalid_arg",
"A `@json` annotation's `options` argument is missing or is not `tagged` or `plain`.",
),
d(
"bynk.http.json_invalid_field",
"A `json { }` policy's `options` is not `tagged` or `plain`.",
),
d(
"bynk.http.json_not_http",
"A `json { }` policy appears on a service that is not `from http`.",
),
d(
"bynk.http.json_on_non_http",
"A `@json` annotation is placed on a handler that is not `on http`.",
),
d(
"bynk.http.json_unknown_arg",
"A `@json` annotation has an argument outside the closed set (`options`).",
),
d(
"bynk.http.json_unknown_field",
"A `json { }` policy declares a field outside the closed set (`options`).",
),
d(
"bynk.http.limit_bad_max_body",
"A `@limit` annotation's `maxBody` is missing or not a positive `Int` literal.",
),
d(
"bynk.http.limit_duplicate",
"A handler carries more than one `@limit` annotation.",
),
d(
"bynk.http.limit_on_bodyless",
"A `@limit` annotation is placed on a handler that takes no body (a GET or DELETE).",
),
d(
"bynk.http.limit_unknown_arg",
"A `@limit` annotation has an argument outside the closed set (`maxBody`).",
),
d(
"bynk.http.limits_invalid_field",
"A `limits` policy field (`maxBody`) has the wrong value shape.",
),
d(
"bynk.http.limits_not_http",
"A `limits { }` policy appears on a service that is not `from http`.",
),
d(
"bynk.http.limits_unknown_field",
"A `limits { }` policy declares a field outside the closed set.",
),
dg(
"bynk.http.path_param_not_stringy",
"A path parameter's type is not constructible from a string.",
&["http_handler"],
),
dg(
"bynk.http.query_field_not_stringy",
"A field of an HTTP handler's `query` record has a type a query string cannot carry.",
&["http_handler"],
),
dg(
"bynk.http.query_not_http",
"A `RequestQuery` appears on a handler that is not an HTTP route.",
&["http_handler"],
),
dg(
"bynk.http.query_wrong_type",
"An HTTP handler's `query` parameter is neither a record type nor `RequestQuery`.",
&["http_handler"],
),
d(
"bynk.http.raw_bad_content_type",
"A `@raw` annotation's `contentType` is missing or not a `type/subtype` (or `\"*/*\"`) string literal.",
),
d(
"bynk.http.raw_body_not_bytes",
"The `body` of a `@raw` handler is not typed `Bytes`.",
),
d(
"bynk.http.raw_body_unbounded",
"A `@raw` route has no request-body cap (no `@limit` and no service `limits`).",
),
d(
"bynk.http.raw_duplicate",
"A handler carries more than one `@raw` annotation.",
),
d(
"bynk.http.raw_error_status",
"`RawError`'s first argument is not an `ErrorStatus` name (a 4xx or 5xx `HttpResult` variant name).",
),
d(
"bynk.http.raw_on_bodyless",
"A `@raw` annotation is placed on a handler that takes no body.",
),
d(
"bynk.http.raw_unknown_arg",
"A `@raw` annotation has an argument outside the closed set (`contentType`).",
),
dg(
"bynk.http.rejected_signature",
"An `on rejected` handler is not `on rejected(why: BoundaryRejection) -> HttpResult[()]` with no `by` and no `given`.",
&["rejected_handler"],
),
dg(
"bynk.http.reserved_prefix",
"A route uses the reserved `/_bynk/` prefix.",
&["http_handler"],
),
dg(
"bynk.http.return_not_effect_http_result",
"An HTTP handler does not return `Effect[HttpResult[T]]`.",
&["http_handler"],
),
d(
"bynk.http.security_invalid_field",
"A `security` policy field (`hsts`/`nosniff`) has the wrong value shape.",
),
d(
"bynk.http.security_not_http",
"A `security { }` policy appears on a service that is not `from http`.",
),
d(
"bynk.http.security_unknown_field",
"A `security { }` policy declares a field outside the closed set.",
),
dg(
"bynk.http.unbound_path_param",
"A `:name` route segment has no matching handler parameter.",
&["http_handler"],
),
d(
"bynk.http.unknown_handler_annotation",
"A handler carries an annotation outside the closed set (`@cache`/`@limit`).",
),
d(
"bynk.index.bad_argument",
"An `@indexed` argument is not a `by: <field>` label.",
),
warn(d(
"bynk.index.missing",
"A query filters a map by equality on a field that is not `@indexed` (a perf-hint warning).",
)),
d(
"bynk.index.unkeyable_key",
"An `@indexed(by: k)` field is not value-keyable.",
),
d(
"bynk.index.unknown_key",
"An `@indexed(by: k)` field is not a field of the map's value type.",
),
warn(d(
"bynk.index.unused",
"A declared `@indexed(by: k)` is never used by an equality filter (a hygiene warning).",
)),
d(
"bynk.invariant.cross_agent_reference",
"An invariant predicate references another agent; invariants are per-agent.",
),
d(
"bynk.invariant.duplicate_name",
"An agent declares two invariants with the same name.",
),
d(
"bynk.invariant.impure_predicate",
"An invariant predicate uses an effectful or test-only construct.",
),
d(
"bynk.invariant.not_bool",
"An invariant predicate does not have type `Bool`.",
),
d(
"bynk.json.nested_option_plain",
"A plain-JSON route's response type contains an `Option[U]` whose payload `U` can itself encode as `null` (`Option[T]` or `()`), so `Some(U)` and `None` would both be written `null`.",
),
dg(
"bynk.lambda.unannotated_param",
"A lambda parameter has no type annotation in a position where no function type is expected to infer it from.",
&["lambda_expr"],
),
dg(
"bynk.lex.bad_escape",
"An invalid escape sequence in a string literal.",
&["string_literal"],
),
dg(
"bynk.lex.bad_unicode_escape",
"A `\\u{…}` escape names a surrogate or a value above U+10FFFF.",
&["string_literal"],
),
dg(
"bynk.lex.decimal_literal_too_large",
"A decimal literal has more than 100 fraction digits or more than 1000 characters, the most any `Decimal` may have (#2622).",
&["decimal_literal"],
),
dg(
"bynk.lex.float_literal_overflow",
"A float literal does not fit a finite 64-bit float.",
&["float_literal"],
),
dg(
"bynk.lex.integer_overflow",
"An integer literal is outside the `Int` range, the JS safe integers ±(2^53 − 1).",
&["number_literal"],
),
dg(
"bynk.lex.interpolation_too_deep",
"A string interpolation `\\(…)` nests deeper than the lexer's fixed limit.",
&["string_literal"],
),
d(
"bynk.lex.legacy_comment",
"A `--` line comment, the spelling before #2203; a comment is `//` (auto-fixable; `bynk fmt` rewrites it).",
),
d(
"bynk.lex.legacy_doc_line",
"A `--|` one-line doc, the spelling before #2203; a one-line doc is `--- text` (auto-fixable; `bynk fmt` rewrites it).",
),
dg(
"bynk.lex.multiline_close_not_own_line",
"A `\"\"\"` inside a multi-line string literal is not on a line of its own.",
&["string_literal"],
),
dg(
"bynk.lex.multiline_in_hole",
"A multi-line string literal appears inside an interpolation hole, which must close on its own line.",
&["string_literal"],
),
dg(
"bynk.lex.multiline_indent",
"A line of a multi-line string literal is indented less than its closing `\"\"\"`.",
&["string_literal"],
),
dg(
"bynk.lex.multiline_open",
"The opening `\"\"\"` of a multi-line string literal is not followed by a newline, or by a language tag (`\"\"\"sql`) and a newline.",
&["string_literal"],
),
d(
"bynk.lex.slash_doc",
"A `///` doc comment first on its line; a Bynk doc is `--- text` or a `---` block (auto-fixable).",
),
d(
"bynk.lex.unclosed_doc_block",
"A documentation block is not closed.",
),
d(
"bynk.lex.unexpected_character",
"An unexpected character in the source.",
),
dg(
"bynk.lex.unterminated_interpolation",
"An interpolation hole `\\(…)` is not closed on its line.",
&["string_literal"],
),
dg(
"bynk.lex.unterminated_string",
"A string literal is not terminated.",
&["string_literal"],
),
warn(d(
"bynk.list.deprecated_function",
"A `bynk.list` free function (`map`/`filter`/`find`/`any`/`all`) is deprecated in favour of the `List` method form (warning; auto-fixable).",
)),
d(
"bynk.locale.multiple_message_bundles",
"A context consumes `Locale` but its direct `uses` reaches two or more message-bundle commons — there is no single bundle to negotiate against.",
),
d(
"bynk.messages.format_mismatch",
"A code's placeholder is formatted as a different ICU kind (plain/plural/select/number/date) across declared locales.",
),
d(
"bynk.messages.incomplete",
"A locale is missing a code the reference locale declares.",
),
d(
"bynk.messages.invalid_locale_tag",
"A `messages` block's locale tag is not a valid `LocaleTag` (e.g. `messages \"xx\"` where `xx` doesn't match the tag pattern).",
),
d(
"bynk.messages.malformed_icu_syntax",
"A message template's ICU placeholder syntax is invalid — unbalanced arm braces, an unknown format keyword, `#` outside a plural arm, a missing mandatory `other` arm, or an explicitly out-of-scope construct (`selectordinal`, `offset:`/`=N`, a CLDR skeleton).",
),
d(
"bynk.messages.missing_locale_dependency",
"A commons declaring `messages` doesn't `uses bynk.locale` and/or `uses bynk.locale.types`, which its generated `render` and the types its signature names need.",
),
d(
"bynk.messages.missing_reference",
"A message bundle has no `@reference` block.",
),
d(
"bynk.messages.multiple_reference",
"A message bundle has more than one `@reference` block.",
),
d(
"bynk.messages.outside_commons",
"A `messages` declaration appears outside a commons.",
),
d(
"bynk.messages.placeholder_mismatch",
"A locale's template for a code uses a different set of `{name}` placeholders than the reference locale's.",
),
d(
"bynk.namespace.reserved",
"A user unit is named `bynk` or `bynk.*`; the `bynk` root is reserved for the toolchain.",
),
d(
"bynk.observe.impure_with",
"A `with` predicate uses an effectful or test-only construct; it must be pure.",
),
d(
"bynk.observe.not_a_seam",
"An observation targets a capability the unit under test does not consume.",
),
d(
"bynk.observe.trace_outside_test",
"`trace(Cap.op)` appears outside a `case` body.",
),
d(
"bynk.observe.unknown_op",
"An observation names an operation the capability does not declare.",
),
d(
"bynk.observe.with_not_bool",
"A `with` predicate does not have type `Bool`.",
),
d(
"bynk.package.alias_shadows_unit",
"A dependency alias in `[dependencies]` is also the first segment of one of the project's own units, so `<alias>.…` would be ambiguous.",
),
d(
"bynk.package.checksum_mismatch",
"A git dependency's store entry, or a freshly fetched commit, doesn't hash to the checksum `bynk.lock` records; `bynk` refuses to build it.",
),
d(
"bynk.package.dependency_cycle",
"The package graph has a cycle: a dependency depends, directly or not, on itself or on the project.",
),
d(
"bynk.package.dependency_not_found",
"A path dependency's directory has no readable `bynk.toml`, its `bynk.toml` is invalid, or it has no `[package]`.",
),
d(
"bynk.package.dev_dependency_in_source",
"A commons, context or adapter reaches a `[dev-dependencies]` alias, which only a suite may use.",
),
d(
"bynk.package.duplicate_source",
"One package is reached from two different directories; a build holds one copy of each package.",
),
d(
"bynk.package.git_failed",
"`git` couldn't clone, fetch or check out a git dependency, or the revision it names doesn't exist.",
),
d(
"bynk.package.lock_invalid",
"`bynk.lock` can't be read: it isn't valid TOML, has no `version`, is a version this toolchain doesn't read, or locks a package to something that isn't a commit.",
),
d(
"bynk.package.lock_out_of_date",
"`--locked` was given, and resolving the manifests would change `bynk.lock`.",
),
d(
"bynk.package.name_mismatch",
"A path dependency's `package` names a different package than the directory's `[package] name`.",
),
d(
"bynk.package.not_fetched",
"A git dependency has no `bynk.lock` entry, or its store entry is missing; `bynk fetch` fetches it (refused under `--offline`).",
),
d(
"bynk.package.unit_not_exported",
"A `uses` or `consumes` reaches a unit its dependency declares but doesn't list in `[package] exports`.",
),
d(
"bynk.package.unknown_unit",
"A `uses` or `consumes` names, through a dependency alias, a unit the dependency doesn't declare.",
),
d(
"bynk.package.unsafe_source",
"A git dependency's URL or revision looks like a command-line option, or uses a transport other than `https`, `ssh` (or `file`, from the project's own manifests).",
),
d(
"bynk.package.unsupported_in_dependency",
"A dependency declares an `asset` or an `embed`, which would resolve against the consuming project's `assets/` or `embeds/`; a per-package namespace for either isn't designed yet.",
),
d(
"bynk.package.version_conflict",
"One package is reached at two different git revisions (or from git and a path); a build, or a workspace, holds one copy of each package.",
),
dg(
"bynk.par.invalid_statement",
"A `par { … }` block holds a statement other than `let x <- e` or `do e`: a refutable `let … else`, a plain `let`, `~>`, `:=` or a store write, `expect`, `advance`, a nested `par`, or anything that is not a statement.",
&["par_stmt"],
),
dg(
"bynk.par.question_in_join",
"A `?` appears inside a `par { … }` binding. `?` takes a `Result` value, not an effect, so a binding's own result is unwrapped after the block (`let user = userR?`), where the `?` lines run in source order; a `?` on an argument is computed before the block.",
&["par_stmt"],
),
dg(
"bynk.par.sibling_name",
"A `par { … }` binding mentions a name another binding in the same block binds, or binds a name twice. The bindings run together, so none can read a sibling's result; the rule holds even where the name would resolve to an outer binding.",
&["par_stmt"],
),
warn(dg(
"bynk.par.single_binding",
"A `par { … }` block has a single binding, which is a plain `let x <- e` with extra syntax (warning).",
&["par_stmt"],
)),
d(
"bynk.parse.clause_after_statement",
"A `stub` or `env` clause came after a statement in a test case; they lead the case body.",
),
dg(
"bynk.parse.const_missing_type",
"A `const` declaration has no type annotation; a constant's type is always written (`const Name: Type = …`).",
&["const_decl"],
),
dg(
"bynk.parse.consumes_after_decls",
"`consumes` appears after other declarations.",
&["consumes_decl"],
),
d(
"bynk.parse.dangling_handler_annotation",
"A handler-position annotation (e.g. `@cache`) is not followed by an `on` handler.",
),
d(
"bynk.parse.doc_block_contains_code",
"A documentation block's content (outside Markdown code fences) parses as declarations, so a pair of dash dividers has turned code into documentation.",
),
dg(
"bynk.parse.duplicate_cors",
"A service declares more than one `cors { }` policy.",
&["service_decl"],
),
dg(
"bynk.parse.duplicate_json",
"A service declares more than one `json { }` policy.",
&["service_decl"],
),
dg(
"bynk.parse.duplicate_limits",
"A service declares more than one `limits { }` policy.",
&["service_decl"],
),
dg(
"bynk.parse.duplicate_security",
"A service declares more than one `security { }` policy.",
&["service_decl"],
),
dg(
"bynk.parse.empty_agent",
"An `agent` body is empty.",
&["agent_decl"],
),
dg(
"bynk.parse.empty_capability",
"A `capability` body is empty.",
&["capability_decl"],
),
d(
"bynk.parse.empty_interpolation",
"An interpolation hole `\\(…)` contains no expression.",
),
dg(
"bynk.parse.empty_match",
"A `match` has no arms.",
&["match_expr"],
),
dg(
"bynk.parse.empty_service",
"A `service` body is empty.",
&["service_decl"],
),
d(
"bynk.parse.event_pattern_empty",
"A `from Events(E { ... })` subscription pattern listed no fields — use `from Events(E)` (no braces) for an unfiltered subscription.",
),
dg(
"bynk.parse.expected_agent_key",
"Expected a `key` declaration in an agent.",
&["agent_decl"],
),
d(
"bynk.parse.expected_agent_storage",
"An agent declares no storage — it has no `store` fields.",
),
dg(
"bynk.parse.expected_base_type",
"Expected a base type.",
&["base_type"],
),
dg(
"bynk.parse.expected_capability_op",
"Expected a capability operation.",
&["capability_op"],
),
d("bynk.parse.expected_expression", "Expected an expression."),
dg(
"bynk.parse.expected_handler",
"Expected a handler.",
&["handler"],
),
d("bynk.parse.expected_item", "Expected a declaration."),
dg(
"bynk.parse.expected_predicate",
"Expected a refinement predicate.",
&["refinement"],
),
dg(
"bynk.parse.expected_provider_op",
"Expected a provider operation.",
&["provider_op"],
),
d("bynk.parse.expected_token", "Expected a specific token."),
d("bynk.parse.expected_type", "Expected a type."),
d(
"bynk.parse.expected_unit_header",
"Expected a `commons` or `context` header.",
),
dg(
"bynk.parse.expected_visibility",
"Expected a visibility keyword.",
&["exports_decl"],
),
dg(
"bynk.parse.exports_after_decls",
"`exports` appears after other declarations.",
&["exports_decl"],
),
d(
"bynk.parse.extra_tokens",
"Unexpected tokens after an otherwise complete construct.",
),
dg(
"bynk.parse.generic_arg_count",
"Wrong number of generic type arguments.",
&["generic_type_ref"],
),
dg(
"bynk.parse.handler_in_agent",
"A protocol handler (`on GET`/`schedule`/`message`) was declared in an agent.",
&["handler"],
),
d(
"bynk.parse.invariant_after_handler",
"An `invariant` was declared after a handler; invariants precede handlers.",
),
dg(
"bynk.parse.keyword_field_shorthand",
"A reserved keyword was used as a field shorthand, which would bind a variable of that name.",
&["identifier"],
),
dg(
"bynk.parse.lambda_pattern_annotation",
"A lambda parameter with a record pattern carries a type annotation; the pattern's type name already gives the parameter's type.",
&["lambda_param"],
),
dg(
"bynk.parse.lambda_pattern_not_record",
"A lambda parameter is a pattern other than a record pattern; only an irrefutable record pattern may stand in for a name.",
&["lambda_param"],
),
dg(
"bynk.parse.lambda_pattern_refutable",
"A lambda parameter's record pattern can fail to match some value of its type, and a lambda has no `else` to fall back on.",
&["lambda_param"],
),
dg(
"bynk.parse.let_else_on_binding",
"An `else` follows a plain `let name = …` binding, which matches every value, so the `else` could never run.",
&["let_stmt", "effect_let_stmt"],
),
hint(d(
"bynk.parse.let_else_staircase",
"Nested `match`es on `Option`/`Result` that each carry on in one arm and give up in the other, which `let … else` writes flat. A hint with a machine-applicable rewrite; never fails a build and is hidden from the terminal (hint).",
)),
dg(
"bynk.parse.let_pattern_annotation",
"A `let` with a pattern carries a type annotation; the pattern's names take their types from the value.",
&["let_else_stmt"],
),
dg(
"bynk.parse.let_pattern_without_else",
"A `let` binds a pattern but has no `else` saying what the block produces when the value does not match; only a record pattern that cannot fail may omit it.",
&["let_else_stmt"],
),
dg(
"bynk.parse.list_rest_not_last",
"A `..` in a list pattern is not the final element; suffix forms such as `[.., last]` are not available.",
&["list_pattern"],
),
dg(
"bynk.parse.malformed_float_literal",
"A float literal is missing a digit on one side of the `.` (`1.`, `.5`).",
&["float_literal"],
),
dg(
"bynk.parse.match_ends_block",
"A `match` ends the block it is in, because a block has no expression statements; a second `match` straight after it cannot follow.",
&["block"],
),
d(
"bynk.parse.migrate_after_handler",
"A `migrate` step is declared after an agent handler; migration steps precede the handlers.",
),
d(
"bynk.parse.migrate_item",
"A `migrate` step's body holds something other than `field := value`, `let` or `drop field`.",
),
d(
"bynk.parse.multiple_docs",
"A declaration or member has two docs directly above it; a target has one doc, so a doc of more than one line is a `---` block.",
),
d(
"bynk.parse.nesting_too_deep",
"An expression or type nests deeper than the parser's fixed limit.",
),
d(
"bynk.parse.no_remainder_operator",
"`%` is not an operator; use `Int.rem` (the dividend's sign) or `Int.mod` (the divisor's).",
),
dg(
"bynk.parse.non_associative",
"A non-associative operator was chained (e.g. `a == b == c`).",
&["binary_expr"],
),
warn(d(
"bynk.parse.orphan_doc_block",
"A documentation block is not attached to a declaration (warning).",
)),
dg(
"bynk.parse.policy_order",
"A service's `cors`/`security`/`limits` policy is out of order or follows a handler; they open the body in the order `cors`, `security`, `limits`, `json`.",
&["service_decl"],
),
dg(
"bynk.parse.record_pattern_in_is_unparenthesised",
"A record pattern after `is` is not parenthesised — write `x is (T { f, .. })`.",
&["record_pattern"],
),
dg(
"bynk.parse.record_pattern_without_rest",
"A record pattern does not end with `..`; every record pattern is open.",
&["record_pattern"],
),
dg(
"bynk.parse.refined_pattern_inner",
"A refined pattern's inner form is something other than `_`.",
&["refined_pattern"],
),
dg(
"bynk.parse.reserved_keyword",
"A reserved keyword was used as an identifier.",
&["identifier"],
),
dg(
"bynk.parse.self_outside_method",
"`self` used outside a method or handler.",
&["self_expr"],
),
d(
"bynk.parse.storage_after_phase",
"Agent storage (`state` / `store`) is declared after the invariants or handlers.",
),
d(
"bynk.parse.transition_after_handler",
"A `transition` is declared after an agent handler; step invariants precede the handlers.",
),
d(
"bynk.parse.unexpected_adapter",
"An `adapter` appeared where it is not allowed.",
),
dg(
"bynk.parse.unexpected_context",
"A `context` appeared where it is not allowed.",
&["context_decl"],
),
d("bynk.parse.unexpected_eof", "Unexpected end of input."),
dg(
"bynk.parse.unexpected_suite",
"A `suite` appeared where it is not allowed.",
&["suite_decl"],
),
d(
"bynk.parse.unknown_effect_method",
"An unknown method on `Effect`.",
),
dg(
"bynk.parse.unknown_handler_kind",
"An unknown handler form (expected `call`, an HTTP method, `schedule`, or `message`).",
&["handler"],
),
dg(
"bynk.parse.unknown_predicate",
"An unknown refinement predicate.",
&["predicate_name"],
),
d(
"bynk.parse.unknown_tier",
"A `case`/`suite` `as <tier>` clause names something other than `unit`, `integration`, or `system`.",
),
dg(
"bynk.parse.uses_after_decls",
"`uses` appears after other declarations.",
&["uses_decl"],
),
dg(
"bynk.parse.variant_name_case",
"A sum-type or enum variant name is not capitalised.",
&["sum_variant", "enum_type"],
),
d(
"bynk.project.contracts_lock_corrupt",
"`bynk.contracts.lock` (the older service contracts a callee still accepts) is missing its version field, empty, truncated, unparseable, or of an unsupported version — restore it from version control rather than deleting it, since a callee that forgets the contracts it accepts refuses its live callers.",
),
warn(d(
"bynk.project.contracts_lock_oversized",
"`bynk.contracts.lock` has one service accepting more older contracts than the build keeps comfortably (warning).",
)),
warn(d(
"bynk.project.contracts_lock_stale",
"`bynk.contracts.lock` lists an older contract the service no longer accepts, because it is unreadable or no longer compatible with the contract the service has now; the entry is ignored (warning).",
)),
warn(d(
"bynk.project.duplicate_compatibility_flag",
"`bynk.toml`'s `[workers] compatibility_flags` lists a flag twice, or one every Bynk Worker already has; the duplicate is dropped (warning).",
)),
d(
"bynk.project.duplicate_module_doc",
"More than one file of a multi-file unit carries a module doc.",
),
d(
"bynk.project.export_context",
"`bynk.toml`'s `[package] exports` lists a context: a package shares commons and adapters, never a context, which belongs to the project that deploys it.",
),
d(
"bynk.project.export_unknown",
"`bynk.toml`'s `[package] exports` lists a name that isn't a commons or adapter the project declares.",
),
d(
"bynk.project.file_and_directory",
"A unit exists as both a file and a directory.",
),
d(
"bynk.project.inconsistent_commons_name",
"A source file's path does not match its declared name.",
),
d(
"bynk.project.kind_conflict",
"A name is declared as both a commons and a context.",
),
d(
"bynk.project.no_root",
"No project root could be determined.",
),
d(
"bynk.project.no_sources",
"The project contains no source files.",
),
d(
"bynk.project.read_failed",
"A source file could not be read.",
),
d(
"bynk.project.schema_registry_corrupt",
"`bynk.schema.lock` (the schema registry for events and agent state) is missing its version field, empty, truncated, or otherwise unparseable — restore it from version control rather than deleting it, since deleting it would silently re-baseline every event's and agent's history.",
),
warn(d(
"bynk.project.unstable_not_experimental",
"`bynk.toml`'s `[unstable] allow` lists an item that nothing experimental lies in or under: it is stable now, so the entry can go (warning).",
)),
d(
"bynk.project.unstable_unknown_item",
"`bynk.toml`'s `[unstable] allow` lists a path that names no standard-library unit, exported item or operation.",
),
dg(
"bynk.property.restates_refinement",
"A `property` merely re-checks a refinement its type already guarantees.",
&["for_all"],
),
dg(
"bynk.property.where_not_bool",
"A `for all ... where` filter does not type to `Bool`.",
&["for_all"],
),
dg(
"bynk.provider.agent_call_undeclared_capability",
"A provider calls an agent handler that needs a capability the provider's `given` does not list.",
&["provider_decl"],
),
dg(
"bynk.provider.dependency_cycle",
"Providers form a capability dependency cycle through `given`.",
&["provider_decl"],
),
dg(
"bynk.provider.extra_operation",
"A `provides` block implements an operation not in the capability.",
&["provider_decl"],
),
dg(
"bynk.provider.generic_op_requires_external",
"A Bynk-bodied `provides` implements a capability operation that declares its own type parameter — only an external (bodiless) provider can.",
&["provider_decl"],
),
dg(
"bynk.provider.missing_operation",
"A `provides` block is missing a capability operation.",
&["provider_decl"],
),
dg(
"bynk.provider.outside_context",
"`provides` was declared outside a context.",
&["provider_decl"],
),
dg(
"bynk.provider.signature_mismatch",
"A `provides` operation's signature does not match the capability.",
&["provider_decl"],
),
dg(
"bynk.provider.unknown_capability",
"`provides` names a capability that does not exist.",
&["provider_decl"],
),
d(
"bynk.query.join_key_mismatch",
"A `joinOn`/`leftJoin` left and right key function return different types.",
),
dg(
"bynk.query.sum_needs_numeric",
"A `sum`/`average` key function does not return a numeric type (`Int`, `Float`, or `Duration`).",
&[],
),
dg(
"bynk.queue.bad_params",
"An `on message` handler does not take exactly one `message` parameter.",
&["queue_handler"],
),
dg(
"bynk.queue.duplicate_consumer",
"Two `on message` handlers consume the same queue.",
&["queue_handler"],
),
dg(
"bynk.queue.invalid_name",
"A `from queue(\"…\")` binding has an empty queue name, or one Cloudflare refuses.",
&["queue_handler"],
),
dg(
"bynk.queue.return_not_queue_result",
"An `on message` handler does not return `Effect[QueueResult]`.",
&["handler"],
),
dg(
"bynk.race.in_agent_handler",
"`a.race(b)` was used in an agent handler, which has no execution context to hand the losing effect to.",
&["method_call"],
),
dg(
"bynk.race.in_pure_context",
"`a.race(b)` was used in a pure (non-effectful) context.",
&["method_call"],
),
dg(
"bynk.race.outside_handler",
"`a.race(b)` was used outside a service handler's body and outside a function (in a provider operation, a WebSocket handler or a test `case` body), where no execution context exists.",
&["method_call"],
),
dg(
"bynk.record_spread.field_type_mismatch",
"A record-spread override has the wrong type for the field.",
&["record_spread"],
),
dg(
"bynk.record_spread.non_record_base",
"The base of a record spread is not a record.",
&["record_spread"],
),
dg(
"bynk.record_spread.type_mismatch",
"A record spread's base is a different record type.",
&["record_spread"],
),
dg(
"bynk.record_spread.unknown_field",
"A record spread overrides a field the record does not have.",
&["record_spread"],
),
dg(
"bynk.refine.literal_violates",
"A literal does not satisfy the refined type's predicate.",
&["refined_type"],
),
d(
"bynk.registry.account_refused",
"`bynk login`, `bynk logout` or a `bynk org` command didn't go through: you aren't signed in or your session expired, the registry has no account API (or is read through a mirror), the sign-in was declined or its code expired, or the registry refused the request (a taken or reserved name, not the owner, an unknown member or token).",
),
d(
"bynk.registry.bad_archive",
"A registry archive is malformed or hostile: not a `bynk-tree-v1` stream, a path that is absolute or climbs out of the package, an out-of-order or repeated file, or past the size limits.",
),
d(
"bynk.registry.bad_signature",
"An index line isn't signed by a key the trusted key's rotation chain reaches, or its signed registry `id` or package `name` isn't the one asked for (a forged or replayed line).",
),
d(
"bynk.registry.http_failed",
"A registry couldn't be read: unreachable, an error status, a refused or missing token, a redirect from https to http, too many redirects, or a response past the size limit.",
),
d(
"bynk.registry.key_mismatch",
"A registry's keys don't lead from the key trusted for it (pinned in `[registries]`, or recorded in `bynk.lock`), or it now declares a different `id`.",
),
d(
"bynk.registry.nonconformant",
"`bynk registry conformance` found a registry breaking the protocol: a check failed (a wrong status, an unsigned or mis-signed line, a checksum that isn't the tree sent, a refusal without its JSON body, …); each failure names the check and the protocol section it holds the registry to.",
),
d(
"bynk.registry.publish_refused",
"`bynk publish` or `bynk yank` didn't go through: the project isn't a versioned package, it has a path or git dependency, its registry has no publish API (or is read through a mirror), or the registry refused the request (no or wrong token, an existing version, an invalid upload).",
),
d(
"bynk.registry.source_mismatch",
"`bynk.lock` locks a package to one registry, but its organisation now routes to another; a misrouted organisation fails rather than resolving a same-named package elsewhere.",
),
d(
"bynk.registry.unavailable",
"No registry serves a package: its organisation isn't listed by any `[registries]` entry (the first-party registry isn't live yet), the registry has no `config.json`, or it has no such package or archive.",
),
d(
"bynk.registry.withdrawn",
"`bynk.lock` locks a registry version that its registry withdrew (a takedown: yanked, and its archive deleted), and its tree isn't in the store.",
),
dg(
"bynk.requires.conflicting_range",
"Two adapter `binding … requires { … }` entries give different version ranges for one npm package.",
&["binding_decl"],
),
dg(
"bynk.requires.unapproved",
"A reached adapter of a git or registry dependency requires an npm package, at a range, that the project hasn't approved in `bynk.lock`; review it and run `bynk approve <package>`.",
&["binding_decl"],
),
dg(
"bynk.requires.unpinned_dependency",
"An adapter `binding … requires { … }` entry has an unpinned version range.",
&["binding_decl"],
),
d(
"bynk.resolve.ambiguous_variant",
"A variant name is ambiguous across several sum types.",
),
dg(
"bynk.resolve.arity_mismatch",
"A function was called with the wrong number of arguments.",
&["call"],
),
dg(
"bynk.resolve.bad_const_initialiser",
"A `const` initialiser is not a static value of the declared type: only literals, constructors over static values, `T.unsafe(lit)`, `List.empty()`/`Map.empty()`/`Set.empty()`, `Duration` literals and references to other constants are allowed.",
&["const_decl"],
),
dg(
"bynk.resolve.const_cycle",
"Constants refer to each other in a cycle, so none of them has a value.",
&["const_decl"],
),
dg(
"bynk.resolve.const_name_case",
"A constant's name is not upper-camel case (`MaxRetries`, not `maxRetries`).",
&["const_decl"],
),
dg(
"bynk.resolve.const_outside_context_or_commons",
"A `const` declaration appears outside a context or commons.",
&["const_decl"],
),
d("bynk.resolve.duplicate_actor", "Two actors share a name."),
dg(
"bynk.resolve.duplicate_agent",
"Two agents share a name.",
&["agent_decl"],
),
dg(
"bynk.resolve.duplicate_capability",
"Two capabilities share a name.",
&["capability_decl"],
),
dg(
"bynk.resolve.duplicate_const",
"Two constants share a name.",
&["const_decl"],
),
dg(
"bynk.resolve.duplicate_field",
"A record declares a field twice.",
&["record_type"],
),
dg(
"bynk.resolve.duplicate_field_init",
"A record construction initialises a field twice.",
&["record_construction"],
),
dg(
"bynk.resolve.duplicate_fn",
"Two functions share a name.",
&["fn_decl"],
),
d(
"bynk.resolve.duplicate_message_code",
"A message bundle declares the same code twice in one block.",
),
d(
"bynk.resolve.duplicate_message_locale",
"Two `messages` blocks in one bundle declare the same locale tag.",
),
dg(
"bynk.resolve.duplicate_method",
"Two methods share a name.",
&["fn_decl"],
),
dg(
"bynk.resolve.duplicate_param",
"A parameter name is repeated.",
&["param"],
),
dg(
"bynk.resolve.duplicate_provider",
"A capability is provided more than once.",
&["provider_decl"],
),
dg(
"bynk.resolve.duplicate_service",
"Two services share a name.",
&["service_decl"],
),
dg(
"bynk.resolve.duplicate_type",
"Two types share a name.",
&["type_decl"],
),
dg(
"bynk.resolve.duplicate_variant",
"A sum type declares a variant twice.",
&["sum_type"],
),
d(
"bynk.resolve.fn_without_call",
"A function was referenced without being called.",
),
dg(
"bynk.resolve.let_shadows_fn",
"A `let` binding shadows a function.",
&["let_stmt"],
),
dg(
"bynk.resolve.let_shadows_type",
"A `let` binding shadows a type.",
&["let_stmt"],
),
d(
"bynk.resolve.method_unknown_type",
"A method is defined on an unknown type.",
),
dg(
"bynk.resolve.missing_field",
"A record construction omits a required field.",
&["record_construction"],
),
d(
"bynk.resolve.name_conflict",
"Two declarations share a name.",
),
dg(
"bynk.resolve.not_a_record_type",
"Record syntax was used on a non-record type.",
&["record_construction"],
),
dg(
"bynk.resolve.opaque_record_construction",
"An opaque type was constructed with record syntax.",
&["record_construction"],
),
dg(
"bynk.resolve.param_as_function",
"A value (such as a parameter) was called as a function.",
&["call"],
),
dg(
"bynk.resolve.recursive_record_field",
"A record directly contains a field of its own type.",
&["record_type"],
),
dg(
"bynk.resolve.reserved_builtin_type",
"A type declaration reuses a compiler-known built-in type name.",
&["type_decl"],
),
dg(
"bynk.resolve.reserved_host_name",
"A declaration is named `globalThis`, which the generated TypeScript uses to reach host globals.",
&["type_decl", "fn_decl", "agent_decl", "provider_decl"],
),
dg(
"bynk.resolve.reserved_payload_field",
"A sum variant declares a payload field named `kind`, the variant's wire discriminant.",
&["sum_type"],
),
dg(
"bynk.resolve.self_outside_method",
"`self` referenced outside a method or handler.",
&["self_expr"],
),
dg(
"bynk.resolve.type_as_function",
"A type name was called as if it were a function.",
&["call"],
),
d(
"bynk.resolve.type_in_expr",
"A type name was used where a value is expected.",
),
dg(
"bynk.resolve.unconsumed_context",
"A context's service was called without a `consumes` declaration.",
&["consumes_decl"],
),
dg(
"bynk.resolve.unknown_field",
"Accessed a field the record does not have.",
&["field_access"],
),
dg(
"bynk.resolve.unknown_function",
"Called a function that does not exist.",
&["call"],
),
d(
"bynk.resolve.unknown_name",
"Referenced a name that is not in scope.",
),
dg(
"bynk.resolve.unknown_static_member",
"Referenced an unknown static member (e.g. `T.x`).",
&["field_access"],
),
d(
"bynk.resolve.unknown_type",
"Referenced a type that does not exist.",
),
warn(d(
"bynk.secrets.computed_name",
"A `bynk.Secrets` read names its secret with a computed expression rather than a literal, so `bynk deploy` cannot plan it (warning).",
)),
dg(
"bynk.send.in_agent_handler",
"A `~>` send was used in an agent handler, which has no execution context to keep a fire-and-forget send alive.",
&["effect_send_stmt"],
),
dg(
"bynk.send.in_pure_context",
"A `~>` send was used in a pure (non-effectful) context.",
&["effect_send_stmt"],
),
dg(
"bynk.send.non_effect",
"A `~>` send was applied to a non-`Effect` value.",
&["effect_send_stmt"],
),
dg(
"bynk.send.requires_unit",
"A `~>` send targets an operation whose reply is not `Effect[()]`.",
&["effect_send_stmt"],
),
dg(
"bynk.send.store_op",
"A `~>` send targets an agent store operation, which is part of the handler's atomic commit and cannot be sent without waiting.",
&["effect_send_stmt"],
),
dg(
"bynk.service.missing_from",
"A `from`-less service has a handler other than `on call`.",
&["service_decl"],
),
dg(
"bynk.service.mixed_protocols",
"A service mixes handler forms that do not match its `from <protocol>`.",
&["service_decl"],
),
dg(
"bynk.service.outside_context",
"A `service` was declared outside a context.",
&["service_decl"],
),
dg(
"bynk.service.return_not_effect",
"A service handler's return type is not an `Effect`.",
&["service_decl"],
),
dg(
"bynk.service.unknown_protocol",
"A `from <protocol>` names an unknown protocol (e.g. a transport like Kafka).",
&["service_decl"],
),
d(
"bynk.service.unknown_via_clause",
"A `via <name>(...)` clause on a `from Events(...)` header named something other than `schema` — `via` clauses are a closed set, and only `via schema(...)` exists today.",
),
d(
"bynk.service.websocket_header",
"The `from websocket` header is malformed — it binds frame types as `websocket(in: <type>, out: <type>)` (real-time track slice 3).",
),
d(
"bynk.service.websocket_multiple",
"A context holds more than one `from websocket` service — at v1 the Workers upgrade routes by the `Upgrade: websocket` header alone, so one WebSocket service per context (real-time track slice 3b).",
),
d(
"bynk.service.websocket_open_arity",
"A `from websocket` service must hold exactly one `on open` handler (the edge upgrade), and at most one `on message` (inbound) and one `on close` (real-time track slice 3/3b-iii).",
),
d(
"bynk.service.websocket_param_not_stringy",
"A `from websocket` service's `on open` parameter has a type not constructible from `String`; it arrives as a query-string value (#1657).",
),
d(
"bynk.stability.experimental",
"An experimental standard-library item is used without an `[unstable] allow` entry in `bynk.toml` covering it.",
),
d(
"bynk.store.annotation_kind_mismatch",
"A storage annotation is used on a kind it does not apply to (e.g. `@ttl` on a `Map`).",
),
d(
"bynk.store.annotation_unsupported",
"A known storage annotation (`@ttl`/`@retain`/`@indexed`/`@bounded`) is used before the slice that supports it.",
),
d(
"bynk.store.cache_needs_clock",
"A handler performs a `Cache` operation (TTL expiry reads the clock) without declaring `given Clock`.",
),
d(
"bynk.store.cache_ttl_required",
"A `Cache` field is missing its required `@ttl(<duration>)` annotation (a keyed store with no expiry is a `Map`).",
),
d(
"bynk.store.kind_arity",
"A storage kind was applied to the wrong number of type arguments (e.g. `Cell[A, B]`).",
),
d(
"bynk.store.kind_unsupported",
"A known storage kind (`Queue`) is used before the slice that supports it.",
),
d(
"bynk.store.log_needs_clock",
"A handler calls `Log.append` (which stamps the current time) without declaring `given Clock`.",
),
d(
"bynk.store.unkeyable_key",
"A store `Set` element or `Map`/`Cache` key is not value-keyable — it must be `String`, `Int`, or a refined/opaque type over them (#1680).",
),
d(
"bynk.store.unknown_annotation",
"A `store` field carries an annotation outside the closed `@indexed`/`@ttl`/`@retain`/`@bounded` set.",
),
d(
"bynk.store.unknown_kind",
"A `store` field's type is not a known storage kind.",
),
d(
"bynk.store.unknown_map_accessor",
"A `store Map` field access is not one of its query accessors (`entries`/`keys`/`values`).",
),
d(
"bynk.store.unknown_op",
"A storage-`Map`/`Set` operation is not a recognised entry/membership method.",
),
d(
"bynk.stub.after_type",
"A test `stub … returns <value> after <d>` latency is not a `Duration`.",
),
dg(
"bynk.stub.at_system",
"A test `stub` is in a `system`-tier case, or at the scope of a `suite … as system` (or a suite whose cases run `as system`); each context runs as the Worker it deploys as, which builds its own capability providers, so there is no seam to override.",
&["stub_clause"],
),
d(
"bynk.stub.bad_sequence",
"A `stub … returns each […]` sequence is malformed (e.g. empty).",
),
d(
"bynk.stub.generic_op",
"A test `stub` targets a capability operation that declares its own type parameter — not supported at v1.",
),
d(
"bynk.stub.not_a_seam",
"A test `stub` overrides a capability the unit under test does not consume.",
),
d(
"bynk.stub.rhs_type",
"A test `stub … returns <value>` right-hand side does not match the operation's return type.",
),
d(
"bynk.stub.unknown_op",
"A test `stub` names an operation the capability does not declare.",
),
dg(
"bynk.suite.duplicate_case_name",
"Two `case`s share a description.",
&["case"],
),
dg(
"bynk.suite.duplicate_env",
"An `env { … }` clause gives the same name twice at one scope (a suite's `env` clauses, or one case's); a case's `env` may override a suite's name, but not repeat its own.",
&["env_clause"],
),
dg(
"bynk.suite.duplicate_fn",
"A suite declares two helper `fn`s of the same name.",
&["fn_decl"],
),
dg(
"bynk.suite.env_binding_clash",
"A `system`-tier suite's or case's `env` names a binding a participant's Worker already declares (a Service Binding, KV namespace, or Durable Object namespace), or a key the test harness sets on it (a call-edge key, a `Foreign` caller's secret), so the entry would clash with it on the Worker's `env`.",
&["env_clause"],
),
dg(
"bynk.suite.env_not_literal",
"An `env { … }` entry's value is neither a `String` literal nor a `fixture` the same suite declares; a Worker's variables and secrets are strings, given verbatim.",
&["env_clause"],
),
dg(
"bynk.suite.fn_effectful",
"A suite helper `fn` returns an `Effect`; suite helpers are pure.",
&["fn_decl"],
),
dg(
"bynk.suite.fn_method",
"A suite helper `fn` is a method (`fn Type.name`); suite helpers are free functions.",
&["fn_decl"],
),
dg(
"bynk.suite.fn_name_clash",
"A suite helper `fn` has the name of a declaration already in scope in the suite's cases.",
&["fn_decl"],
),
dg(
"bynk.suite.unknown_target",
"A `suite` targets a unit that does not exist.",
&["suite_decl"],
),
d(
"bynk.target.browser_bundle_only",
"The `browser` platform builds only the in-process `Bundle` topology; `--target workers` is not a browser build.",
),
dg(
"bynk.target.vendor_conflict",
"One deployment unit's in-process closure uses platform-native capabilities from two mutually-exclusive platforms.",
&["consumes_decl"],
),
dg(
"bynk.target.vendor_required",
"A deployment unit uses a platform-native capability but the build selects another `--platform`.",
&["consumes_decl"],
),
dg(
"bynk.test.actor_identity_required",
"A test omits the identity an identity-carrying actor requires: a bare call-site `by <Actor>`, or no `by` at all on a handler that binds its `Caller`.",
&["case"],
),
dg(
"bynk.test.actor_no_identity",
"A call-site `by <Actor>(x)` supplies an identity to an actor that takes none — a unit-identity actor (e.g. `Visitor`) or `Nobody`.",
&["case"],
),
dg(
"bynk.test.advance_not_clock",
"An `advance` statement names a capability other than `Clock`; the test harness owns one time source, the first-party `Clock`.",
&["advance_stmt"],
),
dg(
"bynk.test.advance_not_duration",
"An `advance Clock by` statement's amount is not a `Duration`.",
&["advance_stmt"],
),
dg(
"bynk.test.advance_outside_case",
"An `advance Clock by` statement appears outside a test `case` body; only the test harness has a clock to move.",
&["advance_stmt"],
),
dg(
"bynk.test.asset_address_method",
"A suite fetches an asset with a method other than `GET`; the platform serves assets to `GET` and answers other methods with 405.",
&["case"],
),
dg(
"bynk.test.call_needs_in_process",
"A `system`-tier case calls an `on call` service with `svc.call(…)`; an `on call` service is internal to a deployment and has no public route for a `system` case to drive, so the case drives an `http` route that reaches it, or calls it at `unit` or `integration`.",
&["case"],
),
dg(
"bynk.test.credential_needs_system",
"A case drives `by Nobody` (the no-credential principal, which tests the auth seam's 401) outside a `system`-tier case, where there is no real seam to reject it.",
&["case"],
),
dg(
"bynk.test.event_needs_in_process",
"A `system`-tier case delivers an event with `svc.event(e)`; at `system` an event reaches a subscriber only through its publisher's fan-out, so the case drives the emitting handler instead, or delivers the event at `unit` or `integration`.",
&["case"],
),
dg(
"bynk.test.event_not_subscribed",
"A test body's `svc.event(e)` delivers an event the `from Events(E)` service does not subscribe to.",
&["case"],
),
dg(
"bynk.test.event_publisher_ambiguous",
"A test body's `svc.event(e)` omits the envelope, but the event's publisher, which the default envelope names, is not one context the target declares or consumes.",
&["case"],
),
dg(
"bynk.test.expired_needs_bearer_route",
"A case drives `by Expired` at an address that is not an http route with a `Bearer` actor (alone, or as a member of an actor sum); it sends a correctly signed token whose `exp` has passed, so only a `Bearer` seam can refuse it.",
&["case"],
),
dg(
"bynk.test.extra_headers_authorization",
"A `system` case sends `Authorization` as an extra request header to a route that declares no `headers:` parameter; the case's `by <Actor>` owns the credential the driver sends.",
&["case"],
),
dg(
"bynk.test.faults_needs_in_process",
"A `system`-tier case claims a fault with `expect <call> faults`, or a fault claim at any tier is driven `by Nobody`, `by Forged`, `by Stale` or `by Expired`; at `system` a fault reaches the case as an error response from the deployed Worker, never a throw, so the claim belongs at `unit` or `integration`.",
&["case"],
),
dg(
"bynk.test.forged_needs_signature_route",
"A case drives `by Forged` at an address that is not an http route with a `Signature` or `Bearer` actor, or `by Stale` at one with no `Signature` actor (alone, or as a member of an actor sum); they send a bad credential, so only a `Signature` or `Bearer` seam can refuse them.",
&["case"],
),
dg(
"bynk.test.forged_needs_system",
"A case drives `by Forged`, `by Stale` or `by Expired` outside a `system`-tier case; only the `system` driver signs a request or mints a token, so only there does the real `Signature` or `Bearer` seam see the bad credential.",
&["case"],
),
dg(
"bynk.test.nobody_needs_secured_route",
"A case drives `by Nobody` at a route with no Bearer or Signature actor (alone, or as a member of an actor sum) (e.g. a public `Visitor` route) — there is no auth seam to reject the missing credential.",
&["case"],
),
dg(
"bynk.test.oidc_needs_in_process",
"A `system`-tier case calls an http route whose actor is `Oidc`-secured; the `system` driver has no token issuer yet, so the request without a token could only be refused with a `401`, and the call belongs at `unit` or `integration`.",
&["case"],
),
d(
"bynk.test.principal_claims_not_oidc",
"A call-site principal passes token claims for an actor that isn't `Oidc`.",
),
dg(
"bynk.test.principal_identity_mismatch",
"A call-site `by <Actor>` acts as an actor whose identity is incompatible with the addressed handler's actor, or names no member of the handler's actor sum.",
&["case"],
),
dg(
"bynk.test.principal_on_asset",
"A suite's asset fetch carries a `by` clause; an asset is public and served before the Worker runs.",
&["case"],
),
dg(
"bynk.test.principal_on_wrong_method",
"A wrong-method `405` test carries a `by <Actor>` clause; it reaches no handler, so a principal is meaningless.",
&["case"],
),
dg(
"bynk.test.principal_required",
"A test drives an identity-carrying handler, or one guarded by an actor sum, with no call-site `by <Actor>`.",
&["case"],
),
warn(dg(
"bynk.test.remote_clock_dependent",
"Under `bynk test --against`, a `system` case's `expect` compares an `Instant` that isn't derived from the run (a constant such as `Instant.fromEpochMillis(0)`); in process the clock starts at the epoch, but a real runtime's Workers read wall-clock time.",
&["case"],
)),
dg(
"bynk.test.remote_unsupported_advance",
"A `system` case moves the harness clock with `advance Clock`, which a run against a real runtime (`bynk test --against`) can't honour: the deployed Workers read wall-clock time.",
&["case"],
),
dg(
"bynk.test.remote_unsupported_asset",
"A `system` case fetches an asset with `svc.GET(asset)`, which a run against a real runtime (`bynk test --against`) can't honour: the fetch is answered in process.",
&["case"],
),
dg(
"bynk.test.remote_unsupported_call",
"A `system` case addresses an `on call` service, which a run against a real runtime (`bynk test --against`) can't honour: the service is internal, and each call is signed for one caller.",
&["case"],
),
dg(
"bynk.test.remote_unsupported_env",
"A `system` case's `env` disagrees with the named target it would run against (`bynk test --against`): it sets a secret, sets a name the target doesn't declare under `vars` or declares with another value, or leaves unset a name the target declares.",
&["case"],
),
dg(
"bynk.test.remote_unsupported_queue",
"A `system` case delivers a queue message with `q.message(m)`, which a run against a real runtime (`bynk test --against`) can't honour: no public wire reaches a queue consumer.",
&["case"],
),
dg(
"bynk.test.remote_unsupported_schedule",
"A `system` case runs a cron handler with `svc.schedule(…)`, which a run against a real runtime (`bynk test --against`) can't honour: no public wire reaches a cron handler.",
&["case"],
),
dg(
"bynk.test.service_bad_address",
"A test body addresses a service the wrong way for its protocol (e.g. an http route without a leading path string).",
&["case"],
),
dg(
"bynk.test.service_call_arity",
"A test body's `svc.call(...)` passes the wrong number of arguments for the service's `on call` handler.",
&["case"],
),
dg(
"bynk.test.service_no_call_handler",
"A test body invokes `svc.call(...)` on a service with no `on call` handler (a `from http`/`cron`/`queue` service).",
&["case"],
),
dg(
"bynk.test.service_unknown_route",
"A test body addresses an http route / cron schedule / queue message the service does not declare.",
&["case"],
),
warn(dg(
"bynk.test.smoke_undeclared_status",
"A smoke case (`bynk test --smoke`) gets a non-5xx answer whose status is not among those its route's handler declares; the case still passes (warning).",
&["case"],
)),
dg(
"bynk.test.snapshot_duplicate_name",
"A case takes two snapshots (`expect v matches snapshot \"name\"`) under one name; a snapshot is keyed by its case and name.",
&["snapshot_expr"],
),
dg(
"bynk.test.snapshot_in_property",
"A `property` takes a snapshot; its body runs once per generated input, so the snapshot belongs in a `case` over a fixed value.",
&["snapshot_expr"],
),
dg(
"bynk.test.snapshot_name_not_literal",
"`matches snapshot` is not followed by a string literal; a snapshot is named by a literal so the compiler knows every snapshot a suite takes.",
&["snapshot_expr"],
),
dg(
"bynk.test.snapshot_needs_unit_suite",
"A snapshot is taken in a `system`-tier case or in an integration or system suite; snapshots are stored per unit suite file and compared in the unit harness.",
&["snapshot_expr"],
),
dg(
"bynk.test.snapshot_not_codable",
"The value of an `expect … matches snapshot` is not `Codable`: a snapshot stores the value's `Json.encode` text, so it must be in the domain `Json.encode` accepts.",
&["snapshot_expr"],
),
dg(
"bynk.test.stale_needs_timestamp",
"A case drives `by Stale` at a `Signature` route whose actor declares no `timestamp` header and `tolerance`, so there is no replay window for the seam to refuse a stale signature by.",
&["case"],
),
dg(
"bynk.test.unknown_actor",
"A call-site `by <Actor>` names an actor the target context does not declare and that is not a prelude actor.",
&["case"],
),
dg(
"bynk.test.wire_http_only",
"A `Wire(...)` raw argument is passed to a queue, cron, `on call` or event address; `Wire` drives an http body or path segment only, so a queue message, cron tick or event is passed as a typed value.",
&["case"],
),
dg(
"bynk.test.wire_needs_system",
"A `Wire(...)` raw argument is used outside a `system`-tier service address; `Wire` hands pre-validation input to the boundary and is meaningless at `unit` or in any other position.",
&["case"],
),
dg(
"bynk.tier.cross_context_needs_system",
"A `unit` or `integration` case, or a `property`, reaches another context's service, directly or through a target service or agent handler that calls one; below `system` no other context is stood up to call, so the flow belongs in a `suite … as system`.",
&["case"],
),
dg(
"bynk.tier.mixed_system_suite",
"A suite mixes `system` cases with `unit` or `integration` ones; a `system` case runs against deployed Workers and addresses services by context path, so it needs a `suite … as system` of its own.",
&["case"],
),
d(
"bynk.tier.system_needs_wire",
"An `as system` test stands up fewer than two contexts; the system tier wires across contexts.",
),
d(
"bynk.transition.cross_agent_reference",
"A transition predicate references another agent; step invariants are per-agent.",
),
d(
"bynk.transition.duplicate_name",
"An agent declares two transitions with the same name.",
),
d(
"bynk.transition.impure_predicate",
"A transition predicate uses an effectful or test-only construct; a step invariant must be pure.",
),
warn(d(
"bynk.transition.may_violate",
"A handler can make a move that an agent's `transition` refuses, from a state the agent can be in after a commit; at run time that call faults with `InvariantViolation` (warning). Resolve it in code: refuse the move first, with a `match` arm or an `is` test on the state field that the path can't get past.",
)),
d(
"bynk.transition.no_step_reference",
"A transition references neither `old` nor `new`; it constrains one state, so it is an `invariant`, not a step.",
),
d(
"bynk.transition.not_bool",
"A transition predicate does not have type `Bool`.",
),
dg(
"bynk.types.argument_mismatch",
"A call, method, capability, or constructor argument has the wrong type.",
&["call"],
),
d(
"bynk.types.asset_at_boundary",
"An `Asset` type appears in a record field, boundary or store position; pass its `.url` instead.",
),
d(
"bynk.types.bad_field_default",
"A record or event field's default expression (`field: T = expr`) is not a static, wire-representable value of the field's declared type — a literal (including one admitted to a refined type), a sum variant of a type this context may construct (not a `uses`-sourced commons sum, which is `bynk.context.rebrand_construction`), `Some`/`None`/`Ok`/`Err`, a record, a list literal, `Map.empty()`/`Set.empty()`, or `T.unsafe(lit)` for an opaque type whose literal also satisfies the refinement. A field whose type is a generic record's type parameter, or applies a user generic, has no default. (Earlier versions reported this as `bynk.event.bad_field_default`.)",
),
dg(
"bynk.types.call_arity",
"A function value was applied with the wrong number of arguments.",
&["call"],
),
dg(
"bynk.types.cannot_infer_option_type_param",
"The value type of `None` could not be inferred.",
&["none_expr"],
),
d(
"bynk.types.cannot_infer_result_type_params",
"The type parameters of a `Result` could not be inferred.",
),
dg(
"bynk.types.catastrophic_regex",
"A `Matches` pattern, or a regex method's pattern, can match the same text in exponentially many ways (nested or ambiguous repetition, bounded or not), or cannot be analysed, risking catastrophic backtracking (ReDoS).",
&["refinement"],
),
d(
"bynk.types.claims_at_boundary",
"`TokenClaims` appears where a value is stored or sent: a field of a type, or a boundary such as a call, a message or an agent.",
),
dg(
"bynk.types.combinator_return_mismatch",
"A callback passed to a combinator (`map`/`andThen`/`flatMap`/`traverseAll`/…) returns the wrong type.",
&["call"],
),
d(
"bynk.types.constructor_arity",
"A variant constructor got the wrong number of arguments.",
),
d(
"bynk.types.constructor_base_mismatch",
"A `.of` constructor was given an argument of the wrong base type.",
),
d(
"bynk.types.decimal_division_unscaled",
"`/` was used on `Decimal` operands. A quotient has no exact decimal answer, so division states its scale and rounding mode: `a.div(b, 2, RoundingMode.HalfEven)` (#2622).",
),
d(
"bynk.types.decimal_negation_too_large",
"A negated decimal literal would have more than 1000 characters of canonical text once its sign is counted, the most any `Decimal` may have (#2622).",
),
dg(
"bynk.types.derives_automatic",
"A `derives` clause names `Eq`, `Key` or `Codable`, which hold for a type automatically; only `Ord` is opted into. The diagnostic carries a machine-applicable fix that removes the name (constrained-generics slice 1).",
&["type_decl"],
),
dg(
"bynk.types.derives_field_not_orderable",
"A type declares `derives Ord`, but one of its fields or payloads is not `Ord` (for example a `Map`, a `Set`, a `Bool`, a function, or a record that does not itself derive `Ord`); every part must be orderable for the declaration order to be a total order (constrained-generics slice 1).",
&["type_decl"],
),
dg(
"bynk.types.duplicate_literal_arm",
"A `match` has two arms for the same literal value.",
&["match_arm"],
),
dg(
"bynk.types.duplicate_pattern_field",
"A record pattern lists the same field twice.",
&["record_pattern"],
),
dg(
"bynk.types.duplicate_variant_arm",
"A `match` has two arms for the same variant.",
&["match_arm"],
),
d(
"bynk.types.embeds_ambiguous",
"A type is embedded by more than one variant of a sum, so `?`'s conversion would be ambiguous.",
),
d(
"bynk.types.embeds_unknown_variant",
"An `embeds … as V` clause names a variant the sum does not declare.",
),
d(
"bynk.types.embeds_variant_shape",
"An `embeds E as V` target variant must have exactly one payload field, of type `E`.",
),
dg(
"bynk.types.empty_range_pattern",
"A range pattern or `via schema(...)` range has its bounds inverted (`lo > hi`), so it can never match.",
&["int_range"],
),
dg(
"bynk.types.empty_refinement",
"A refinement admits no values (contradictory predicates).",
&["refinement"],
),
dg(
"bynk.types.err_value_mismatch",
"An `Err` payload has the wrong type.",
&["err_expr"],
),
d(
"bynk.types.extensible_match_needs_wildcard",
"A `match` covers an extensible standard-library enum (`FetchError`, `Method`) without a wildcard; it may gain variants in a minor release.",
),
dg(
"bynk.types.field_access_on_non_record",
"Field access on a value that is not a record.",
&["field_access"],
),
d(
"bynk.types.field_default_on_variant",
"A sum variant's payload field declares a default (`field: T = expr`). Only a record's fields may; a variant is built like a call, with every payload field given.",
),
dg(
"bynk.types.field_refinement_not_base",
"An inline field refinement requires a base or refined type.",
&["record_field"],
),
dg(
"bynk.types.field_value_mismatch",
"A record field was given a value of the wrong type.",
&["record_construction"],
),
dg(
"bynk.types.function_at_boundary",
"A function type appeared in a serialisable or boundary position (a record field, sum payload, service/agent handler signature, capability operation signature, agent state field, or agent key); functions cannot serialise or cross a boundary.",
&["function_type_ref"],
),
dg(
"bynk.types.guard_not_bool",
"A match-arm `if` guard is not a `Bool` expression.",
&["match_arm"],
),
d(
"bynk.types.headers_at_boundary",
"`RequestHeaders` appears where a value is stored or sent: a field of a type, or a boundary such as a call, a message or an agent.",
),
d(
"bynk.types.held_at_boundary",
"A held value (`Connection[F]`) appears in a serialisable or boundary position — a held resource is built and disposed in place, never persisted or sent across a boundary (§2.9, real-time track slice 2).",
),
d(
"bynk.types.held_not_comparable",
"A held value (`Connection[F]`) is compared with `==`/`!=` — held values have identity, not value-equality (§2.9.3, real-time track slice 2).",
),
dg(
"bynk.types.if_branch_mismatch",
"The branches of an `if` have different types.",
&["if_expr"],
),
dg(
"bynk.types.if_non_bool_cond",
"An `if` condition is not a `Bool`.",
&["if_expr"],
),
dg(
"bynk.types.if_without_else_requires_unit",
"An `if` with no `else` branch has a non-unit then-branch; the missing else defaults to `()`, so the branch must be `()` or `Effect[()]`.",
&["if_expr"],
),
d(
"bynk.types.interpolation_non_scalar",
"An interpolation hole holds a value with no string form.",
),
dg(
"bynk.types.invalid_regex",
"A `Matches` predicate, or a regex method's pattern (`containsRegex`, …), contains an invalid regular expression or malformed inline flags.",
&["refinement"],
),
dg(
"bynk.types.inverted_range",
"An `InRange` predicate has its bounds inverted.",
&["refinement"],
),
dg(
"bynk.types.is_base_mismatch",
"An `is` refinement check is applied to a value of the wrong base type.",
&["is_expr"],
),
dg(
"bynk.types.is_literal_pattern",
"A literal was used on the right of `is`; `is` tests type/refinement, not value equality (use `==`).",
&["is_expr"],
),
dg(
"bynk.types.is_non_sum",
"`is` was applied to a value that is not a sum type.",
&["is_expr"],
),
dg(
"bynk.types.is_range_pattern",
"A range pattern was used directly on the right of `is`; `is` tests type/refinement, not value ranges (use `match`, a guard or `InRange`).",
&["is_expr"],
),
dg(
"bynk.types.is_refined_pattern",
"A refined (`where`) pattern was used on the right of `is`; refined patterns are `match`-only.",
&["is_expr"],
),
dg(
"bynk.types.is_unknown_variant",
"`is` names a variant the type does not have.",
&["is_expr"],
),
dg(
"bynk.types.json_uncodable",
"A `Json.encode`/`Json.decode` target type cannot pass through the typed JSON codec (functions, effects, streams or a type that carries one, `bynk.crypto` keys, error builtins).",
&["method_call"],
),
d(
"bynk.types.key_at_boundary",
"A `bynk.crypto` `SigningKey` or `VerifyKey` appears in a storable or boundary-crossing position — a key is held non-extractable and lives for the call that imported it, never persisted, logged or sent (standard-library K4).",
),
dg(
"bynk.types.key_not_orderable",
"A `sortBy`/`sortByDescending`/`min`/`max` key function does not return an orderable type. The key must be an `Ord` type, on a `List` and on a storage `Query` alike.",
&[],
),
dg(
"bynk.types.lambda_mismatch",
"A lambda's parameter count, parameter annotations, or body type do not match the expected function type.",
&["lambda_expr"],
),
dg(
"bynk.types.let_annotation_mismatch",
"A `let` value does not match its type annotation.",
&["let_stmt"],
),
dg(
"bynk.types.list_element_mismatch",
"A list-literal element has a different type from the list's element type.",
&["list_literal"],
),
dg(
"bynk.types.list_pattern_on_non_list",
"A list pattern is matched against a value that is not a `List` (a record, sum, base type, `Set` or `Map`).",
&["list_pattern"],
),
dg(
"bynk.types.match_arm_mismatch",
"A `match` arm has a different type from the others.",
&["match_arm"],
),
dg(
"bynk.types.match_non_sum_discriminant",
"`match` was applied to a value that is not a sum type.",
&["match_expr"],
),
dg(
"bynk.types.method_arity",
"A method was called with the wrong number of arguments.",
&["method_call"],
),
dg(
"bynk.types.method_not_found",
"Called a method the type does not have.",
&["method_call"],
),
dg(
"bynk.types.method_on_non_named_type",
"A method was called on a built-in type that has no methods.",
&["method_call"],
),
dg(
"bynk.types.mixed_pattern_bindings",
"A pattern mixes named and positional bindings.",
&["variant_pattern"],
),
dg(
"bynk.types.negative_length",
"A length predicate was given a negative value.",
&["refinement"],
),
dg(
"bynk.types.never_inferred",
"An unannotated `let` or `<-` binding has a type that is, or contains, the bottom type (`never returns`) because its value only faults (a faulting lambda bound this way included); the type cannot be written in source, so an annotation is needed.",
&["let_stmt"],
),
dg(
"bynk.types.no_numeric_coercion",
"`Int`, `Float` and `Decimal` were mixed without an explicit conversion — in an operation, a comparison or refinement bounds.",
&["binary_expr", "refinement"],
),
dg(
"bynk.types.non_exhaustive_match",
"A `match` does not cover every value.",
&["match_expr"],
),
d(
"bynk.types.not_codable",
"A type is instantiated at a `Codable`-bounded parameter (of a generic function, or of a capability operation) but is outside the domain `Json.decode` accepts: top-level `()`, a function, `Effect`, `Query`, a `Stream` or a type that carries one, a connection, the HTTP and queue result types, `Asset`, request headers, token claims, or an actor (constrained-generics slice 3).",
),
d(
"bynk.types.not_comparable",
"A value compared with `==`/`!=` contains a function, `Effect`, or `Query` somewhere inside it — those have no value equality, so the type is not equality-supporting (type-system §2.3.5, #1652).",
),
dg(
"bynk.types.not_keyable",
"A `Map` key, `Set` element, or `distinct`/`distinctBy`/`groupBy`/join key, or an argument to a `Key`-bounded parameter, is not `Key`. `String`, `Int`, `Bool`, `Instant`, `Duration`, `Bytes`, `Option`/`List` of a key type, refined and opaque types over them, and records, sums and enums made only of key types are; a `Float` is never one, at any depth, because `NaN` is not equal to itself (constrained-generics slice 2).",
&["generic_type_ref"],
),
d(
"bynk.types.not_orderable",
"A value is ordered (`<`, `<=`, `>`, `>=`), or passed to an `Ord`-bounded parameter, but its type is not `Ord`. `Int`, `Float`, `String`, `Duration`, `Instant`, `Bytes`, `Option`/`List` of an orderable type, refined types over those, and types that declare `derives Ord` are; adding `derives Ord` is offered as a fix that is never applied automatically, because it makes declaration order significant (constrained-generics slice 1).",
),
dg(
"bynk.types.ok_value_mismatch",
"An `Ok` payload has the wrong type.",
&["ok_expr"],
),
dg(
"bynk.types.opaque_raw_outside",
"`.raw` on an opaque type was used outside its defining commons.",
&["field_access"],
),
dg(
"bynk.types.opaque_unsafe_outside",
"`.unsafe` on an opaque type was used outside its defining context.",
&["field_access"],
),
dg(
"bynk.types.or_pattern_binding_mismatch",
"An or-pattern's alternatives don't all bind the same set of names.",
&["match_arm", "is_expr"],
),
dg(
"bynk.types.or_pattern_type_mismatch",
"An or-pattern's alternatives give a shared binding different types (or refinements).",
&["match_arm", "is_expr"],
),
dg(
"bynk.types.pattern_arity",
"A pattern binds the wrong number of payload fields.",
&["variant_pattern"],
),
dg(
"bynk.types.pattern_type_mismatch",
"A pattern's type does not match the matched value.",
&["variant_pattern"],
),
dg(
"bynk.types.polynomial_regex",
"A `Matches` pattern can split the same text between repetitions, so matching time grows polynomially with input length, and no length predicate bounds the input small enough for its degree; a regex method's pattern has no bound to excuse it.",
&["refinement"],
),
warn(dg(
"bynk.types.polynomial_regex_capped",
"A `Matches` pattern's matching time grows polynomially with input length, but a `MaxLength` or `Length` predicate bounds the input small enough for its degree (warning).",
&["refinement"],
)),
dg(
"bynk.types.predicate_base_mismatch",
"A predicate does not apply to the type's base (e.g. a string predicate on an `Int`).",
&["refinement"],
),
d(
"bynk.types.query_at_boundary",
"A `Query` type appears in a storable or boundary-crossing position — a query is built and executed in place, never persisted or sent (ADR 0115).",
),
dg(
"bynk.types.question_error_mismatch",
"`?` propagates an error type incompatible with the function's.",
&["question_expr"],
),
dg(
"bynk.types.question_on_non_result",
"`?` was applied to a non-`Result` value.",
&["question_expr"],
),
dg(
"bynk.types.question_option_outside_http",
"`?` lifts an `Option` only inside a handler returning `HttpResult` (`None` becomes `NotFound`); elsewhere use `.okOr(err)`.",
&["question_expr"],
),
dg(
"bynk.types.question_outside_result",
"`?` used in a function that does not return a `Result`.",
&["question_expr"],
),
dg(
"bynk.types.range_pattern_on_non_int",
"A range pattern (`lo..hi`) was matched against a scrutinee that is not an `Int`.",
&["int_range"],
),
dg(
"bynk.types.record_pattern_on_non_record",
"A record pattern names a type that is not a record (a sum, enum, refined or opaque type, or a built-in).",
&["record_pattern"],
),
dg(
"bynk.types.regex_not_literal",
"A regex method's pattern (`matchesRegex`, `containsRegex`, `findRegex`, `findAllRegex`, `replaceRegex`, `splitRegex`) is not a string literal, so its ReDoS check cannot run at compile time.",
&["method_call"],
),
d(
"bynk.types.rejection_at_boundary",
"`BoundaryRejection` appears where a value is stored or sent: a field of a type, or a boundary such as a call, a message or an agent.",
),
d(
"bynk.types.request_query_at_boundary",
"`RequestQuery` appears where a value is stored or sent: a field of a type, or a boundary such as a call, a message or an agent.",
),
d(
"bynk.types.return_mismatch",
"A returned value does not match the declared return type.",
),
d(
"bynk.types.rounding_mode_position",
"`RoundingMode.<mode>` was used outside the mode argument of a `Decimal`'s `round` or `div`. A mode is read where the rounding happens and is not a first-class value (#2622).",
),
dg(
"bynk.types.select_tail_has_select",
"A `D1` `select[T]` or `firstAs[T]` statement begins with `SELECT`; the compiler writes the `SELECT` and column list from `T`, so the literal starts at `FROM`.",
&["method_call"],
),
dg(
"bynk.types.sequence_needs_result",
"`sequenceAll`/`sequenceTry` was called on a list whose elements are not `Result`s. They collect a `List[Result[T, E]]`.",
&["method_call"],
),
dg(
"bynk.types.some_value_mismatch",
"A `Some` payload has the wrong type.",
&["some_expr"],
),
dg(
"bynk.types.sql_not_literal",
"A `D1` statement's SQL (the first argument of `all`, `first`, `run`, `select` or `firstAs`, or a `SqlStatement`'s `sql`) is not a string literal, so data could be spliced into it instead of bound as a `SqlValue` parameter (standard-library P4c).",
&["method_call", "record_construction", "record_spread"],
),
dg(
"bynk.types.sql_row_shape",
"`Json.decodeSql[T]`'s (or `select[T]`'s, `firstAs[T]`'s) `T` is not a SQL row: a record whose fields are `Int`, `Float`, `String`, `Bool` or `Bytes` (or a refined or opaque type over one, or an `Option` of either), or a `List` of such records (standard-library P4c).",
&["method_call"],
),
d(
"bynk.types.sql_statement_at_boundary",
"A `bynk.cloudflare` `SqlStatement` appears in a storable or boundary-crossing position, or as a `Json` codec target — a statement from outside would carry SQL that was never a literal (standard-library P4c).",
),
d(
"bynk.types.stream_at_boundary",
"A `Stream` type, or a record or sum carrying one in a field, appears in a storable or boundary-crossing position — a stream is a live value-over-time source, never persisted or sent across a boundary (real-time track slice 0; #2623 admits it in capability signatures and record fields).",
),
d(
"bynk.types.stream_not_comparable",
"A `Stream` value is compared with `==`/`!=` — a stream is a live value-over-time source, not a comparable value (real-time track slice 0).",
),
d(
"bynk.types.type_mismatch",
"Two types that were required to match did not.",
),
dg(
"bynk.types.uninferable_element_type",
"An empty `[]` (or `List.empty()` / `Map.empty()`) has no expected type to infer its element type from.",
&["list_literal"],
),
dg(
"bynk.types.unknown_field",
"Referenced a field the record type does not declare.",
&["field_access"],
),
dg(
"bynk.types.unknown_pattern_field",
"A pattern names a field the variant does not have.",
&["variant_pattern"],
),
d(
"bynk.types.unknown_rounding_mode",
"A `Decimal` `round` or `div` was not given a rounding mode written `RoundingMode.<mode>`; the modes are `Down`, `Up`, `Floor`, `Ceiling`, `HalfUp`, `HalfDown` and `HalfEven` (#2622).",
),
dg(
"bynk.types.unknown_static_member",
"Referenced an unknown static member on a type.",
&["field_access"],
),
dg(
"bynk.types.unknown_variant_in_pattern",
"A pattern names a variant the sum type does not have.",
&["variant_pattern"],
),
dg(
"bynk.types.unreachable_arm",
"A `match` arm is unreachable.",
&["match_arm"],
),
d(
"bynk.types.variant_arity",
"A variant constructor got the wrong number of payload values.",
),
d(
"bynk.types.variant_missing_payload",
"A variant requiring a payload was used without one.",
),
d(
"bynk.types.variant_payload_mismatch",
"A variant payload has the wrong type.",
),
dg(
"bynk.uses.name_conflict",
"A `uses` name collides with another name, a value crosses between a unit's code and an imported declaration's position whose type the unit shadows, or a reference names an import the unit's own declaration shadows.",
&["uses_decl"],
),
dg(
"bynk.uses.self_reference",
"A commons `uses` itself.",
&["uses_decl"],
),
dg(
"bynk.uses.target_is_context",
"`uses` targets a context instead of a commons.",
&["uses_decl"],
),
dg(
"bynk.uses.unknown_commons",
"`uses` names a commons that does not exist.",
&["uses_decl"],
),
dg(
"bynk.val.agent_not_generable",
"A `for all`/`Val` cannot generate an agent — fabricated agent states need not be reachable.",
&["for_all"],
),
dg(
"bynk.val.arity",
"`Val[T]` was given the wrong number of pin arguments.",
&["val_expr"],
),
dg(
"bynk.val.literal_violates",
"A pinned `Val[T]` value violates the type's refinement.",
&["val_expr"],
),
dg(
"bynk.val.needs_pin",
"A bare `Val[T]` cannot generate a value (e.g. a `Matches` string); pin one.",
&["val_expr"],
),
dg(
"bynk.val.outside_test",
"`Val[T]` was used outside a test case body.",
&["val_expr"],
),
dg(
"bynk.val.pin_not_literal",
"A `Val[T]` pin argument is not a compile-time literal.",
&["val_expr"],
),
dg(
"bynk.val.pin_unsupported",
"A pin was given for a type kind that does not support pinning.",
&["val_expr"],
),
dg(
"bynk.val.unknown_type",
"`Val[T]` names a type that does not resolve.",
&["val_expr"],
),
dg(
"bynk.val.unsupported_kind",
"`Val[T]` cannot fabricate a value for this kind of type.",
&["val_expr"],
),
dg(
"bynk.visibility.private_in_public",
"A public declaration's signature names a `private` type of its own unit, which an importer could neither name nor build.",
&["visibility_modifier"],
),
dg(
"bynk.visibility.private_item",
"A reference from another unit names a `private` declaration, which is visible only within its own unit and that unit's suites.",
&["visibility_modifier"],
),
warn(dg(
"bynk.visibility.private_messages",
"A `messages` block in a commons is `private`. A bundle whose `@reference` block is private is never negotiated by a context that uses the commons, and `private` on another block of a bundle whose reference is public has no effect (warning).",
&["visibility_modifier"],
)),
dg(
"bynk.visibility.private_not_allowed",
"`private` modifies a declaration it does not apply to: anything but a `fn`, `type`, `messages`, `asset`, `embed` or `const` in a commons or context.",
&["visibility_modifier"],
),
d(
"bynk.wasm.panic",
"The in-browser compiler panicked internally (a compiler bug, reported as a diagnostic instead of crashing the page).",
),
d(
"bynk.wasm.strip_failed",
"The in-browser compiler could not strip the emitted TypeScript to JavaScript.",
),
dg(
"bynk.within.in_agent_handler",
"`e.within(d)` was used in an agent handler, which has no execution context to hand the abandoned effect to.",
&["method_call"],
),
dg(
"bynk.within.in_pure_context",
"`e.within(d)` was used in a pure (non-effectful) context.",
&["method_call"],
),
dg(
"bynk.within.outside_handler",
"`e.within(d)` was used outside a service handler's body and outside a function (in a provider operation, a WebSocket handler or a test `case` body), where no execution context exists.",
&["method_call"],
),
dg(
"bynk.within.timed_out_not_in_scope",
"`e.within(d)` yields `Result[_, TimedOut]`, but the unit does not consume `bynk`, so `TimedOut` is not in scope.",
&["method_call"],
),
d(
"bynk.ws.message_frame_param",
"A WebSocket `on message` handler does not have exactly one parameter of the service's inbound (`in:`) frame type — the decoded frame (real-time track slice 3b-iii).",
),
d(
"bynk.ws.open_given_unsupported",
"A WebSocket `on open` handler declares `given` capabilities — unsupported at v1, since on Workers the handler runs inside the connection-hosting Durable Object, which has no composition root to supply them (real-time track slice 3b).",
),
d(
"bynk.ws.open_transfer_cross_file",
"On the Workers target, a WebSocket `on open` handler transfers its `connection` to an agent declared in a different file of the same context — the open is hosted in the agent's Durable Object, which is emitted from the agent's own file, so the upgrade would never be handled; the service and the agent must share a file.",
),
d(
"bynk.ws.open_transfer_key",
"On the Workers target, the key of a WebSocket `on open` handler's connection transfer is not a route parameter, a constant of the context or of a commons it uses, or a literal — the upgrade is routed to the hosting Durable Object before the body runs, so the edge must be able to evaluate the key on its own.",
),
d(
"bynk.ws.open_transfer_shape",
"A WebSocket `on open` handler does not transfer its `connection` into exactly one agent, so the Workers upgrade has no single Durable Object to route to (real-time track slice 3b).",
),
d(
"bynk.ws.route_param_mismatch",
"A WebSocket `on message`/`on close` route parameter does not match the `on open` parameter at the same position — route values are recovered positionally from the connection, so they must be a type-compatible prefix of the `on open` parameters (real-time track slice 3b-iii).",
),
];
/// A diagnostic with no single governing grammar construct. `Error` severity.
const fn d(code: &'static str, summary: &'static str) -> DiagnosticInfo {
DiagnosticInfo {
code,
summary,
grammar_symbol: &[],
severity: Severity::Error,
}
}
/// A diagnostic that constrains one or more grammar productions. `Error` severity.
const fn dg(
code: &'static str,
summary: &'static str,
grammar_symbol: &'static [&'static str],
) -> DiagnosticInfo {
DiagnosticInfo {
code,
summary,
grammar_symbol,
severity: Severity::Error,
}
}
/// Downgrades a [`d`]/[`dg`]-built entry to `Warning` severity (ADR 0117) —
/// non-failing, surfaced alongside a clean build. Its call sites here are
/// the single source of truth [`crate::error::Severity::for_error`] reads.
const fn warn(mut info: DiagnosticInfo) -> DiagnosticInfo {
info.severity = Severity::Warning;
info
}
/// Downgrades a [`d`]/[`dg`]-built entry to `Hint` severity (#2838) — a
/// non-failing suggestion shown by the editor but not by the terminal.
const fn hint(mut info: DiagnosticInfo) -> DiagnosticInfo {
info.severity = Severity::Hint;
info
}
/// The category segment of a code (the part between the first two dots), e.g.
/// `"types"` for `"bynk.types.type_mismatch"`.
pub fn category(code: &str) -> &str {
code.split('.').nth(1).unwrap_or("")
}
/// A human-readable heading for a category segment.
fn category_title(cat: &str) -> &'static str {
match cat {
"agent" | "agents" => "Agents",
"asset" => "Static assets",
"boundary" => "Boundaries",
"capability" => "Capabilities",
"cloudflare" => "Cloudflare",
"consumes" => "Consumes",
"context" => "Contexts",
"contract" => "Contracts",
"cron" => "Cron",
"doc" => "Doc comments",
"effect" => "Effects",
"embed" => "Embedded text",
"expect" => "Expectations",
"exports" => "Exports",
"given" => "Given capabilities",
"http" => "HTTP",
"lex" => "Lexer",
"messages" => "Message bundles",
"mock" => "Mocks (collaborators)",
"observe" => "Observation",
"parse" => "Parser",
"project" => "Project",
"property" => "Properties (generative tests)",
"provider" => "Providers",
"queue" => "Queue",
"record_spread" => "Record spread",
"refine" => "Refinement",
"resolve" => "Resolution",
"service" => "Services",
"stability" => "Stability",
"suite" => "Suites and cases",
"transition" => "Transitions (step invariants)",
"types" => "Type checking",
"uses" => "Uses",
"val" => "Value fabrication",
_ => "Other",
}
}
/// Render the diagnostic index as a Markdown reference page, grouped by
/// category. This is the generator behind
/// `site/src/content/docs/book/reference/diagnostics.md`.
pub fn render_markdown() -> String {
use std::collections::BTreeMap;
// Group codes by their category title, preserving sorted code order.
let mut by_category: BTreeMap<&str, Vec<&DiagnosticInfo>> = BTreeMap::new();
for info in REGISTRY {
by_category
.entry(category_title(category(info.code)))
.or_default()
.push(info);
}
let mut out = String::new();
out.push_str("# Diagnostic index\n\n");
out.push_str(
"<!-- GENERATED FILE — do not edit by hand.\n \
Source: bynkc/src/diagnostics.rs (`render_markdown`).\n \
Regenerate with: BYNK_BLESS=1 cargo test -p xtask --test docs_consistency diagnostics_registry:: -->\n\n",
);
out.push_str(
"Every diagnostic code the compiler can emit, with a one-line summary of \
the cause, grouped by category. For step-by-step cause-and-fix guidance \
on the most common ones, see the [troubleshooting guides](../troubleshooting/index.md). \
For a code with a curated explanation, `bynk explain <code>` prints it in a \
terminal, and in VS Code the diagnostic's **Explain** quick fix (or \
**Bynk: Explain Diagnostic Code…**) shows the same text in a panel, offline.\n\n",
);
out.push_str(&format!(
"There are **{}** codes in total.\n",
REGISTRY.len()
));
for (title, infos) in &by_category {
out.push_str(&format!("\n## {title}\n\n"));
out.push_str("| Code | Summary | Construct | Severity |\n|---|---|---|---|\n");
for info in infos {
// The construct column deep-links each governing production to its
// entry in the annotated grammar reference; generated from
// `grammar_symbol` (each value is an embeddable rule, so the
// `#rule-<raw>` anchor resolves — enforced in diagnostics_registry).
let construct = info
.grammar_symbol
.iter()
.map(|sym| format!("[`{sym}`](grammar.md#rule-{sym})"))
.collect::<Vec<_>>()
.join(", ");
// A curated (`bynk explain`-able) code links to its Book concept
// page; the in-site link is validated by the site's link checker,
// so a moved page or renamed anchor fails the build (#853). Codes
// without an explanation render as plain inline code.
let code_cell = match explain(info.code) {
Some(e) => format!("[`{}`]({})", info.code, e.in_site_link()),
None => format!("`{}`", info.code),
};
// ADR 0117/finding #50: every code's severity, straight from the
// registry — `Error` (the overwhelming majority) renders as "—"
// to keep the common case unobtrusive; only a `warn`-built entry
// shows "Warning".
let severity = match info.severity {
Severity::Error => "—",
Severity::Warning => "Warning",
Severity::Hint => "Hint",
};
out.push_str(&format!(
"| {} | {} | {} | {} |\n",
code_cell, info.summary, construct, severity
));
}
}
out
}
/// Invert the registry into a `{ "<rule>": [ { code, summary }, … ], … }` map,
/// serialised as pretty JSON with sorted keys and sorted codes. Only rules with
/// at least one diagnostic appear. This is the generator behind
/// `docs/grammar-semantics.json`, which the `{{#grammar-semantics <rule>}}`
/// preprocessor directive consumes.
pub fn render_grammar_semantics_json() -> String {
use std::collections::BTreeMap;
// REGISTRY is sorted by code, so each rule's vector comes out code-sorted;
// the BTreeMap gives sorted rule names.
let mut by_symbol: BTreeMap<&str, Vec<&DiagnosticInfo>> = BTreeMap::new();
for info in REGISTRY {
for sym in info.grammar_symbol {
by_symbol.entry(sym).or_default().push(info);
}
}
let mut map = serde_json::Map::new();
map.insert(
"_generated".to_string(),
serde_json::Value::String(
"Generated from the grammar_symbol field of bynkc/src/diagnostics.rs. \
Do not edit by hand. Regenerate with: BYNK_BLESS=1 cargo test -p \
xtask --test docs_consistency diagnostics_registry::"
.to_string(),
),
);
for (sym, infos) in by_symbol {
let arr: Vec<serde_json::Value> = infos
.iter()
.map(|info| serde_json::json!({ "code": info.code, "summary": info.summary }))
.collect();
map.insert(sym.to_string(), serde_json::Value::Array(arr));
}
let mut s =
serde_json::to_string_pretty(&serde_json::Value::Object(map)).expect("serialise semantics");
s.push('\n');
s
}