Check findings
Every code that archboard check reports, what it means, and whether it fails the check. Link to a code with its anchor, such as #relationship-undrawn.
On this page
archboard check exits 1 while a semantic diagnostic or a warning remains. Information
and skips print, and they never change the exit status. Each finding names its subject, and a
code finding names the evidence that it rests on, with its file and line.
Semantics check #
The semantics check reads the model against the vault's vocabulary. An error or a warning is a diagnostic, and each diagnostic fails the check.
CONTAINER_PASS_THROUGH
Warning, fails
In a model that binds code, a module with parts and no binding, which no relationship or flow names, and whose parts no relationship or flow joins. Bind it to the code it owns, or author the relationship or flow that gives it a job. If it has neither, move its parts to its parent and remove it. A configured group gathers parts without a container.
CONTAINER_UNBOUND
Warning, fails
In a model that binds code, a module with bound parts and no binding, so the code of its folder that no part binds belongs to no module. suggestedBinding names the one directory that holds every part and no other module's code, when one does. Bind the module there with an edit-module change that sets binding. If no directory holds every part, the parts are spread. Move a part that does another module's job, or tell the user that the code layout splits one job over several folders.
CONTAINER_PARTS_OUTSIDE
Warning, fails
A bound module with a part bound outside its binding. suggestedBinding names the directory that holds them all, when one does. If the module owns that directory, bind the module there with an edit-module change that sets binding. If no directory holds every part, the parts are spread. Move a part that does another module's job, or tell the user that the code layout splits one job over several folders.
ROOT_UNCONNECTED
Warning, fails
In a model with several roots, a root with no relationship to another root. A relationship of a part inside it counts. Author the relationship that the code establishes, or move the module into the module that uses it.
RELATIONSHIP_REPEATED
Warning, fails
A relationship with the same source, target and anchor as an earlier one. Keep the one whose kind and label say what the anchored code does, and remove the other.
CONTAINER_LINE_TO_OWN_PART
Warning, fails
A relationship between a module and a part that it holds, at any depth. The nesting already shows it. So a reading that opens the module draws no line for it, and the panel still lists it. Start or end it at the part that makes or answers the call.
FLOW_SUMMARY_MISSING
Error, fails
A flow with no summary. A write that touches the flow refuses. Read its code, then set the summary through model edit with an edit-flow change.
RELATIONSHIP_ON_CONTAINER
Error, fails
A relationship with an end on a module with parts, and neither end holds the other. A module cannot point at anything, so end it on the part that owns the code. If no part owns it, add one for what the module does at this seam.
Code check #
The code check reads the code and infrastructure that bindings and anchors name. A warning fails the check. Information never does.
ANCHOR_PATH_MISSING
ANCHOR_SYMBOL_MISSING
Warning, fails
An anchor whose file is not in its checkout, or does not hold its symbol. Cite the file or symbol that proves it now. If the code is gone, remove the anchor or change the model to what the code does.
BINDING_PATH_MISSING
BINDING_SYMBOL_MISSING
Warning, fails
A bound path that is not in its checkout, or a bound symbol that the bound file or directory does not define. For a missing path, correct the binding or create the source before you accept the state. For a missing symbol, bind the part to the definition it stands for now. To bind the whole file or directory, leave out the symbol.
ANCHOR_MISMATCH
Warning, fails
An anchor whose symbol is outside the bound code of both ends, or that the file uses only as evidence that the relationship's kind does not accept. Cite a symbol or use in the code of an end that proves the relationship. Bind the part whose code holds that definition. Or change the relationship or its kind to what the code does.
RELATIONSHIP_UNDRAWN
Warning, fails
A bound part whose code other bound parts call or construct, with no relationship between them. Evidence that only matches by name makes it information. So does a relationship between the two sides where they meet: the children of their nearest holder. Add the relationship between the parts that make and answer the call. If the call reaches code that no part of the module binds, add a part bound to that code and end the relationship on the part. If the dependency is unintended, change the code.
ENTRY_POINT_UNEXPOSED
Warning, fails
In a container bound to a module, an entry point that owns nothing the module exposes, while a caller drawn to it reaches it from outside the module. Make the callers use what the module exposes, or expose what they use from a root file.
TEST_IMPORT_UNEXPOSED
Warning, fails
A test outside a module that imports a private file of the module. A test inside the module can use its private files. Import a public entry file of the module, or move the test inside it.
CALLER_UNDRAWN
Warning, fails
A hidden part whose exposed code a file outside the module runs, and no part binds that file. Add the callers and their relationships outside the module. If the use is unintended, stop exporting that code.
DOCUMENT_PATH_MISSING
Warning, fails
A document reference whose file is not at the branch or commit that the reference names (ADR 0054). Name the file where the document is now, pin the reference to a commit that holds it, or remove the reference.
INHERITED_PART_DROPPED
Warning, fails
A proposal removes a bound part from its predecessor, while that source path or symbol still exists. The dropped field identifies the predecessor and source evidence. To keep the part, bring it back into the proposal with the same id. If the change removes the part, remove its code.
RELATIONSHIP_BACKWARDS
Information
A relationship with no anchor whose evidence runs only the other way. Turn the relationship around if the code runs that way. If the direction is the convention of its kind, anchor it to the code that proves it.
RELATIONSHIP_UNSUPPORTED
Information
A relationship with no anchor whose evidence does not join its ends. Its missing field names the side with no evidence, code or infrastructure. The evidence list of each relationship kind in the vault configuration says what it accepts. Anchor it to the code that proves it, or change it to what the code does.
EXPOSED_UNUSED
Information
The names that a module exposes and no file outside it uses. Stop exposing the names that no caller needs, unless a caller outside this checkout uses them.
VARIABLE_PASSED_THROUGH
Information
A Terraform or OpenTofu module that passes a variable unchanged to one argument of a resource. Let the module decide or hide the value, so that its callers need not.
MODULE_SHALLOW
Information
A Terraform or OpenTofu module that wraps one resource and passes every variable through. Let callers declare the resource, or let the module decide what its callers need not.
What the code check skips #
A skip is something the check did not read, with the reason. A skip never fails the check, and it is listed so that an unread subject never looks clean.
unbound
Skip
A part with no binding, so it has no code to read. Bind it once its code exists.
A binding or anchor in a repository that this machine has not registered. Check out that repository and register it with archboard repo add, then run the check again.
path-ignored
Skip
A bound or anchored path that Git ignores. Bind code that Git tracks.
path-never-read
Skip
Terraform state, a variable file or the .terraform directory, which can hold secrets in plain text. The check never reads them.
text-only
Skip
Files that no grammar reads. The check judges their anchors and bound symbols by name only. Its detail names the kinds of file.
A symbol that can lie below a Nix expression that the check cannot follow, such as an import, or in a Helm template, whose names only Helm gives. Its detail names the file and the lines.
ends-overlap
Skip
A relationship with no anchor whose ends hold one another or bind the same code. Evidence never joins such parts. Anchor the relationship, or join parts that do not overlap.
A model document whose named variant has no current state and no draft, or a vault file that is not a model document.
symbol-unparsed
Skip
A symbol found only in code that did not parse.
A checkout and language with no configured language server, named once. Its detail names the command that configures one: run archboard repo language-server with the language and the server's command, and install that command.
A project that its server cannot answer about. Examples are a Swift directory with no Package.swift, a C# checkout with no solution or project file, a C, C++ or Objective-C file with no compile_commands.json, a Rust file that no Cargo.toml holds, and a Go file that no go.mod holds. Add the file that the project lacks. Build a Swift package once, because the check never builds, and its server answers only from a build's index.
A checkout where its server did not start, did not answer in time, or ended. Its detail names the program and what it did. Run that program by hand in the checkout to see why, then run the check again.
exposure-unknown
Skip
A module whose root files it cannot read. No language that the check reads has a root file in its directory, or its package.json exports name no file of the checkout. Bind the module to the directory that holds its root files, or make its exports name them.
module-not-read
Skip
An address inside a remote module, unless --plan names a plan for that root. To read it, pass the plan JSON of that root with --plan.
Code read at a ref. A language server reads the files on disk, so a use that no import resolves there stays as the code facts read it.
refs-differ
Skip
A relationship whose ends are read at different refs.
ref-not-checked-out
Skip
A ref that the checkout cannot resolve. It names the ref. Fetch that ref into the checkout, then run the check again.
A draft whose ref the checkout does not have, or whose bindings name several refs. Fetch the missing ref, or give the bindings of the draft one ref in each repository.
Embeds check #
The embeds check finds each SVG and PNG that Git tracks and that carries a render recipe. It draws the recipe again and compares the result with the file. A warning fails the check. Information never does. A finding about a file of another repository is information, whatever its code, because that repository draws the file again only after the vault's change merges.
EMBED_OUTDATED
Warning, fails
The model says something new since the picture was drawn. Draw it again with --fix, then commit it.
EMBED_SOURCE_MISSING
Warning, fails
The model, the state or the view that the recipe names is gone, or what it names draws nothing now. Draw the picture from a reading that exists, or remove it.
EMBED_VAULT_FETCH_FAILED
Warning, fails
No checkout on this machine holds the vault that the recipe names, fetching it failed, and no copy is cached. So the picture was not checked. Register a checkout of that repository with repo add.
EMBED_RECIPE_UNREADABLE
Warning, fails
The file carries a recipe that cannot be read, so nothing can draw it again. Draw the picture again from the model, or remove it.
EMBED_RENDERER_CHANGED
Information
Only the picture differs, because the renderer draws the same model differently. The model says nothing new.
EMBED_VAULT_CACHED
Information
Fetching the vault failed, and the check read the newest cached copy, which can be behind the default branch. Every finding against it is information, and --fix draws nothing from it.