From f913d4f4b7adabc55f646a0d1e138b64751e1ebe Mon Sep 17 00:00:00 2001 From: Johann Hemmann Date: Tue, 9 Jan 2024 13:38:07 +0100 Subject: [PATCH 1/3] Refactor if-else --- crates/ide/src/doc_links.rs | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/crates/ide/src/doc_links.rs b/crates/ide/src/doc_links.rs index 4b0ecb9cf908..f590b14c0342 100644 --- a/crates/ide/src/doc_links.rs +++ b/crates/ide/src/doc_links.rs @@ -64,13 +64,12 @@ pub(crate) fn rewrite_links(db: &RootDatabase, markdown: &str, definition: Defin // * path-based links: `../../module/struct.MyStruct.html` // * module-based links (AKA intra-doc links): `super::super::module::MyStruct` if let Some((target, title)) = rewrite_intra_doc_link(db, definition, target, title) { - return (None, target, title); + (None, target, title) + } else if let Some(target) = rewrite_url_link(db, definition, target) { + (Some(LinkType::Inline), target, title.to_string()) + } else { + (None, target.to_string(), title.to_string()) } - if let Some(target) = rewrite_url_link(db, definition, target) { - return (Some(LinkType::Inline), target, title.to_string()); - } - - (None, target.to_string(), title.to_string()) } }); let mut out = String::new(); From bfc2e568dd862827b987ef979f4b2f04638beb7a Mon Sep 17 00:00:00 2001 From: Johann Hemmann Date: Tue, 9 Jan 2024 14:52:40 +0100 Subject: [PATCH 2/3] Add tests for intra-doc links The first one succeeds because the functionality is already implemented. The second one fails and represents the functionality to be implemented in this PR. --- crates/ide/src/doc_links/tests.rs | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/crates/ide/src/doc_links/tests.rs b/crates/ide/src/doc_links/tests.rs index e1f5ccc228b7..37da3d6514da 100644 --- a/crates/ide/src/doc_links/tests.rs +++ b/crates/ide/src/doc_links/tests.rs @@ -664,3 +664,29 @@ pub struct $0Foo; expect![["[`foo`]"]], ); } + +#[test] +fn rewrite_intra_doc_link() { + check_rewrite( + r#" + //- minicore: eq, derive + //- /main.rs crate:foo + //! $0[PartialEq] + fn main() {} + "#, + expect!["[PartialEq](https://doc.rust-lang.org/stable/core/cmp/trait.PartialEq.html)"], + ); +} + +#[test] +fn rewrite_intra_doc_link_with_anchor() { + check_rewrite( + r#" + //- minicore: eq, derive + //- /main.rs crate:foo + //! $0[PartialEq#derivable] + fn main() {} + "#, + expect!["[PartialEq#derivable](https://doc.rust-lang.org/stable/core/cmp/trait.PartialEq.html#derivable)"], + ); +} From c81728634bb9cf68f7dc74cd1a30973c19a3d00c Mon Sep 17 00:00:00 2001 From: Johann Hemmann Date: Thu, 18 Jan 2024 13:36:11 +0100 Subject: [PATCH 3/3] Handle intra-doc links with anchor --- crates/ide/src/doc_links.rs | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/crates/ide/src/doc_links.rs b/crates/ide/src/doc_links.rs index f590b14c0342..1357f426368c 100644 --- a/crates/ide/src/doc_links.rs +++ b/crates/ide/src/doc_links.rs @@ -368,16 +368,21 @@ fn rewrite_intra_doc_link( ) -> Option<(String, String)> { let (link, ns) = parse_intra_doc_link(target); + let (link, anchor) = match link.split_once('#') { + Some((new_link, anchor)) => (new_link, Some(anchor)), + None => (link, None), + }; + let resolved = resolve_doc_path_for_def(db, def, link, ns)?; let mut url = get_doc_base_urls(db, resolved, None, None).0?; - let (_, file, frag) = filename_and_frag_for_def(db, resolved)?; + let (_, file, _) = filename_and_frag_for_def(db, resolved)?; if let Some(path) = mod_path_of_def(db, resolved) { url = url.join(&path).ok()?; } url = url.join(&file).ok()?; - url.set_fragment(frag.as_deref()); + url.set_fragment(anchor); Some((url.into(), strip_prefixes_suffixes(title).to_string())) }