markdown

The markdown spell lints and formats Markdown. markdownlint enforces style, and prettier checks formatting; the rw charm turns the check into an in-place rewrite.

Runtime name: markdown (source spells/markdown/)

Version probe: none

Passing arguments to ops

Every op is invoked as markdown["<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:

Working directory and environment are NOT options: they ride the context, as markdown["<op>"](ctx.withCwd("sub")) and markdown["<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.

markdownlint

Command: markdownlint **/*.md **/*.mdx

Example

// markdownlint enforces Markdown style across the docs.
import "magus";
import "magus/spell/markdown";

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

export fun lint(ctx: magus\Context, args: [str]) > void {
    markdown["markdownlint"](ctx);
}

prettier

Command: prettier --check --no-error-on-unmatched-pattern **/*.md **/*.mdx

rw

Replaces --check with --write.

[
  {
    "op": "replace",
    "path": "/0",
    "value": "--write"
  }
]

Example

// prettier checks Markdown formatting; the rw charm (magus run format:rw) rewrites in place.
import "magus";
import "magus/spell/markdown";

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

export fun format(ctx: magus\Context, args: [str]) > void {
    markdown["prettier"](ctx);
}

typos

Command: typos --format brief

rw

Appends -w.

[
  {
    "op": "add",
    "path": "/-",
    "value": "-w"
  }
]