mdqy 0.1.3

jq for markdown: query and transform Markdown with a hybrid selector and jq DSL
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

# Transforms

The write path covers attribute-level edits: a link's href, an
image title, a heading level, anything stored in `Node::attrs`.
`walk` plus `|=` handles the bulk of real rewrites.

## Operators

```
.attr |= f        update .attr by running f with its current value
del(.attr)        remove .attr entirely
walk(f)           post-order. recurse into children, then apply f
```

`|=` shapes:

```sh
(.. | select(type == "link")).href |= sub("http:"; "https:")
(h1).level |= (. + 1)
(codeblocks | select(.lang == "rust")).lang |= "rs"
```

`del` looks like a builtin call but carries mutation semantics,
so the write path intercepts it before the evaluator sees it.
`.attr` on the left of `|=` is handled the same way.

`walk(f)` runs `f` at every node, children first. Inside `f` you
can use the same mutation operators:

```sh
mdqy -U 'walk(if type == "heading" then .level |= (. + 1) else . end)' doc.md
mdqy -U 'walk(if type == "image" then del(.title) else . end)' doc.md
```

Conditions in `walk(f)` run through the read-only evaluator.
Mutation arms go through the walk-aware mini-interpreter in
`mutate::apply_walk_f`.

## Output modes

```
--dry-run       print a unified diff, exit 0 either way
-U              atomic in-place write (temp file + rename(2))
(default)       write transformed markdown to stdout
```

`--dry-run` and `-U` combine. `--dry-run` prints what `-U` would
do without touching the file.

```sh
mdqy --dry-run '(.. | select(type == "link")).href |= sub("http:"; "https:")' docs/
mdqy -U 'del((.. | select(type == "image")).title)' README.md
```

## How source bytes survive

Every `Node` parsed from the buffer carries a byte `Span`. The
serializer in `emit::md` walks the mutated tree. For any clean
subtree with a span, it calls
`out.extend_from_slice(&source[span])`, returning the original
bytes untouched. Mutations set `dirty = true` on the affected
node and every ancestor up to the root. Dirty subtrees get
re-emitted as pulldown events and fed to `pulldown-cmark-to-cmark`.

Consequences:

- A link href rewrite touches only the link span in the output.
  Surrounding paragraphs, fences, list markers, blank-line padding
  all stay verbatim.
- Regenerated spans go through `pulldown-cmark-to-cmark`, which
  normalises some style choices (emphasis marker, fence width).
  That normalisation is localised to dirty subtrees.
- Synthetic nodes (from `node(...)` or `section(...)`) have no
  span, so they always regenerate.

## Atomic writes

`-U` writes through `tempfile::NamedTempFile::persist`:

1. Create a temp file in the same directory as the target (same
   filesystem, so `rename(2)` is atomic and `EXDEV` can't bite).
2. Write the transformed bytes.
3. `fsync` the temp file.
4. Rename over the target.

If anything fails before the rename, the original is untouched.

## What's not supported

- `=`, set-style assignment. Use `|=`.
- Structural mutation. `.children |= [...]`, inserting siblings,
  replacing a whole subtree. `walk(f)` covers the needed shapes.
- Mutation targets that don't resolve to `Node` values. `|=` and
  `del` expect node-valued selectors on the left.