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

backtick-substitution

A deny rule by default: it refuses a backtick command substitution, which inside double quotes runs a command, and names what to run instead.

What it catches

A backtick command substitution, which inside double quotes runs a command.

Why

Inside double quotes a backtick starts a command substitution, so a pattern or a message carrying a literal backtick runs code: the backtick pairs with the next one anywhere on the line, and everything between them becomes one command. A grep whose pattern and a later stage's pattern each hold a triple backtick pair them into ONE substitution that swallows the file operand and the rest of the pipeline. What is left is a grep with no file, reading a stdin that never closes. A literal backtick belongs in single quotes, where it is text. A substitution is written $(...), which nests and cannot pair with a stray backtick. Backticks inside single quotes and inside a quoted heredoc (<<'EOF') are text and never fire; neither does a line that does not parse.

Default and override

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

magus\guard.builtins({"backtick-substitution": "advise"})

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:

deny [backtick-substitution]: ...

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

See also

guardrulesbacktick-substitutiondeny
Last updated (1a76274f)
Earlier changes on this page (1)

Full history ↗ · Blame source ↗

Glossary

Workspace

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

Magusfile

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

Op

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

Buzz

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

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

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