From fb252b801d9a9cde0271c2b3bca9e5776c92328e Mon Sep 17 00:00:00 2001 From: Simon Klee Date: Wed, 18 Nov 2026 11:48:52 +0100 Subject: [PATCH] refactor(cli-rs): share Mermaid's accessibility directive filter Gantt, timeline and gitGraph each kept the same block state and compiled the same two regular expressions. Share that filter after each parser strips its own comments: gitGraph honors quoted percent signs, unlike gantt and timeline. diagrams_match_typescript checks the resulting diagrams against the TS renderer. --- .../cli-rs/crates/mermaid/src/core/text.rs | 19 ++++++++++++++++++ packages/cli-rs/crates/mermaid/src/gantt.rs | 18 +++-------------- .../cli-rs/crates/mermaid/src/gitgraph.rs | 19 +++--------------- .../cli-rs/crates/mermaid/src/timeline.rs | 20 +++++-------------- 4 files changed, 30 insertions(+), 46 deletions(-) diff --git a/packages/cli-rs/crates/mermaid/src/core/text.rs b/packages/cli-rs/crates/mermaid/src/core/text.rs index 1f0fb264f73..bf64ddfa5b2 100644 --- a/packages/cli-rs/crates/mermaid/src/core/text.rs +++ b/packages/cli-rs/crates/mermaid/src/core/text.rs @@ -122,6 +122,25 @@ pub fn first_meaningful_line(content: &str) -> Option<&str> { meaningful_lines(content).next().map(|line| line.text) } +/// Accessibility directives describe the diagram but do not draw rows. A block ends on a line containing only `}`. +#[derive(Default)] +pub(crate) struct Accessibility { + in_description: bool, +} + +impl Accessibility { + pub(crate) fn skip(&mut self, line: &str) -> bool { + static DIRECTIVE: LazyLock = LazyLock::new(|| Regex::new(r"(?i)^acc(?:Title|Descr)(?::|\s|$)").unwrap()); + static BLOCK: LazyLock = LazyLock::new(|| Regex::new(r"(?i)^accDescr\s*\{$").unwrap()); + if self.in_description { + self.in_description = line != "}"; + return true; + } + self.in_description = BLOCK.is_match(line); + self.in_description || DIRECTIVE.is_match(line) + } +} + pub fn strip_quotes(value: &str) -> String { let trimmed = js_trim(value); let quoted = diff --git a/packages/cli-rs/crates/mermaid/src/gantt.rs b/packages/cli-rs/crates/mermaid/src/gantt.rs index 124a00b6ea0..ab4f40244c9 100644 --- a/packages/cli-rs/crates/mermaid/src/gantt.rs +++ b/packages/cli-rs/crates/mermaid/src/gantt.rs @@ -8,7 +8,7 @@ use regex::Regex; use crate::core::canvas::{Canvas, SizeError}; use crate::core::geometry::js_round; -use crate::core::text::{first_meaningful_line, js_trim, meaningful_lines, strip_quotes, width}; +use crate::core::text::{Accessibility, first_meaningful_line, js_trim, meaningful_lines, strip_quotes, width}; use crate::{Kind, SyntaxError}; #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] @@ -55,8 +55,6 @@ static HEADER: LazyLock = LazyLock::new(|| pattern(r"(?i)^gantt$")); static DIRECTIVE: LazyLock = LazyLock::new(|| pattern(r"(?i)^(title|dateFormat|axisFormat|tickInterval|excludes|todayMarker)\s+(.+)$")); static SECTION: LazyLock = LazyLock::new(|| pattern(r"(?i)^section(?:\s+(.+))?$")); -static ACCESSIBILITY: LazyLock = LazyLock::new(|| pattern(r"(?i)^acc(?:Title|Descr)(?::|\s|$)")); -static ACC_BLOCK: LazyLock = LazyLock::new(|| pattern(r"(?i)^accDescr\s*\{$")); static AFTER: LazyLock = LazyLock::new(|| pattern(r"(?i)^after\s+")); static DURATION: LazyLock = LazyLock::new(|| pattern(r"(?i)^(\d+(?:\.\d+)?)\s*(ms|s|m|h|d|w)$")); static CALENDAR: LazyLock = @@ -77,21 +75,11 @@ pub fn parse(content: &str) -> Result { let mut date_format = "YYYY-MM-DD".to_string(); let mut axis_format = "%Y-%m-%d".to_string(); let mut header = false; - let mut in_description = false; + let mut accessibility = Accessibility::default(); for source in meaningful_lines(content) { let line = js_trim(source.text.find("%%").map_or(source.text, |index| &source.text[..index])); let n = source.number; - if in_description { - if line == "}" { - in_description = false; - } - continue; - } - if ACC_BLOCK.is_match(line) { - in_description = true; - continue; - } - if ACCESSIBILITY.is_match(line) || line.is_empty() { + if accessibility.skip(line) || line.is_empty() { continue; } if HEADER.is_match(line) { diff --git a/packages/cli-rs/crates/mermaid/src/gitgraph.rs b/packages/cli-rs/crates/mermaid/src/gitgraph.rs index b4705d03a29..1a85f20df74 100644 --- a/packages/cli-rs/crates/mermaid/src/gitgraph.rs +++ b/packages/cli-rs/crates/mermaid/src/gitgraph.rs @@ -7,7 +7,7 @@ use indexmap::IndexMap; use regex::Regex; use crate::core::canvas::{Canvas, SizeError}; -use crate::core::text::{first_meaningful_line, js_trim, meaningful_lines, strip_quotes, width}; +use crate::core::text::{Accessibility, first_meaningful_line, js_trim, meaningful_lines, strip_quotes, width}; use crate::{Kind, SyntaxError}; #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] @@ -55,9 +55,6 @@ pub struct Diagram { static HEADER: LazyLock = LazyLock::new(|| Regex::new(r"(?i)^gitGraph(?:\s+(LR|TB|BT))?\s*:?$").expect("header")); -static ACCESSIBILITY: LazyLock = - LazyLock::new(|| Regex::new(r"(?i)^acc(?:Title|Descr)(?::|\s|$)").expect("accessibility")); -static ACC_BLOCK: LazyLock = LazyLock::new(|| Regex::new(r"(?i)^accDescr\s*\{$").expect("accDescr")); static TITLE: LazyLock = LazyLock::new(|| Regex::new(r"(?i)^title(?:\s|$)").expect("title")); pub fn is_gitgraph(content: &str) -> bool { @@ -81,22 +78,12 @@ pub fn parse(content: &str) -> Result { let mut ids: HashSet = HashSet::new(); let mut current = "main".to_string(); let mut generated = 1; - let mut in_description = false; + let mut accessibility = Accessibility::default(); let mut header = false; for source in meaningful_lines(content) { let line = strip_comment(source.text); let n = source.number; - if in_description { - if line == "}" { - in_description = false; - } - continue; - } - if ACC_BLOCK.is_match(line) { - in_description = true; - continue; - } - if line.is_empty() || ACCESSIBILITY.is_match(line) || TITLE.is_match(line) { + if line.is_empty() || accessibility.skip(line) || TITLE.is_match(line) { continue; } if HEADER.is_match(line) { diff --git a/packages/cli-rs/crates/mermaid/src/timeline.rs b/packages/cli-rs/crates/mermaid/src/timeline.rs index 5b8b5441b5d..a3231445df7 100644 --- a/packages/cli-rs/crates/mermaid/src/timeline.rs +++ b/packages/cli-rs/crates/mermaid/src/timeline.rs @@ -5,7 +5,9 @@ use std::sync::LazyLock; use regex::Regex; use crate::core::canvas::{Canvas, SizeError}; -use crate::core::text::{first_meaningful_line, js_trim, meaningful_lines, split_lines, strip_quotes, width}; +use crate::core::text::{ + Accessibility, first_meaningful_line, js_trim, meaningful_lines, split_lines, strip_quotes, width, +}; use crate::{Kind, SyntaxError}; #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] @@ -41,8 +43,6 @@ fn pattern(source: &str) -> Regex { static HEADER: LazyLock = LazyLock::new(|| pattern(r"(?i)^timeline(?:\s+(TD|LR))?$")); static TITLE: LazyLock = LazyLock::new(|| pattern(r"(?i)^title(?:\s+(.+))?$")); static SECTION: LazyLock = LazyLock::new(|| pattern(r"(?i)^section(?:\s+(.+))?$")); -static ACCESSIBILITY: LazyLock = LazyLock::new(|| pattern(r"(?i)^acc(?:Title|Descr)(?::|\s|$)")); -static ACC_BLOCK: LazyLock = LazyLock::new(|| pattern(r"(?i)^accDescr\s*\{$")); pub fn is_timeline(content: &str) -> bool { HEADER.is_match(first_meaningful_line(content).unwrap_or("")) @@ -57,21 +57,11 @@ pub fn parse(content: &str) -> Result { let mut title = None; // The index in `entries` of the period continuation lines add to. let mut current: Option = None; - let mut in_description = false; + let mut accessibility = Accessibility::default(); for source in meaningful_lines(content) { let line = js_trim(source.text.find("%%").map_or(source.text, |index| &source.text[..index])); let n = source.number; - if in_description { - if line == "}" { - in_description = false; - } - continue; - } - if ACC_BLOCK.is_match(line) { - in_description = true; - continue; - } - if line.is_empty() || line.starts_with('#') || ACCESSIBILITY.is_match(line) || HEADER.is_match(line) { + if line.is_empty() || line.starts_with('#') || accessibility.skip(line) || HEADER.is_match(line) { continue; } if let Some(captures) = TITLE.captures(line) {