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

sed-in-place

A deny rule: it refuses sed -i, whose two spellings destroy each other's work across platforms, and names what to run instead.

What it catches

sed -i, whose two spellings destroy each other's work across platforms.

Why

sed -i is not portable and the two spellings destroy each other's work. GNU reads sed -i 's/x/y/' f as an edit; BSD and macOS read that same script as the BACKUP SUFFIX and take the next argument as the script. sed -i '' ... is the macOS spelling and makes GNU edit nothing. So a command that works here mangles the file on the next machine, by WRITING, before anyone reads a diff. An editor tool reads the file first and reports what it changed, and for a whole-tree rename magus refs <symbol> --occurrences gives column-precise sites a pattern cannot. Reading with sed is untouched.

Seeing it

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

deny [sed-in-place]: ...

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

See also

  • All rules - what this workspace enforces, deny first
  • The guard - how a verdict is reached and wired
guardrulessed-in-placedeny
Last updated (d966bfce)
Glossary

Workspace

The magus root directory that owns a set of projects and shared config; the unit magus operates over. See workspace.

Spell

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

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.

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.

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.