magus v0.4.3 is out. See what's new
¶ View markdown source · ✎ Suggest an edit
1 min read

Knowledge-graph diagnostics

Codes in the MGS7xxx range flag ambiguities the knowledge-graph extractor hits while assembling the deterministic graph from workspace sources (the graph that backs magus query, magus explain, and magus graph). Unlike most magus diagnostics, these are not raised as errors that stop a build: the graph is derived and safe to rebuild implicitly, so an ambiguity is recorded as a silent attribute on the affected node (visible via magus explain) rather than logged. They mark spots where extraction could not resolve something cleanly, for a human to check.

Codes

  • MGS7001: a buzz import resolves to no scanned file and is not a compiled-in module, so it becomes an inferred edge to the literal path.
  • MGS7002: a doc page cites an MGS#### code that is not registered, so no edge can link the mention to a real diagnostic node.
  • MGS7003: magus diff could not bring the symbol index current for a project the change touched, so the conformance checks did not run. This one is reported as an error in place of their findings, not as an attribute.
knowledge graphdiagnosticserror codesMGS7xxxextractionbuzzdocs
Last updated (8b20a199)
Earlier changes on this page (2)

Full history ↗ · Blame source ↗

Glossary

Workspace

The magus root directory that owns a set of projects and shared config; the unit magus operates over. Workspace in full.

Project

A directory magus recognizes as a unit of work (it has a magusfile); the unit of caching, scheduling, and dependency tracking. Project in full.

Op

A single tool-native command a target composes (long form: operation); the middle of the work hierarchy (Spell to Op to Target). Op in full.

Module

A magus stdlib namespace a magusfile imports for host capabilities: filesystem, exec, vcs, and more. Module in full.

Buzz

The language magusfiles are written in (the .buzz engine). Buzz in full.

Affected

The set of projects touched by a change; magus affected <target> runs a target only over them. Affected in full.

CI

An ordinary target you compose yourself with ctx.needs; magus does not hardcode its stages. It is the anchor magus affected ci keys off, and ci strips the rw charm. CI in full.

Knowledge graph

The queryable graph of a workspace's spells, targets, docs, and code relationships; query it with magus query/explain/path. Knowledge graph in full.

Diagnostic code

A stable MGSxxxx identifier attached to a magus warning or error, so it can be referenced and looked up; some are guardrails (see wards), others hard errors. Diagnostic code in full.

Run

One target executing under one magus invocation, such as magus run test web or magus affected ci. A run keeps its captured output behind an output reference. Every magus run is a run whether or not any job asked for it; see Job for how the two relate. Run in full.

Conventions

This page uses none of the site's convention markers. The full set is on the conventions page.