Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Support rendering strikethrough text in markdown (#8287)

Browse source 
Just noticed strikethrough text handling was not implemented for the
following:

Chat

![image](https://github.com/zed-industries/zed/assets/53836821/ddd98272-d4d4-4a94-bd79-77e967f3ca15)

Markdown Preview

![image](https://github.com/zed-industries/zed/assets/53836821/9087635c-5b89-40e6-8e4d-2785a43ef318)

Code Documentation

![image](https://github.com/zed-industries/zed/assets/53836821/5ed55c60-3e5e-4fc2-86c2-a81fac7de038)

It looks like there are three different markdown parsing/rendering
implementations, might be worth to investigate if any of these can be
combined into a single crate (looks like a lot of work though).

Release Notes:

- Added support for rendering strikethrough text in markdown elements
This commit is contained in:
Bennet Bo Fenner 2024-02-26 20:04:48 +01:00 • committed by GitHub
parent cd8ede542b
commit 43163a0154
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 187 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

47
crates/language/src/markdown.rs
View file

@ -4,8 +4,8 @@ use std::sync::Arc;
use std::{ops::Range, path::PathBuf};
use crate::{HighlightId, Language, LanguageRegistry};
use gpui::{px, FontStyle, FontWeight, HighlightStyle, UnderlineStyle};
use pulldown_cmark::{CodeBlockKind, Event, Options, Parser, Tag};
use gpui::{px, FontStyle, FontWeight, HighlightStyle, StrikethroughStyle, UnderlineStyle};
use pulldown_cmark::{CodeBlockKind, Event, Options, Parser, Tag, TagEnd};
/// Parsed Markdown content.
#[derive(Debug, Clone)]
@ -47,6 +47,13 @@ impl MarkdownHighlight {
});
}
if style.strikethrough {
highlight.strikethrough = Some(StrikethroughStyle {
thickness: px(1.),
..Default::default()
});
}
if style.weight != FontWeight::default() {
highlight.font_weight = Some(style.weight);
}
@ -66,6 +73,8 @@ pub struct MarkdownHighlightStyle {
pub italic: bool,
/// Whether the text should be underlined.
pub underline: bool,
/// Whether the text should be struck through.
pub strikethrough: bool,
/// The weight of the text.
pub weight: FontWeight,
}
@ -151,6 +160,7 @@ pub async fn parse_markdown_block(
) {
let mut bold_depth = 0;
let mut italic_depth = 0;
let mut strikethrough_depth = 0;
let mut link_url = None;
let mut current_language = None;
let mut list_stack = Vec::new();
@ -174,6 +184,10 @@ pub async fn parse_markdown_block(
style.italic = true;
}
if strikethrough_depth > 0 {
style.strikethrough = true;
}
if let Some(link) = link_url.clone().and_then(|u| Link::identify(u)) {
region_ranges.push(prev_len..text.len());
regions.push(ParsedRegion {
@ -221,7 +235,12 @@ pub async fn parse_markdown_block(
Event::Start(tag) => match tag {
Tag::Paragraph => new_paragraph(text, &mut list_stack),
Tag::Heading(_, _, _) => {
Tag::Heading {
level: _,
id: _,
classes: _,
attrs: _,
} => {
new_paragraph(text, &mut list_stack);
bold_depth += 1;
}
@ -242,7 +261,14 @@ pub async fn parse_markdown_block(
Tag::Strong => bold_depth += 1,
Tag::Link(_, url, _) => link_url = Some(url.to_string()),
Tag::Strikethrough => strikethrough_depth += 1,
Tag::Link {
link_type: _,
dest_url,
title: _,
id: _,
} => link_url = Some(dest_url.to_string()),
Tag::List(number) => {
list_stack.push((number, false));
@ -272,12 +298,13 @@ pub async fn parse_markdown_block(
},
Event::End(tag) => match tag {
Tag::Heading(_, _, _) => bold_depth -= 1,
Tag::CodeBlock(_) => current_language = None,
Tag::Emphasis => italic_depth -= 1,
Tag::Strong => bold_depth -= 1,
Tag::Link(_, _, _) => link_url = None,
Tag::List(_) => drop(list_stack.pop()),
TagEnd::Heading(_) => bold_depth -= 1,
TagEnd::CodeBlock => current_language = None,
TagEnd::Emphasis => italic_depth -= 1,
TagEnd::Strong => bold_depth -= 1,
TagEnd::Strikethrough => strikethrough_depth -= 1,
TagEnd::Link => link_url = None,
TagEnd::List(_) => drop(list_stack.pop()),
_ => {}
},