Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
markdown: Fix the `---` separators being parsed as YAML metadata blocks (#64162)
Naoki Yoshidab0d4fd203d1a
diff --git a/crates/markdown/src/parser.rs b/crates/markdown/src/parser.rsindex 0a47fb7333b..8ac2ea9df4a 100644--- a/crates/markdown/src/parser.rs+++ b/crates/markdown/src/parser.rs@@ -232,6 +232,47 @@ fn is_br_tag(html: &str) -> bool {.is_some_and(|name| name.eq_ignore_ascii_case("br"))}+fn yaml_frontmatter_candidate(text: &str) -> Option<&str> {+ let after_fence = text.strip_prefix("---")?;+ let opening_whitespace_length = after_fence+ .bytes()+ .take_while(|byte| *byte != b'\n' && byte.is_ascii_whitespace())+ .count();+ let after_opening_line = after_fence+ .get(opening_whitespace_length..)?+ .strip_prefix('\n')?;++ let first_content = after_opening_line.trim_start_matches([' ', '\t', '\u{b}', '\u{c}']);+ if first_content.is_empty() || first_content.starts_with(['\r', '\n']) {+ return None;+ }++ let mut line_start = text.len() - after_opening_line.len();+ let lines = after_opening_line.split_inclusive('\n');+ for line in lines {+ if let Some(suffix) = line+ .strip_prefix("---")+ .or_else(|| line.strip_prefix("..."))+ {+ let suffix = suffix.trim_start_matches(' ');+ let line_ending_length = if suffix.starts_with("\r\n") {+ Some(2)+ } else if suffix.starts_with(['\r', '\n']) {+ Some(1)+ } else if suffix.is_empty() {+ Some(0)+ } else {+ None+ };+ if let Some(line_ending_length) = line_ending_length {+ return text.get(..line_start + line.len() - suffix.len() + line_ending_length);+ }+ }+ line_start += line.len();+ }+ None+}+pub(crate) fn parse_markdown_with_options(text: &str,parse_html: bool,@@ -250,19 +291,41 @@ pub(crate) fn parse_markdown_with_options(let mut within_table = false;let mut current_metadata_block_start = None;let mut metadata_block_content_range: Option<Range<usize>> = None;- let parse_options = if parse_metadata_blocks {- PARSE_OPTIONS.union(Options::ENABLE_YAML_STYLE_METADATA_BLOCKS)- } else {- PARSE_OPTIONS- };- let parser = Parser::new_ext(text, parse_options);+ let mut frontmatter = Vec::new();+ if parse_metadata_blocks && let Some(candidate) = yaml_frontmatter_candidate(text) {+ let mut parser = Parser::new_ext(+ candidate,+ PARSE_OPTIONS.union(Options::ENABLE_YAML_STYLE_METADATA_BLOCKS),+ )+ .into_offset_iter()+ .peekable();+ if let Some((+ pulldown_cmark::Event::Start(pulldown_cmark::Tag::MetadataBlock(+ MetadataBlockKind::YamlStyle,+ )),+ range,+ )) = parser.peek()+ {+ let frontmatter_end = range.end;+ frontmatter.extend(parser.take_while(|(_, range)| range.start < frontmatter_end));+ }+ }+ let body_start = frontmatter.last().map_or(0, |(_, range)| range.end);+ let parser = Parser::new_ext(&text[body_start..], PARSE_OPTIONS);let mut link_definition_spans = parser.reference_definitions().iter()- .map(|(_, definition)| definition.span.clone())+ .map(|(_, definition)| definition.span.start + body_start..definition.span.end + body_start).collect::<Vec<_>>();link_definition_spans.sort_by_key(|span| span.start);- let mut parser = parser.into_offset_iter().peekable();+ let mut parser = frontmatter+ .into_iter()+ .chain(+ parser+ .into_offset_iter()+ .map(|(event, range)| (event, range.start + body_start..range.end + body_start)),+ )+ .peekable();while let Some((pulldown_event, range)) = parser.next() {if within_metadata && !parse_metadata_blocks {if let pulldown_cmark::Event::End(pulldown_cmark::TagEnd::MetadataBlock(_)) =@@ -1052,6 +1115,137 @@ mod tests {)}+ #[test]+ fn test_yaml_frontmatter_does_not_consume_body() {+ for frontmatter in [+ "",+ "---\ntitle: Post\n---\n\n",+ "---\r\ntitle: Post\r\n---\r\n\r\n",+ "---\ntitle: Post\n...\n\n",+ "--- \t\ntitle: Post\n--- \n\n",+ "---\r\ntitle: Post\r\n... \r\n\r\n",+ "---\ntitle: Post\n---\r",+ ] {+ let body = "# Café\n\n[Before][target]\n\n---\n## First section\n\n**Bold** and [inside][target].\n\n---\n## Second section\n\n[target]: https://example.com\n";+ let source = format!("{frontmatter}{body}");+ let parsed = parse_markdown_with_options(&source, false, true, true);+ assert_eq!(+ parsed.metadata_blocks.len(),+ usize::from(!frontmatter.is_empty())+ );+ assert_eq!(+ parsed+ .events+ .iter()+ .filter(|(_, event)| *event == Rule)+ .count(),+ 2+ );+ assert_eq!(+ parsed+ .events+ .iter()+ .filter(|(_, event)| matches!(event, Start(Heading { .. })))+ .count(),+ 3+ );+ assert_eq!(+ parsed+ .events+ .iter()+ .filter(|(_, event)| *event == Start(Strong))+ .count(),+ 1+ );+ assert_eq!(+ parsed+ .events+ .iter()+ .filter(|(_, event)| {+ matches!(event, Start(Link { dest_url, .. }) if dest_url.as_ref() == "https://example.com")+ })+ .count(),+ 2+ );+ assert_eq!(+ parsed+ .link_definition_spans+ .iter()+ .map(|range| &source[range.clone()])+ .collect::<Vec<_>>(),+ vec!["[target]: https://example.com"]+ );+ for (range, _) in &parsed.events {+ assert!(source.get(range.clone()).is_some());+ }+ assert_eq!(+ parsed.heading_slugs["first-section"],+ source.find("First section").expect("first section heading")+ );+ }+ }++ #[test]+ fn test_yaml_frontmatter_rejects_blank_first_content_line() {+ for blank_line in ["\n", "\r\n", " \t\n", " \t\r\n", "\u{b}\n", "\u{c}\n"] {+ let source = format!("---\n{blank_line}# Body\n\n**Bold**\n---\n");+ assert_eq!(yaml_frontmatter_candidate(&source), None, "{blank_line:?}");+ assert_eq!(+ parse_markdown_with_options(&source, false, true, true),+ parse_markdown_with_options(&source, false, true, false),+ "{blank_line:?}"+ );+ }+ }++ #[test]+ fn test_body_separators_are_not_yaml_metadata() {+ for source in [+ "# Heading\n\n---\n**Bold**",+ "# Heading\n\n> ---\n> **Bold**\n> ---\n",+ "# Heading\n\n- item\n\n ---\n **Bold**\n\n ---\n",+ "\n---\n**Bold**\n---\n",+ "",+ "--",+ "---",+ "---not metadata",+ "---\ntitle: Café\nBody with `---`",+ "---\ntitle: Post\n---\t\n# Heading",+ "---\n---\n# Heading",+ "---\n...\n# Heading",+ "---\n\nBody\n---\n# Heading",+ ] {+ assert_eq!(+ parse_markdown_with_options(source, false, false, true),+ parse_markdown_with_options(source, false, false, false),+ "{source:?}"+ );+ }+ }++ #[test]+ fn test_yaml_frontmatter_ignores_invalid_closing_fences() {+ let content = "title: Café\n----\n---not a fence\n ---\n---\t\n...\t\n";+ let source = format!("---\n{content}...\n# Body\n");+ let parsed = parse_markdown_with_options(&source, false, true, true);+ let metadata = parsed.metadata_blocks.get(&0).expect("frontmatter");+ assert_eq!(&source[metadata.content_range.clone()], content);+ assert_eq!(+ parsed.heading_slugs["body"],+ source.find("Body").expect("body heading")+ );+ }++ #[test]+ fn test_yaml_frontmatter_closing_fence_at_eof() {+ for closing_fence in ["---", "... "] {+ let source = format!("---\ntitle: Café\n{closing_fence}");+ let parsed = parse_markdown_with_options(&source, false, false, true);+ let metadata = parsed.metadata_blocks.get(&0).expect("frontmatter");+ assert_eq!(&source[metadata.content_range.clone()], "title: Café\n");+ }+ }+#[test]fn test_metadata_block_text_is_verbatim() {let parsed =