typdiff 0.1.0

A diff tool for Typst documents, similar to latexdiff
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# typdiff

A diff tool for [Typst](https://typst.app/) documents, similar to [latexdiff](https://github.com/ftilmann/latexdiff) for LaTeX.

`typdiff` compares two Typst source files and generates a new Typst document that visually highlights the differences — <ins>added text</ins> in blue with underline and <del>deleted text</del> in red with strikethrough.

## Example

Given an old document:

```typst
= Introduction

This is the old text.

- First item
- Second item

== Details

The quick brown fox jumps over the lazy dog.
```

And a new document:

```typst
= Background

This is the new text.

- First item
- Third item
- Fourth item

== Details

The quick red fox leaps over the lazy cat.
```

Running `typdiff old.typ new.typ` produces:

```typst
= #diff-deleted[Introduction]

= #diff-added[Background]

This is the #diff-deleted[old]#diff-added[new] text.

- First item

- #diff-deleted[Second]#diff-added[Third] item

- #diff-added[Fourth item]

== Details

The quick #diff-deleted[brown]#diff-added[red] fox #diff-deleted[jumps]#diff-added[leaps] over the lazy #diff-deleted[dog]#diff-added[cat].
```

Compile the output with `typst compile` to get a PDF with visual diff markup.

## Installation

### From source

```sh
cargo install --git https://github.com/sou1118/typdiff
```

### Build locally

```sh
git clone https://github.com/sou1118/typdiff
cd typdiff
cargo build --release
```

The binary will be at `target/release/typdiff`.

## Usage

```
typdiff <OLD> <NEW> [-o <OUTPUT>]
```

| Argument | Description |
|---|---|
| `<OLD>` | Path to the old Typst file |
| `<NEW>` | Path to the new Typst file |
| `-o, --output <OUTPUT>` | Output file path (defaults to stdout) |

### Examples

```sh
# Print diff to stdout
typdiff old.typ new.typ

# Save diff to a file
typdiff old.typ new.typ -o diff.typ

# Generate a PDF
typdiff old.typ new.typ -o diff.typ && typst compile diff.typ
```

## Features

- **Block-level diffing** — Detects structural changes in headings, paragraphs, list items, enum items, and term list items
- **Word-level diffing** — Shows fine-grained changes within modified blocks
- **CJK support** — Character-level granularity for Chinese, Japanese, and Korean text
- **Atomic blocks** — Raw blocks, equations, and function calls are treated as indivisible units
- **Safe output** — Escapes references, labels, and special syntax in deleted content to prevent compilation errors

## How it works

1. **Parse** — Both Typst files are parsed into block-level elements (headings, paragraphs, list items, etc.) using `typst-syntax`
2. **Diff** — Blocks are compared using the Patience diff algorithm, with similarity-based matching for modified regions
3. **Render** — The diff result is rendered back to Typst source with `#diff-added[...]` and `#diff-deleted[...]` markup

## License

Apache-2.0