Skip to content

fix: ignore gitlab table of content in wikilinks #1710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mre merged 2 commits into from
May 23, 2025
Merged

fix: ignore gitlab table of content in wikilinks #1710

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
512b570
fix: ignore gitlab table of content in wikilinks
JayJayArr May 22, 2025
eb36cba
Simplify test
mre May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions lychee-lib/src/extract/markdown.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ pub(crate) fn extract_markdown(input: &str, include_verbatim: bool) -> Vec<RawUr
// Wiki URL (`[[http://example.com]]`)
LinkType::WikiLink { has_pothole: _ } => {
inside_link_block = true;
//Ignore gitlab toc notation: https://docs.gitlab.com/user/markdown/#table-of-contents
if ["_TOC_".to_string(), "TOC".to_string()].contains(&dest_url.to_string()) {
return None;
}
Comment on lines +68 to +71
Copy link
Member

@mre mre May 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure, but have you tried

if ["_TOC_", "TOC"].contains(&dest_url.as_str()) {

Would save a few allocs.

Copy link
Contributor Author

@JayJayArr JayJayArr May 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds very good!
...but is apparently not stabilized yet: rust-lang/rust#130366
Is would be possible with as_ref like

if ["_TOC_", "TOC"].contains(&dest_url.as_ref()) {

but this might break in the future: rust-lang/rust#130366 (comment)

Copy link
Member

@mre mre May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, you really did some soul-searching to dig this up. Nice research. ❤️
All good then.

Some(vec![RawUri {
text: dest_url.to_string(),
element: Some("a".to_string()),
Expand Down Expand Up @@ -421,4 +425,11 @@ $$
let uris = extract_markdown(markdown, true);
assert_eq!(uris, expected);
}

#[test]
fn test_ignore_gitlab_toc() {
let markdown = r"[[_TOC_]][TOC]";
let uris = extract_markdown(markdown, true);
assert!(uris.is_empty());
}
}