Skip to content

armgit / zed

Public Imported from GitHub
0

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

Keep inline code pipes inside markdown table cells (#57744)

Ankan Misra90587dd63964
diff --git a/crates/markdown/src/markdown.rs b/crates/markdown/src/markdown.rs
index 6d37ce1c86d..8792aaca7b6 100644
--- a/crates/markdown/src/markdown.rs
+++ b/crates/markdown/src/markdown.rs
@@ -2604,6 +2604,9 @@ impl Element for MarkdownElement {
cx,
);
}
+ MarkdownEvent::SubstitutedCode(text) => {
+ self.push_markdown_code_span(&mut builder, text, range.clone(), cx);
+ }
MarkdownEvent::Html => {
let html = &parsed_markdown.source[range.clone()];
if html.starts_with("<!--") {
@@ -4712,6 +4715,33 @@ mod tests {
}
}
+ #[gpui::test]
+ fn test_escaped_pipes_in_inline_code_inside_tables(cx: &mut TestAppContext) {
+ let markdown = "\
+| Pattern | What it does |
+| --- | --- |
+| `^echo(\\s\\|$)` | command pattern |
+| `a\\|b` | alternation |
+| `(a\\|b)` | grouped alternation |
+| `a\\|\\|b` | empty middle alternative |";
+ let rendered = render_markdown(markdown, cx);
+ let text = rendered.text_for_range(0..markdown.len());
+
+ assert_eq!(
+ text,
+ "Pattern\n\
+ What it does\n\
+ ^echo(\\s|$)\n\
+ command pattern\n\
+ a|b\n\
+ alternation\n\
+ (a|b)\n\
+ grouped alternation\n\
+ a||b\n\
+ empty middle alternative"
+ );
+ }
+
#[test]
fn test_source_range_for_rendered_handles_split_chunks() {
let mappings = vec![
@@ -5087,6 +5117,21 @@ mod tests {
);
}
+ #[gpui::test]
+ fn test_code_span_link_receives_decoded_inline_code(cx: &mut TestAppContext) {
+ let source = r"| Pattern |
+| --- |
+| `a\|b` |";
+ let rendered = render_markdown_with_code_span_link(
+ source,
+ |text, _cx| (text == "a|b").then(|| "file:///tmp/a-or-b".into()),
+ cx,
+ );
+
+ assert_eq!(rendered.links.len(), 1);
+ assert_eq!(rendered.links[0].destination_url, "file:///tmp/a-or-b");
+ }
+
#[gpui::test]
fn test_code_span_link_ignores_code_when_mouse_interaction_is_prevented(
cx: &mut TestAppContext,
diff --git a/crates/markdown/src/parser.rs b/crates/markdown/src/parser.rs
index 7edc7d6693b..f70c0c69a4a 100644
--- a/crates/markdown/src/parser.rs
+++ b/crates/markdown/src/parser.rs
@@ -149,6 +149,12 @@ fn build_heading_slugs(
}
heading_text.push_str(&source[range.clone()]);
}
+ MarkdownEvent::SubstitutedCode(substituted) if inside_heading => {
+ if heading_source_start.is_none() {
+ heading_source_start = Some(range.start);
+ }
+ heading_text.push_str(substituted);
+ }
MarkdownEvent::SubstitutedText(substituted) if inside_heading => {
if heading_source_start.is_none() {
heading_source_start = Some(range.start);
@@ -236,6 +242,7 @@ pub(crate) fn parse_markdown_with_options(
let mut within_link = false;
let mut within_code_block = false;
let mut within_metadata = false;
+ 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 {
@@ -402,7 +409,10 @@ pub(crate) fn parse_markdown_with_options(
pulldown_cmark::Tag::FootnoteDefinition(label) => {
MarkdownTag::FootnoteDefinition(SharedString::from(label.to_string()))
}
- pulldown_cmark::Tag::Table(alignments) => MarkdownTag::Table(alignments),
+ pulldown_cmark::Tag::Table(alignments) => {
+ within_table = true;
+ MarkdownTag::Table(alignments)
+ }
pulldown_cmark::Tag::TableHead => MarkdownTag::TableHead,
pulldown_cmark::Tag::TableRow => MarkdownTag::TableRow,
pulldown_cmark::Tag::TableCell => MarkdownTag::TableCell,
@@ -455,6 +465,8 @@ pub(crate) fn parse_markdown_with_options(
if !parse_metadata_blocks {
continue;
}
+ } else if let pulldown_cmark::TagEnd::Table = tag {
+ within_table = false;
}
state.push_event(range, MarkdownEvent::End(tag));
}
@@ -624,11 +636,17 @@ pub(crate) fn parse_markdown_with_options(
state.push_event(range, event);
}
}
- pulldown_cmark::Event::Code(_) => {
+ pulldown_cmark::Event::Code(parsed) => {
let content_range = extract_code_content_range(&text[range.clone()]);
let content_range =
content_range.start + range.start..content_range.end + range.start;
- state.push_event(content_range, MarkdownEvent::Code)
+ let source = &text[content_range.clone()];
+ let event = if within_table && source.contains(r"\|") {
+ MarkdownEvent::SubstitutedCode(parsed.to_string())
+ } else {
+ MarkdownEvent::Code
+ };
+ state.push_event(content_range, event)
}
pulldown_cmark::Event::Html(_) => state.push_event(range, MarkdownEvent::Html),
pulldown_cmark::Event::InlineHtml(html) => {
@@ -751,6 +769,8 @@ pub enum MarkdownEvent {
SubstitutedText(String),
/// An inline code node.
Code,
+ /// An inline code node that differs from the markdown source due to escape decoding.
+ SubstitutedCode(String),
/// An HTML node.
Html,
/// An inline HTML node.
@@ -1473,6 +1493,43 @@ mod tests {
assert_eq!(extract_code_content_range(input), 0..13);
}
+ #[test]
+ fn test_inline_code_substitutes_escaped_pipes() {
+ let markdown = r"| Pattern |
+| --- |
+| `a\|b` |";
+ let parsed = parse_markdown_with_options(markdown, false, false, false);
+ let code_range = {
+ let start = markdown.find(r"a\|b").expect("inline code source");
+ start..start + r"a\|b".len()
+ };
+
+ assert!(
+ parsed
+ .events
+ .iter()
+ .any(|(range, event)| range == &code_range
+ && event == &SubstitutedCode("a|b".into())),
+ "expected escaped pipe in table inline code to render as decoded inline code: {:?}",
+ parsed.events
+ );
+ }
+
+ #[test]
+ fn test_inline_code_keeps_escaped_pipes_outside_tables() {
+ let markdown = r"`a\|b`";
+ let parsed = parse_markdown_with_options(markdown, false, false, false);
+
+ assert!(
+ parsed
+ .events
+ .iter()
+ .any(|(range, event)| range == &(1..5) && event == &Code),
+ "expected escaped pipe outside a table to remain normal inline code: {:?}",
+ parsed.events
+ );
+ }
+
#[test]
fn test_extract_code_block_content_range() {
let input = "```rust\nlet x = 5;\n```";