termrender 4.9.0__tar.gz → 4.10.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {termrender-4.9.0 → termrender-4.10.0}/CHANGELOG.md +75 -0
- {termrender-4.9.0 → termrender-4.10.0}/PKG-INFO +4 -5
- {termrender-4.9.0 → termrender-4.10.0}/README.md +3 -3
- {termrender-4.9.0 → termrender-4.10.0}/pyproject.toml +0 -6
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/CLAUDE.md +3 -9
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/borders.py +4 -3
- termrender-4.10.0/src/termrender/renderers/mermaid.py +117 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_class.py +0 -13
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_flow_layout.py +286 -21
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_class.py +13 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_dispatch.py +116 -58
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_flow_corpus.py +30 -0
- termrender-4.10.0/uv.lock +70 -0
- termrender-4.9.0/scripts/build-mermaid-ascii.sh +0 -36
- termrender-4.9.0/scripts/mermaid_flow_parity.py +0 -168
- termrender-4.9.0/src/termrender/_bin/mermaid-ascii-darwin-arm64 +0 -0
- termrender-4.9.0/src/termrender/_mermaid_bin.py +0 -41
- termrender-4.9.0/src/termrender/renderers/mermaid.py +0 -214
- termrender-4.9.0/tests/test_mermaid_compat.py +0 -151
- termrender-4.9.0/uv.lock +0 -94
- {termrender-4.9.0 → termrender-4.10.0}/.github/workflows/publish.yml +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/.gitignore +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/CLAUDE.md +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/LICENSE +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/design.json +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/requirements.json +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/CLAUDE.md +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/__init__.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/__main__.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/blocks.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/emit.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/layout.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/parser.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/py.typed +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/__init__.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/charts.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/code.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/columns.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/diff.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/divider.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_er.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_flow.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_flow_model.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_flow_parser.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_gantt.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_journey.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_mindmap.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_pie.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_prelude.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_sequence.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_state.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/mermaid_timeline.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/panel.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/quote.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/stat.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/table.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/text.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/timeline.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/renderers/tree.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/src/termrender/style.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/__init__.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_charts.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_cli_contract.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_column_alignment.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_diff.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_inline_badge.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_linebreak.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_er.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_flow.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_flow_layout.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_flow_model.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_flow_parser.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_flow_shapes.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_gantt.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_journey.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_mindmap.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_pie.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_sequence.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_state.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_mermaid_timeline.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_myst_gaps.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_stat.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_tasklist.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_timeline.py +0 -0
- {termrender-4.9.0 → termrender-4.10.0}/tests/test_variable_colons.py +0 -0
|
@@ -1,6 +1,81 @@
|
|
|
1
1
|
# CHANGELOG
|
|
2
2
|
|
|
3
3
|
|
|
4
|
+
## v4.10.0 (2026-07-07)
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
- **mermaid**: Native dispatch for flowchart/class/state/er, drop vendored Go binary
|
|
9
|
+
([`6935f30`](https://github.com/crouton-labs/termrender/commit/6935f30a1dccfefcc34344de02191f8481d53668))
|
|
10
|
+
|
|
11
|
+
Wire the four previously-unwired native renderers into mermaid.py's first-line dispatcher:
|
|
12
|
+
flowchart/graph -> mermaid_flow.render_flowchart, classDiagram -> mermaid_class.render_class,
|
|
13
|
+
stateDiagram/-v2 -> mermaid_state.render_state, erDiagram -> mermaid_er.render_er. Every mermaid
|
|
14
|
+
type termrender renders is now native Python; no diagram type shells out anymore.
|
|
15
|
+
|
|
16
|
+
Unrecognized/exotic types (sankey, C4, gitgraph, block, packet, kanban, quadrantChart, ...) degrade
|
|
17
|
+
in the dispatcher itself to a raw echo of the source with box-drawing/geometric glyphs stripped,
|
|
18
|
+
preserving the contract the crouter attach viewer relies on to detect render failure by glyph
|
|
19
|
+
absence.
|
|
20
|
+
|
|
21
|
+
Delete the vendored Go path entirely: src/termrender/_bin/ (binary), src/termrender/_mermaid_bin.py,
|
|
22
|
+
scripts/build-mermaid-ascii.sh, the mermaid-ascii runtime dependency and hatch artifacts stanza in
|
|
23
|
+
pyproject.toml (relocked via uv.lock), and scripts/mermaid_flow_parity.py (a standalone dev-only
|
|
24
|
+
harness comparing native output against the now-deleted binary).
|
|
25
|
+
|
|
26
|
+
tests/test_mermaid_compat.py pinned Go-era preprocessing (preprocess_mermaid_for_ascii) that no
|
|
27
|
+
longer exists; deleted wholesale since dispatch/prelude contracts it also touched already live in
|
|
28
|
+
test_mermaid_dispatch.py. That file's routing tests are updated for the four newly-wired types and
|
|
29
|
+
gain dispatch tests for the exotic raw-echo path (including a no-native-renderer-called assertion
|
|
30
|
+
and a glyph-range sweep pinning the no-box-glyph contract).
|
|
31
|
+
|
|
32
|
+
Swept src/termrender/renderers/CLAUDE.md and README.md to current-state only; no remaining
|
|
33
|
+
references to mermaid-ascii/_mermaid_bin/the Go binary anywhere in the tree.
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
## v4.9.1 (2026-07-07)
|
|
37
|
+
|
|
38
|
+
### Bug Fixes
|
|
39
|
+
|
|
40
|
+
- **mermaid-flow**: Stop dropping edge labels/markers on a shared exit anchor
|
|
41
|
+
([`552d3d3`](https://github.com/crouton-labs/termrender/commit/552d3d3deef061e23c5b894852ae024065366eb8))
|
|
42
|
+
|
|
43
|
+
When 2+ edges leave one node through the router's single fixed exit anchor (e.g. two forward edges
|
|
44
|
+
in LR/RL, or a diamond node's right side), two defects followed:
|
|
45
|
+
|
|
46
|
+
- Label drop: the shared first segment of each edge's Z-path could tie in length with each edge's
|
|
47
|
+
own distinguishing segment further along - routine in LR/RL, where a node's fan-out run and its
|
|
48
|
+
branch runs often measure the same few cells. _longest_segment's old first-wins tie-break always
|
|
49
|
+
picked that shared segment for both edges' labels, so the second label landed on cells the first
|
|
50
|
+
already claimed and silently vanished. Fixed by breaking ties toward the *last* segment instead -
|
|
51
|
+
the segment nearest each edge's own destination, which is never shared. TB is unaffected (its
|
|
52
|
+
branch runs are typically much longer than the shared trunk, so no tie exists there to begin
|
|
53
|
+
with).
|
|
54
|
+
|
|
55
|
+
- Marker drop: a source-side arrow-kind marker glyph (UML composition and aggregation diamonds)
|
|
56
|
+
drawn at the shared anchor cell survived only for the last-drawn edge. Fixed via a new pre-pass,
|
|
57
|
+
_allocate_edge_anchors, that spreads a group's exit points along the node's side - but only when
|
|
58
|
+
2+ of that group's edges actually carry a source-side marker. Plain, markerless fan-outs (by far
|
|
59
|
+
the common case) keep sharing one exit cell, since that's what makes draw_segment's junction
|
|
60
|
+
bitmask resolve into a single clean tee rather than two disjoint stubs - spreading those would
|
|
61
|
+
only change where the fan visually splits, not fix anything, and would break the existing
|
|
62
|
+
trunk-then-tee golden output for every unlabeled fan-out/merge case.
|
|
63
|
+
|
|
64
|
+
Anchor spreading is shape-aware for NodeShape.DIAMOND (the only shape whose left/right sides aren't
|
|
65
|
+
straight across their full bounding-rect span) so a spread point never lands in the diamond's
|
|
66
|
+
tapered corner region.
|
|
67
|
+
|
|
68
|
+
Removes the "known limitation" paragraph from mermaid_class.py's docstring now that the
|
|
69
|
+
composition/aggregation marker case it described is fixed.
|
|
70
|
+
|
|
71
|
+
Goldens touched: added test_lr_fan_out_with_labels_both_present_golden (new - pins the fixed LR
|
|
72
|
+
output, previously buggy/missing) and test_two_source_side_markers_from_one_class_both_survive
|
|
73
|
+
(new). No existing golden was changed - the fan-out/merge goldens (test_fan_out_golden,
|
|
74
|
+
test_multi_parent_dag_golden, test_td_direction_golden, test_lr_direction_golden) are
|
|
75
|
+
byte-for-byte unchanged because none of their edges carry a source-side marker, so the new
|
|
76
|
+
anchor-spread never triggers for them.
|
|
77
|
+
|
|
78
|
+
|
|
4
79
|
## v4.9.0 (2026-07-07)
|
|
5
80
|
|
|
6
81
|
### Features
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: termrender
|
|
3
|
-
Version: 4.
|
|
3
|
+
Version: 4.10.0
|
|
4
4
|
Summary: Rich terminal rendering of directive-flavored markdown
|
|
5
5
|
Project-URL: Homepage, https://github.com/CaptainCrouton89/termrender
|
|
6
6
|
Project-URL: Repository, https://github.com/CaptainCrouton89/termrender
|
|
@@ -22,7 +22,6 @@ Classifier: Topic :: Terminals
|
|
|
22
22
|
Classifier: Topic :: Text Processing :: Markup :: Markdown
|
|
23
23
|
Requires-Python: >=3.10
|
|
24
24
|
Requires-Dist: grandalf>=0.8
|
|
25
|
-
Requires-Dist: mermaid-ascii>=1.2
|
|
26
25
|
Requires-Dist: mistune>=3.0
|
|
27
26
|
Requires-Dist: pygments>=2.0
|
|
28
27
|
Description-Content-Type: text/markdown
|
|
@@ -163,7 +162,7 @@ That entire output — the nested borders, the tree guide lines, the side-by-sid
|
|
|
163
162
|
pip install termrender
|
|
164
163
|
```
|
|
165
164
|
|
|
166
|
-
Python 3.10+. Three dependencies: [mistune](https://github.com/lepture/mistune) (markdown parsing), [pygments](https://pygments.org/) (syntax highlighting), [
|
|
165
|
+
Python 3.10+. Three dependencies: [mistune](https://github.com/lepture/mistune) (markdown parsing), [pygments](https://pygments.org/) (syntax highlighting), [grandalf](https://github.com/bdcht/grandalf) (mermaid diagram layout).
|
|
167
166
|
|
|
168
167
|
|
|
169
168
|
## Usage
|
|
@@ -409,7 +408,7 @@ Horizontal rules with optional centered labels.
|
|
|
409
408
|
|
|
410
409
|
### Mermaid diagrams
|
|
411
410
|
|
|
412
|
-
Renders mermaid flowcharts as ASCII art
|
|
411
|
+
Renders mermaid diagrams (flowcharts, class/state/ER diagrams, pie/gantt/sequence/mindmap/journey/timeline charts) natively as ASCII/unicode art. Use the `:::mermaid` directive, or a standard GFM ` ```mermaid ` fenced code block — both render the same diagram.
|
|
413
412
|
|
|
414
413
|
**Input:**
|
|
415
414
|
```markdown
|
|
@@ -421,7 +420,7 @@ graph LR
|
|
|
421
420
|
:::
|
|
422
421
|
```
|
|
423
422
|
|
|
424
|
-
The diagram gets rendered as ASCII art inline in the terminal output
|
|
423
|
+
The diagram gets rendered as ASCII art inline in the terminal output, no external binary required.
|
|
425
424
|
|
|
426
425
|
|
|
427
426
|
### Nesting
|
|
@@ -134,7 +134,7 @@ That entire output — the nested borders, the tree guide lines, the side-by-sid
|
|
|
134
134
|
pip install termrender
|
|
135
135
|
```
|
|
136
136
|
|
|
137
|
-
Python 3.10+. Three dependencies: [mistune](https://github.com/lepture/mistune) (markdown parsing), [pygments](https://pygments.org/) (syntax highlighting), [
|
|
137
|
+
Python 3.10+. Three dependencies: [mistune](https://github.com/lepture/mistune) (markdown parsing), [pygments](https://pygments.org/) (syntax highlighting), [grandalf](https://github.com/bdcht/grandalf) (mermaid diagram layout).
|
|
138
138
|
|
|
139
139
|
|
|
140
140
|
## Usage
|
|
@@ -380,7 +380,7 @@ Horizontal rules with optional centered labels.
|
|
|
380
380
|
|
|
381
381
|
### Mermaid diagrams
|
|
382
382
|
|
|
383
|
-
Renders mermaid flowcharts as ASCII art
|
|
383
|
+
Renders mermaid diagrams (flowcharts, class/state/ER diagrams, pie/gantt/sequence/mindmap/journey/timeline charts) natively as ASCII/unicode art. Use the `:::mermaid` directive, or a standard GFM ` ```mermaid ` fenced code block — both render the same diagram.
|
|
384
384
|
|
|
385
385
|
**Input:**
|
|
386
386
|
```markdown
|
|
@@ -392,7 +392,7 @@ graph LR
|
|
|
392
392
|
:::
|
|
393
393
|
```
|
|
394
394
|
|
|
395
|
-
The diagram gets rendered as ASCII art inline in the terminal output
|
|
395
|
+
The diagram gets rendered as ASCII art inline in the terminal output, no external binary required.
|
|
396
396
|
|
|
397
397
|
|
|
398
398
|
### Nesting
|
|
@@ -28,7 +28,6 @@ classifiers = [
|
|
|
28
28
|
]
|
|
29
29
|
dependencies = [
|
|
30
30
|
"mistune>=3.0",
|
|
31
|
-
"mermaid-ascii>=1.2",
|
|
32
31
|
"pygments>=2.0",
|
|
33
32
|
"grandalf>=0.8",
|
|
34
33
|
]
|
|
@@ -46,11 +45,6 @@ source = "vcs"
|
|
|
46
45
|
|
|
47
46
|
[tool.hatch.build.targets.wheel]
|
|
48
47
|
packages = ["src/termrender"]
|
|
49
|
-
# Ship the vendored mermaid-ascii binary (built from pinned upstream master;
|
|
50
|
-
# see scripts/build-mermaid-ascii.sh). It lives inside the package dir so the
|
|
51
|
-
# default file selection includes it; artifacts ensures it survives even if
|
|
52
|
-
# VCS-ignored, and hatchling preserves its 0o755 exec bit.
|
|
53
|
-
artifacts = ["src/termrender/_bin/*"]
|
|
54
48
|
|
|
55
49
|
[tool.semantic_release]
|
|
56
50
|
version_toml = []
|
|
@@ -43,20 +43,14 @@ Attribution line is rendered for `block.attrs["author"]` **or** `block.attrs["by
|
|
|
43
43
|
|
|
44
44
|
`mermaid.py`'s `render(block, color)` (leaf signature, no `render_child` — the parent `CLAUDE.md` incorrectly lists mermaid as a Container renderer) is a thin wrapper: it reads `block.attrs["_rendered"]` if layout already precomputed it, else calls `render_mermaid_lines(source, width)`, then pads every line to `block.width` with `visual_ljust`. All the type-routing logic lives in `render_mermaid_lines`, shared with `layout.py`'s height pass (see below) so there is exactly one dispatch path, not two.
|
|
45
45
|
|
|
46
|
-
**Dispatch is by first real line, case-insensitive** (`_first_line_type`), after skipping any prelude via `mermaid_prelude.strip_prelude_lines` (see below): `pie`, `gantt`, `sequenceDiagram`, `mindmap`, `journey`, and `
|
|
46
|
+
**Dispatch is by first real line, case-insensitive** (`_first_line_type`), after skipping any prelude via `mermaid_prelude.strip_prelude_lines` (see below): `pie`, `gantt`, `sequenceDiagram`, `mindmap`, `journey`, `timeline`, `graph`/`flowchart`, `classDiagram`, `stateDiagram`/`stateDiagram-v2`, and `erDiagram` all route to dedicated native Python renderers (`mermaid_pie.py`, `mermaid_gantt.py`, `mermaid_sequence.py`, `mermaid_mindmap.py`, `mermaid_journey.py`, `mermaid_timeline.py`, `mermaid_flow.py::render_flowchart`, `mermaid_class.py::render_class`, `mermaid_state.py::render_state`, `mermaid_er.py::render_er`). Every other type (sankey, C4, gitgraph, block, packet, kanban, quadrantChart, …, and anything unrecognized) has no renderer at all and degrades in the dispatcher itself, via `_raw_echo`: the source lines verbatim, `.rstrip()`-ed, with any box-drawing/geometric glyph (`\u2500-\u259f`/`\u25a0-\u25ff`) replaced by `?`. **Do not add a bordered fallback panel for the exotic path** — crouter's attach viewer detects render failure by the *absence* of box-drawing glyphs in the output, and a decorative border would defeat that; the four flowchart-model-backed native renderers (flow/class/state/ER) uphold the identical no-glyph guarantee on their own internal degradation paths (malformed input, wrong header, zero nodes/classes/states/entities parsed, or an unexpected exception escaping layout) — see each module's own docstring.
|
|
47
47
|
|
|
48
|
-
**`mermaid_prelude.py`** — a tiny shared module (no dependency on `Block` or the rest of the pipeline) implementing `strip_prelude_lines(lines)`, used by
|
|
48
|
+
**`mermaid_prelude.py`** — a tiny shared module (no dependency on `Block` or the rest of the pipeline) implementing `strip_prelude_lines(lines)`, used by `mermaid.py`'s dispatch sniff and by every native renderer's own header check (`mermaid_sequence.py`, `mermaid_flow_parser.py`, `mermaid_class.py`, `mermaid_state.py`, `mermaid_er.py`). It skips leading blank lines, `%%` line comments, `%%{init: ...}%%` directives, and `---`-delimited YAML frontmatter, permissively: an unterminated frontmatter block or directive is left alone rather than eating real content. Prelude stripping is for *sniffing/validating the type line only* — most per-type body parsers receive the full untouched source and do their own prelude-aware header check internally (flow/class/state/ER/sequence); `mindmap`/`journey`/`timeline` are the exception, called with `mermaid.py::_stripped(source)` since those parsers don't skip prelude themselves. `mermaid_pie.py`/`mermaid_gantt.py` just skip lines that don't match their grammar — a frontmatter `title: X` line could in principle collide with a `title` grammar rule, but this is accepted as the same class of pragmatic-parsing tradeoff as any other unrecognized line.
|
|
49
49
|
|
|
50
|
-
**`
|
|
51
|
-
|
|
52
|
-
**`visual_ljust` pads but never truncates**: every output line (from any type — binary or native) is padded to `block.width` in the outer `render()`. Lines wider than `block.width` overflow without clipping. `mermaid-ascii` has no width-control flag (`--maxWidth`/`-w` do not exist — the call passes only `-f - -y 1`), so wide flowchart output silently exceeds the layout boundary; the native renderers respect `width` by construction (pie/gantt/timeline size their own bars to it; sequence/mindmap/journey have intrinsic width and may overflow, matching the binary path's contract) — see each renderer's own note below.
|
|
50
|
+
**`visual_ljust` pads but never truncates**: every output line (from any type) is padded to `block.width` in the outer `render()`. Lines wider than `block.width` overflow without clipping — pie/gantt/timeline size their own bars to `width`; sequence/mindmap/journey and the four flowchart-model-backed renderers (flow/class/state/ER) have intrinsic content-driven width and may overflow, `width` there is advisory only.
|
|
53
51
|
|
|
54
52
|
Layout (`layout.py::resolve_height`, `BlockType.MERMAID` branch) precomputes `block.attrs["_rendered"]` by calling the same `render_mermaid_lines`, so `mermaid.py`'s `render()` only recomputes when that key is absent (e.g. calling `render()` on a block that skipped the layout pass).
|
|
55
53
|
|
|
56
|
-
**Flowchart node shapes are normalized to rectangles**: `preprocess_mermaid_for_ascii` rewrites every non-rectangle flowchart node shape (`{rhombus}`, `[(cylinder)]`, `((circle))`, `([stadium])`, `{{hexagon}}`, `[[subroutine]]`, `[/parallelogram/]`) to the `id[label]` form via `_FLOWCHART_SHAPE_SUBS`, because mermaid-ascii's `parseNode` only recognizes `[text]` rectangles — other shapes otherwise leak raw delimiters or the bare node id into the box. This is a permanent workaround: node shapes are unsupported on current upstream master (pin `6fffb8e`) and the 6 newer master commits are arrow-parsing only, so don't expect a pin bump to remove the need. The backend draws a rectangle regardless, so only the label text matters.
|
|
57
|
-
|
|
58
|
-
**Binary resolution**: the executable comes from `_mermaid_bin.mermaid_ascii_bin()` — the vendored `_bin/mermaid-ascii-<os>-<arch>` (pinned upstream master `6fffb8e`, built via `scripts/build-mermaid-ascii.sh`) if present for the platform, else `mermaid-ascii` on PATH (the PyPI wheel, capped at 1.2.0).
|
|
59
|
-
|
|
60
54
|
## `mermaid_pie.py` — re-expressed as a bar chart, not a text circle
|
|
61
55
|
|
|
62
56
|
A text pie chart is worse than a labeled bar chart at the same information density (per the ratified plan), so `parse_pie` extracts `(title, items)` from the `pie [showData]` / `title …` / `"label" : value` grammar and `render` hands the items to `charts.py::render_bar` via a synthetic `Block(type=BlockType.BAR, ...)` — no duplicated bar-drawing logic. Each item's `unit` attr is set to the pre-formatted percentage string (e.g. `" (40.0%)"`) so `render_bar`'s existing value-formatting appends it for free. Called with `color=False` always — mermaid output is monochrome by design (the attach viewer relies on `--color on == --color off`). Unparseable/empty input degrades to the raw source lines, same contract as the binary path.
|
|
@@ -31,9 +31,10 @@ def render_box(
|
|
|
31
31
|
corner_v = visual_len("┌") # same as ┐, └, ┘
|
|
32
32
|
|
|
33
33
|
# Grow the box if any content line (or the title) won't fit at the
|
|
34
|
-
# requested width. mermaid
|
|
35
|
-
#
|
|
36
|
-
#
|
|
34
|
+
# requested width. Several mermaid renderers size to content rather than
|
|
35
|
+
# to width (flowchart/class/state/ER/sequence/mindmap/journey), so a
|
|
36
|
+
# child mermaid block can return lines wider than its allocated content
|
|
37
|
+
# area. Truncating would corrupt the diagram; growing keeps the box's top,
|
|
37
38
|
# bottom, and side borders aligned at the same column even if it
|
|
38
39
|
# overflows the parent's allocation.
|
|
39
40
|
content_max = visual_len("")
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
"""Mermaid diagram renderer for termrender."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import re
|
|
6
|
+
|
|
7
|
+
from termrender.blocks import Block
|
|
8
|
+
from termrender.renderers import (
|
|
9
|
+
mermaid_class,
|
|
10
|
+
mermaid_er,
|
|
11
|
+
mermaid_flow,
|
|
12
|
+
mermaid_gantt,
|
|
13
|
+
mermaid_journey,
|
|
14
|
+
mermaid_mindmap,
|
|
15
|
+
mermaid_pie,
|
|
16
|
+
mermaid_sequence,
|
|
17
|
+
mermaid_state,
|
|
18
|
+
mermaid_timeline,
|
|
19
|
+
)
|
|
20
|
+
from termrender.renderers.mermaid_prelude import strip_prelude_lines
|
|
21
|
+
from termrender.style import visual_ljust
|
|
22
|
+
|
|
23
|
+
# Same box-drawing/geometric glyph ranges the native renderers (mermaid_flow,
|
|
24
|
+
# mermaid_class, mermaid_state, mermaid_er) guard their own raw-echo paths
|
|
25
|
+
# with, and the same ranges the downstream crouter viewer keys on to detect
|
|
26
|
+
# render *success*. An exotic/unrecognized diagram type has no renderer at
|
|
27
|
+
# all, so its degradation lives here rather than in a shared renderer module;
|
|
28
|
+
# it must uphold the identical contract — no such glyph survives the echo,
|
|
29
|
+
# even one present verbatim in the source itself.
|
|
30
|
+
_GLYPH_RANGE_RE = re.compile("[\u2500-\u259f\u25a0-\u25ff]")
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
def _first_line_type(source: str) -> str:
|
|
34
|
+
"""Return the lowercased first real line's leading keyword.
|
|
35
|
+
|
|
36
|
+
This is the dispatch key: mermaid identifies a diagram's type from its
|
|
37
|
+
first line (``graph``/``flowchart``, ``pie``, ``gantt``, ``sequenceDiagram``,
|
|
38
|
+
``classDiagram``, ``stateDiagram``, ``erDiagram``, …), after skipping any
|
|
39
|
+
prelude (blank lines, ``%%`` comments/directives, ``---`` YAML
|
|
40
|
+
frontmatter — see ``mermaid_prelude.py``). Returns ``""`` for a source
|
|
41
|
+
with no real content past its prelude.
|
|
42
|
+
"""
|
|
43
|
+
lines = strip_prelude_lines(source.splitlines())
|
|
44
|
+
first = next((l.strip() for l in lines if l.strip()), "")
|
|
45
|
+
return first.lower()
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
def _stripped(source: str) -> str:
|
|
49
|
+
"""Return ``source`` with its leading prelude (comments/directives/
|
|
50
|
+
frontmatter) removed, for native renderers that don't otherwise skip it.
|
|
51
|
+
"""
|
|
52
|
+
return "\n".join(strip_prelude_lines(source.splitlines()))
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
def _raw_echo(source: str) -> list[str]:
|
|
56
|
+
"""Degrade an exotic/unrecognized diagram type to its raw source lines.
|
|
57
|
+
|
|
58
|
+
No renderer exists for these types (sankey, C4, gitgraph, block, packet,
|
|
59
|
+
kanban, quadrantChart, …, and anything unrecognized): the source is
|
|
60
|
+
echoed back verbatim, with box-drawing/geometric glyphs neutralized so
|
|
61
|
+
the crouter viewer's "no glyphs survived" success check can't be fooled
|
|
62
|
+
by one present in the raw source itself — the same guarantee every
|
|
63
|
+
native renderer's own raw-echo path upholds.
|
|
64
|
+
"""
|
|
65
|
+
return [
|
|
66
|
+
_GLYPH_RANGE_RE.sub("?", line.rstrip()) for line in source.splitlines()
|
|
67
|
+
]
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
def render_mermaid_lines(source: str, width: int) -> list[str]:
|
|
71
|
+
"""Dispatch a mermaid source to its type's renderer and return raw lines.
|
|
72
|
+
|
|
73
|
+
Every diagram type mermaid supports that termrender renders has a
|
|
74
|
+
dedicated native Python renderer: ``pie``, ``gantt``, ``sequenceDiagram``,
|
|
75
|
+
``mindmap``, ``journey``, ``timeline``, ``graph``/``flowchart``,
|
|
76
|
+
``classDiagram``, ``stateDiagram``/``stateDiagram-v2``, and ``erDiagram``.
|
|
77
|
+
Any other type (sankey, C4, gitgraph, block, packet, kanban, …, or
|
|
78
|
+
anything unrecognized) degrades to a raw echo of the source with no
|
|
79
|
+
box-drawing glyphs — see :func:`_raw_echo`. Lines are returned unpadded;
|
|
80
|
+
callers apply width padding uniformly.
|
|
81
|
+
"""
|
|
82
|
+
diagram_type = _first_line_type(source)
|
|
83
|
+
if diagram_type.startswith("pie"):
|
|
84
|
+
return mermaid_pie.render(source, width)
|
|
85
|
+
if diagram_type.startswith("gantt"):
|
|
86
|
+
return mermaid_gantt.render(source, width)
|
|
87
|
+
if diagram_type.startswith("sequencediagram"):
|
|
88
|
+
return mermaid_sequence.render_sequence(source, width)
|
|
89
|
+
if diagram_type.startswith("mindmap"):
|
|
90
|
+
return mermaid_mindmap.render(_stripped(source), width)
|
|
91
|
+
if diagram_type.startswith("journey"):
|
|
92
|
+
return mermaid_journey.render(_stripped(source), width)
|
|
93
|
+
if diagram_type.startswith("timeline"):
|
|
94
|
+
return mermaid_timeline.render(_stripped(source), width)
|
|
95
|
+
if diagram_type.startswith(("graph", "flowchart")):
|
|
96
|
+
return mermaid_flow.render_flowchart(source, width)
|
|
97
|
+
if diagram_type.startswith("classdiagram"):
|
|
98
|
+
return mermaid_class.render_class(source, width)
|
|
99
|
+
if diagram_type.startswith("statediagram"):
|
|
100
|
+
return mermaid_state.render_state(source, width)
|
|
101
|
+
if diagram_type.startswith("erdiagram"):
|
|
102
|
+
return mermaid_er.render_er(source, width)
|
|
103
|
+
return _raw_echo(source)
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
def render(block: Block, color: bool) -> list[str]:
|
|
107
|
+
"""Render a mermaid diagram from pre-rendered or on-the-fly ASCII output."""
|
|
108
|
+
w = block.width
|
|
109
|
+
rendered = block.attrs.get("_rendered")
|
|
110
|
+
|
|
111
|
+
if rendered is None:
|
|
112
|
+
source = block.attrs.get("source", "")
|
|
113
|
+
raw_lines = render_mermaid_lines(source, w or 60)
|
|
114
|
+
else:
|
|
115
|
+
raw_lines = rendered.split("\n")
|
|
116
|
+
|
|
117
|
+
return [visual_ljust(raw_line, w) for raw_line in raw_lines]
|
|
@@ -70,19 +70,6 @@ Known degradations (by design, not bugs)
|
|
|
70
70
|
- ``note`` statements, `<<...>>` generic constraints beyond the ``~T~``
|
|
71
71
|
substitution, and class-diagram namespaces are not recognized — lines
|
|
72
72
|
using them are silently dropped (best-effort parsing, never raised).
|
|
73
|
-
- A relation's *source*-side marker (inheritance/composition/aggregation's
|
|
74
|
-
glyph on the "whole"/parent class) is drawn at that class's single
|
|
75
|
-
shared exit anchor for its rank-flow direction. When one class has
|
|
76
|
-
several outgoing relations that each carry a source-side marker (e.g. a
|
|
77
|
-
class that both composes one collaborator and aggregates another), all
|
|
78
|
-
of them exit through that same anchor cell and only the last-drawn
|
|
79
|
-
marker glyph survives there — topology and line routing stay correct
|
|
80
|
-
for every edge, but the specific marker glyph shown at that shared point
|
|
81
|
-
reflects only one of the colliding relations. Rare in small diagrams
|
|
82
|
-
(most classes have at most one source-marked outgoing relation);
|
|
83
|
-
accepted the same way the engine already accepts dense-graph line
|
|
84
|
-
crossings, rather than reworking shared anchor allocation across the
|
|
85
|
-
underlying flowchart engine.
|
|
86
73
|
- See ``mermaid_flow_layout.py``'s docstring for the inherited engine
|
|
87
74
|
degradations (dense-graph crossings, CJK wrap width, minimum-box-size
|
|
88
75
|
cosmetics) — this renderer's output goes through the same rasterizer and
|