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

rs

The rs spell wires Cargo into a magusfile. Each op forks a cargo subcommand directly; cargo-build builds in release mode and cargo-clippy denies warnings, matching a CI-gating default.

Runtime name: rs (source spells/rust/)

Version probe: rustc --version

Passing arguments to ops

Every op is invoked as rs["<op>"](ctx, opts?). The first argument is the target's context, which is what carries the execution environment; the optional options map shapes the command itself:

Key Type Description Source
args [str] Extra arguments appended to the resolved command. Omit it and a bare rs["<op>"]() forwards magus run <target> -- <extra> to the tool automatically; pass it to set the arguments explicitly, which replaces that passthrough. source
stdin str Data written to the command's standard input. source

Working directory and environment are NOT options: they ride the context, as rs["<op>"](ctx.withCwd("sub")) and rs["<op>"](ctx.withEnv({"CGO_ENABLED": "0"})). Only the context reaches the cache key, so an option-table cwd or env would change what the tool did while the key said otherwise - passing either as an option is an error.

Charms (the :charm suffix, e.g. magus run test:rw) are orthogonal: they patch the base argv, while these options add to it. See Charms.

cargo-build

Command: cargo build --release

Example

// cargo-build compiles in release mode: magus run build forks cargo build --release.
import "magus";
import "magus/spell/rs";

magus\project({ "spells": [rs] });

export fun build(ctx: magus\Context, args: [str]) > void {
    rs["cargo-build"](ctx);
}

cargo-clean

Command: cargo clean

Example

// Wire cargo-clean into a clean target: magus run clean forks cargo clean.
import "magus";
import "magus/spell/rs";

magus\project({ "spells": [rs] });

export fun clean(ctx: magus\Context, args: [str]) > void {
    rs["cargo-clean"](ctx);
}

cargo-clippy

Command: cargo clippy -- -D warnings

Example

// cargo-clippy lints and denies warnings (-D warnings), gating CI on a clean run.
import "magus";
import "magus/spell/rs";

magus\project({ "spells": [rs] });

export fun clippy(ctx: magus\Context, args: [str]) > void {
    rs["cargo-clippy"](ctx);
}

cargo-fmt

Command: cargo fmt -- --check

rw

Drops --check, drops --.

JSON Patch
[
  {
    "op": "remove",
    "path": "/2"
  },
  {
    "op": "remove",
    "path": "/1"
  }
]

Example

// cargo-fmt checks formatting; the rw charm (magus run format:rw) rewrites in place.
import "magus";
import "magus/spell/rs";

magus\project({ "spells": [rs] });

export fun format(ctx: magus\Context, args: [str]) > void {
    rs["cargo-fmt"](ctx);
}

cargo-test

Command: cargo test

Example

// Wire cargo-test into a test target: magus run test forks cargo test.
import "magus";
import "magus/spell/rs";

magus\project({ "spells": [rs] });

export fun test(ctx: magus\Context, args: [str]) > void {
    rs["cargo-test"](ctx);
}

scip

scip is the reserved op that runs the Rust SCIP indexer for the knowledge graph. magus injects MAGUS_SYMBOL_INDEX with the cache destination, so the index never lands in the tree; rust-analyzer's scip subcommand writes there via --output. Run through sh so the env var expands.

Command: sh -c rust-analyzer scip . --output "$MAGUS_SYMBOL_INDEX"

auto-generatedrsspellrustcargobuildtesttools
Last updated (15118091)
Earlier changes on this page (2)

Full history ↗ · Blame source ↗

Glossary

Project

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

Magusfile

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

Target

A named operation (build, test, ...) you invoke with magus run <target>; it may compose a spell's tool-native operations and depend on other targets. See targets.

Spell

A language/runtime adapter (e.g. go, md) that maps generic targets onto a toolchain's real commands. See spells.

Charm

An execution modifier attached with : (lint:rw) that changes how a target runs, not which one; the built-in rw flips a check-only target to mutate in place, and ci always strips it. See charms.

Ward

A coded diagnostic that inspects a resolved op and nudges or blocks an anti-pattern before it runs. See wards.

Buzz

The language magusfiles are written in (the .buzz engine). See engines.

Cache

The content-addressed store magus consults before running a target, so unchanged work is skipped. See cache.

CI

An ordinary magusfile-defined target you compose yourself with magus\needs - magus does not hardcode its stages. Magus.RunCI treats it specially only in that it strips the rw charm, it is the anchor magus affected ci keys off, and a selected scope with no project declaring it is a load error rather than a silent no-op. See targets.

Knowledge graph

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

Conventions

Placeholders

Angle brackets mark a value you replace with your own - never type the brackets:

magus run <target>
magus completion <shell>    # e.g. bash, zsh, fish

<target>, <path>, <shell>, <name> and the like are stand-ins, not literal text.