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

source-read

An advisory by default: it explains, and blocks nothing, on an unbounded source read the symbol index has already answered.

What it catches

An unbounded source read the symbol index has already answered.

Default and override

By default this rule takes the decision advise. A workspace sets it by name, in its root magusfile, to advise or off:

magus\guard.builtins({"source-read": "off"})

A loosening takes effect once it is committed; a tightening applies at once.

Seeing it

A verdict names its rule in brackets, which is how you got here:

advise [source-read]: ...

magus describe rule source-read prints the same entry at a terminal, and magus describe rules lists every rule this workspace enforces.

See also

ReferencePages in this section. compat-marker: a leased worker adding a marker that keeps code for older data or callersAn advisory by default: it explains, and blocks nothing, on a leased worker adding a marker that keeps code for older data or callers. echo-on-success: an `&& echo` that restates what the exit status already saysAn advisory by default: it explains, and blocks nothing, on an `&& echo` that restates what the exit status already says. focus: a read or write outside the paths the running job declaredAn advisory by default: it explains, and blocks nothing, on a read or write outside the paths the running job declared.
guardrulessource-readadvise
Last updated (c6a327d5)
Earlier changes on this page (3)

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.

Magusfile

The magusfile.buzz that declares a project's targets (as export funs) and binds its spells. Magusfile in full.

Buzz

The language magusfiles are written in (the .buzz engine). Buzz 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.

Agent

A model working through an agent host such as Claude Code, Codex, Cursor or OpenCode. magus treats an agent as one more caller of its CLI, MCP tools and console, held to the same checks as a person. Agent in full.

Advisor

One read-only check from the advice suite: it reads the changeset through magus and writes one titled section of findings. The same advisors run as a pull request comment in CI and inside magus diff --impact locally. Advisor in full.

Conventions

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