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

Opt-in to markdown parser options and check all options were considered (#27623)

Browse source 
Release Notes:

- N/A
This commit is contained in:
Michael Sloan 2025-03-27 14:10:06 -06:00 • committed by GitHub
parent 1f5d57bece
commit d35f5a4197
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 35 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

41
crates/markdown/src/parser.rs
View file

@ -4,17 +4,22 @@ pub use pulldown_cmark::TagEnd as MarkdownTagEnd;
use pulldown_cmark::{Alignment, HeadingLevel, LinkType, MetadataBlockKind, Options, Parser}; use pulldown_cmark::{Alignment, HeadingLevel, LinkType, MetadataBlockKind, Options, Parser};
use std::{collections::HashSet, ops::Range}; use std::{collections::HashSet, ops::Range};
pub fn parse_markdown(text: &str) -> (Vec<(Range<usize>, MarkdownEvent)>, HashSet<SharedString>) { const PARSE_OPTIONS: Options = Options::ENABLE_TABLES
let mut options = Options::all(); .union(Options::ENABLE_FOOTNOTES)
options.remove(pulldown_cmark::Options::ENABLE_DEFINITION_LIST); .union(Options::ENABLE_STRIKETHROUGH)
options.remove(pulldown_cmark::Options::ENABLE_YAML_STYLE_METADATA_BLOCKS); .union(Options::ENABLE_TASKLISTS)
options.remove(pulldown_cmark::Options::ENABLE_MATH); .union(Options::ENABLE_SMART_PUNCTUATION)
.union(Options::ENABLE_HEADING_ATTRIBUTES)
.union(Options::ENABLE_PLUSES_DELIMITED_METADATA_BLOCKS)
.union(Options::ENABLE_OLD_FOOTNOTES)
.union(Options::ENABLE_GFM);
pub fn parse_markdown(text: &str) -> (Vec<(Range<usize>, MarkdownEvent)>, HashSet<SharedString>) {
let mut events = Vec::new(); let mut events = Vec::new();
let mut languages = HashSet::new(); let mut languages = HashSet::new();
let mut within_link = false; let mut within_link = false;
let mut within_metadata = false; let mut within_metadata = false;
for (pulldown_event, mut range) in Parser::new_ext(text, options).into_offset_iter() { for (pulldown_event, mut range) in Parser::new_ext(text, PARSE_OPTIONS).into_offset_iter() {
if within_metadata { if within_metadata {
if let pulldown_cmark::Event::End(pulldown_cmark::TagEnd::MetadataBlock { .. }) = if let pulldown_cmark::Event::End(pulldown_cmark::TagEnd::MetadataBlock { .. }) =
pulldown_event pulldown_event
@ -359,3 +364,27 @@ impl From<pulldown_cmark::Tag<'_>> for MarkdownTag {
} }
} }
} }
#[cfg(test)]
mod tests {
use super::*;
const UNWANTED_OPTIONS: Options = Options::ENABLE_YAML_STYLE_METADATA_BLOCKS
.union(Options::ENABLE_MATH)
.union(Options::ENABLE_DEFINITION_LIST);
#[test]
fn all_options_considered() {
// The purpose of this is to fail when new options are added to pulldown_cmark, so that they
// can be evaluated for inclusion.
assert_eq!(PARSE_OPTIONS.union(UNWANTED_OPTIONS), Options::all());
}
#[test]
fn wanted_and_unwanted_options_disjoint() {
assert_eq!(
PARSE_OPTIONS.intersection(UNWANTED_OPTIONS),
Options::empty()
);
}
}