[link-forever] rewrite absolute paths to relative paths

+10 -6

crates/mdbookkit/src/bin/link_forever/diagnostic.rs

··· 74 74 let label = match &self.link.status { 75 75 LinkStatus::Ignored => None, 76 76 LinkStatus::Published => None, 77 + LinkStatus::Rewritten => self.format_link().into_owned().pipe(Some), 77 78 LinkStatus::Permalink => self.format_link().into_owned().pipe(Some), 78 79 LinkStatus::External => { 79 80 format!("file is outside source control: {}", self.format_link()).pipe(Some) ··· 120 121 match self { 121 122 Self::Ignored => log::Level::Debug, 122 123 Self::Published => log::Level::Debug, 124 + Self::Rewritten => log::Level::Info, 123 125 Self::Permalink => log::Level::Info, 124 126 Self::External => log::Level::Warn, 125 127 Self::NoSuchPath => log::Level::Warn, ··· 134 136 let message = match self { 135 137 LinkStatus::Ignored => "url ignored", 136 138 LinkStatus::Published => "file under src/", 139 + LinkStatus::Rewritten => "path converted to relative path", 137 140 LinkStatus::Permalink => "path converted to permalink", 138 141 LinkStatus::External => "file outside source control", 139 142 LinkStatus::NoSuchPath => "file not found", ··· 167 170 impl LinkStatus { 168 171 fn order(&self) -> usize { 169 172 match self { 170 - Self::Ignored => 0, 173 + Self::Error(..) => 7, 174 + Self::NoSuchFragment => 6, 175 + Self::NoSuchPath => 5, 176 + Self::External => 4, 177 + Self::Permalink => 3, 178 + Self::Rewritten => 2, 171 179 Self::Published => 1, 172 - Self::Permalink => 2, 173 - Self::External => 3, 174 - Self::NoSuchPath => 4, 175 - Self::NoSuchFragment => 5, 176 - Self::Error(..) => 6, 180 + Self::Ignored => 0, 177 181 } 178 182 } 179 183 }

+41 -26

crates/mdbookkit/src/bin/link_forever/mod.rs

··· 50 50 .iter_mut() 51 51 .flat_map(|(base, page)| page.rel_links.iter_mut().map(move |link| (base, link))) 52 52 { 53 - let url = if link.link.starts_with('/') { 53 + let file = if link.link.starts_with('/') { 54 54 self.vcs_root.join(&link.link[1..]) 55 55 } else { 56 56 base.join(&link.link) ··· 58 58 .context("couldn't derive url") 59 59 .tap_err(log_debug!()); 60 60 61 - let Ok(url) = url else { 61 + let Ok(file_url) = file else { 62 62 link.status = LinkStatus::Ignored; 63 63 continue; 64 64 }; 65 65 66 66 let env = self; 67 + let page_url = base.as_ref(); 67 68 let fragments = &fragments; 68 69 69 70 Resolver { 70 71 link, 71 - url, 72 + page_url, 73 + file_url, 72 74 env, 73 75 fragments, 74 76 } ··· 95 97 96 98 #[must_use] 97 99 struct Resolver<'a, 'r> { 98 - url: Url, 100 + file_url: Url, 101 + page_url: &'a Url, 99 102 link: &'a mut RelativeLink<'r>, 100 103 env: &'a Environment, 101 104 fragments: &'a Fragments, ··· 103 106 104 107 impl Resolver<'_, '_> { 105 108 fn resolve(self) { 106 - if self.url.scheme() == "file" { 109 + if self.file_url.scheme() == "file" { 107 110 self.resolve_file() 108 111 } else if let Some(book) = &self.env.config.book_url { 109 - if let Some(page) = book.0.make_relative(&self.url) { 112 + if let Some(page) = book.0.make_relative(&self.file_url) { 110 113 self.resolve_page(page); 111 114 } else { 112 115 self.link.status = LinkStatus::Ignored; ··· 119 122 fn resolve_file(self) { 120 123 let Self { 121 124 link, 122 - url, 125 + page_url, 126 + file_url, 123 127 env, 124 128 fragments, 125 129 } = self; 126 130 127 - let Ok(path) = url.to_file_path() else { 131 + let Ok(path) = file_url.to_file_path() else { 128 132 link.status = LinkStatus::Ignored; 129 133 return; 130 134 }; ··· 141 145 142 146 let Ok(rel) = env 143 147 .book_src 144 - .make_relative(&url) 148 + .make_relative(&file_url) 145 149 .context("url is from a different origin") 146 150 .tap_err(log_debug!()) 147 151 else { ··· 152 156 .config 153 157 .always_link 154 158 .iter() 155 - .any(|suffix| url.path().ends_with(suffix)); 159 + .any(|suffix| file_url.path().ends_with(suffix)); 156 160 157 - if !rel.starts_with("../") && !always_link { 158 - link.status = LinkStatus::Published; 161 + if !always_link && !rel.starts_with("../") { 162 + if link.link.starts_with('/') { 163 + // mdbook doesn't support absolute paths like VS Code does 164 + link.link = page_url.make_relative(&file_url).unwrap().into(); 165 + link.status = LinkStatus::Rewritten 166 + } else { 167 + link.status = LinkStatus::Published; 168 + } 159 169 Self { 160 170 link, 161 - url, 171 + page_url, 172 + file_url, 162 173 env, 163 174 fragments, 164 175 } ··· 168 179 169 180 let Ok(rel) = env 170 181 .vcs_root 171 - .make_relative(&url) 182 + .make_relative(&file_url) 172 183 .context("url is from a different origin") 173 184 .tap_err(log_debug!()) 174 185 else { ··· 191 202 192 203 fn resolve_page(self, page: String) { 193 204 let Self { 194 - url, 205 + file_url, 206 + page_url, 195 207 link, 196 208 env, 197 209 fragments, ··· 236 248 .tap_err(log_debug!()); 237 249 238 250 if matches!(exists, Ok(true)) { 239 - let url = { 251 + let file_url = { 240 252 let mut file = file; 241 - file.set_query(url.query()); 242 - file.set_fragment(url.fragment()); 253 + file.set_query(file_url.query()); 254 + file.set_fragment(file_url.fragment()); 243 255 file 244 256 }; 245 257 246 - link.link = url.to_string().into(); 258 + link.link = file_url.to_string().into(); 247 259 link.status = LinkStatus::Published; 248 260 249 261 Self { 250 262 link, 251 - url, 263 + page_url, 264 + file_url, 252 265 env, 253 266 fragments, 254 267 } ··· 266 279 267 280 fn resolve_fragment(self) { 268 281 let Self { 282 + mut file_url, 269 283 link, 270 - mut url, 271 284 fragments, 272 285 .. 273 286 } = self; 274 287 275 - let Some(fragment) = url 288 + let Some(fragment) = file_url 276 289 .fragment() 277 290 .and_then(|f| percent_decode_str(f).decode_utf8().ok().or(Some(f.into()))) 278 291 .map(|f| f.into_owned()) ··· 280 293 return; 281 294 }; 282 295 283 - url.set_fragment(None); 296 + file_url.set_fragment(None); 284 297 285 298 let found = fragments 286 299 .0 287 - .get(&url) 300 + .get(&file_url) 288 301 .map(|f| f.contains(&fragment)) 289 302 .unwrap_or(false); 290 303 291 - url.set_fragment(Some(&fragment)); 304 + file_url.set_fragment(Some(&fragment)); 292 305 293 306 if !found { 294 307 link.status = LinkStatus::NoSuchFragment; ··· 323 336 Ignored, 324 337 /// Link to a file under src/ 325 338 Published, 339 + /// Link to a file under src/ but was rewritten 340 + Rewritten, 326 341 /// Link to a file under source control 327 342 Permalink, 328 343 /// Link to a file outside source control ··· 483 498 self.rel_links 484 499 .iter() 485 500 .filter_map(|link| { 486 - if !matches!(link.status, LinkStatus::Permalink) { 501 + if !matches!(link.status, LinkStatus::Permalink | LinkStatus::Rewritten) { 487 502 return None; 488 503 } 489 504 let start = match link.usage {

+7

crates/mdbookkit/src/lib.rs

··· 1 + //! Toolkit for [`mdbook`]. 2 + //! 3 + //! This is the lib documentation. If you are looking for the mdBook [preprocessors] 4 + //! that this crate provides, visit <https://tonywu6.github.io/mdbookkit/> instead. 5 + //! 6 + //! [preprocessors]: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html 7 + 1 8 #[cfg(feature = "common-logger")] 2 9 pub mod diagnostics; 3 10 pub mod env;

+2

crates/mdbookkit/tests/snaps/link_forever/link-forever.snap

··· 14 14 15 15 [LICENSE-APACHE.md](https://github.com/lorem/ipsum/tree/dolor/LICENSE-APACHE.md) 16 16 17 + [link-forever.md](#absolute-paths) 18 + 17 19 # book files 18 20 19 21 [Known quirks](./ra-known-quirks.md)

+67 -58

crates/mdbookkit/tests/snaps/link_forever/link-forever.stderr.snap

··· 3 3 expression: report 4 4 --- 5 5 info: url ignored 6 - ╭─[crates/mdbookkit/tests/tests/link-forever.md:21:1] 7 - 20 │ 8 - 21 │ <https://commons.wikimedia.org/wiki/File:Macaca_nigra_self-portrait_large.jpg> 9 - · ────────────────────────────────────────────────────────────────────────────── 6 + ╭─[crates/mdbookkit/tests/tests/link-forever.md:23:1] 10 7 22 │ 8 + 23 │ <https://commons.wikimedia.org/wiki/File:Macaca_nigra_self-portrait_large.jpg> 9 + · ────────────────────────────────────────────────────────────────────────────── 10 + 24 │ 11 11 ╰──── 12 - ╭─[crates/mdbookkit/tests/tests/link-forever.md:47:13] 13 - 46 │ 14 - 47 │ ## heading: <https://räksmörgås.josefsson.org/> 15 - · ─────────────────────────────────── 12 + ╭─[crates/mdbookkit/tests/tests/link-forever.md:49:13] 16 13 48 │ 17 - 49 │ # canonical urls 14 + 49 │ ## heading: <https://räksmörgås.josefsson.org/> 15 + · ─────────────────────────────────── 18 16 50 │ 19 - 51 │ found: <https://example.org/book/tests/ra-known-quirks> 17 + 51 │ # canonical urls 20 18 52 │ 21 - 53 │ found: <https://example.org/book/tests/ra-known-quirks.html> 19 + 53 │ found: <https://example.org/book/tests/ra-known-quirks> 22 20 54 │ 23 - 55 │ missing: <https://example.org/book/404> 21 + 55 │ found: <https://example.org/book/tests/ra-known-quirks.html> 24 22 56 │ 25 - 57 │ ignored: <https://example.com/book/ra-known-quirks> 23 + 57 │ missing: <https://example.org/book/404> 24 + 58 │ 25 + 59 │ ignored: <https://example.com/book/ra-known-quirks> 26 26 · ────────────────────────────────────────── 27 27 ╰──── 28 28 29 29 info: file under src/ 30 - ╭─[crates/mdbookkit/tests/tests/link-forever.md:15:1] 31 - 14 │ 32 - 15 │ [Known quirks](./ra-known-quirks.md) 30 + ╭─[crates/mdbookkit/tests/tests/link-forever.md:17:1] 31 + 16 │ 32 + 17 │ [Known quirks](./ra-known-quirks.md) 33 33 · ──────────────────────────────────── 34 - 16 │ 35 - 17 │ [link_forever.rs](../link_forever.rs) 36 - · ───────────────────────────────────── 37 34 18 │ 38 - 19 │ ![selfie](Macaca_nigra_self-portrait_large.jpg) 39 - · ─────────────────────────────────────────────── 35 + 19 │ [link_forever.rs](../link_forever.rs) 36 + · ───────────────────────────────────── 40 37 20 │ 41 - 21 │ <https://commons.wikimedia.org/wiki/File:Macaca_nigra_self-portrait_large.jpg> 38 + 21 │ ![selfie](Macaca_nigra_self-portrait_large.jpg) 39 + · ─────────────────────────────────────────────── 42 40 22 │ 43 - 23 │ # fragments 41 + 23 │ <https://commons.wikimedia.org/wiki/File:Macaca_nigra_self-portrait_large.jpg> 44 42 24 │ 45 - 25 │ [Fragments](./link-forever.md#fragments) 43 + 25 │ # fragments 44 + 26 │ 45 + 27 │ [Fragments](./link-forever.md#fragments) 46 46 · ──────────────────────────────────────── 47 - 26 │ 48 - 27 │ [Heading 1](./link-forever.md#heading-sqrt3x-11x2) 49 - · ────────────────────────────────────────────────── 50 47 28 │ 51 - 29 │ [Heading 2](./link-forever.md#heading-httpsräksmörgåsjosefssonorg) 48 + 29 │ [Heading 1](./link-forever.md#heading-sqrt3x-11x2) 49 + · ────────────────────────────────────────────────── 50 + 30 │ 51 + 31 │ [Heading 2](./link-forever.md#heading-httpsräksmörgåsjosefssonorg) 52 52 · ────────────────────────────────────────────────────────────────── 53 - 30 │ 54 - 31 │ [macro_export](./ra-known-quirks.md#macro_export) 53 + 32 │ 54 + 33 │ [macro_export](./ra-known-quirks.md#macro_export) 55 55 · ───────────────────────────────────────────────── 56 - 32 │ 56 + 34 │ 57 57 ╰──── 58 - ╭─[crates/mdbookkit/tests/tests/link-forever.md:51:8] 59 - 50 │ 60 - 51 │ found: <https://example.org/book/tests/ra-known-quirks> 61 - · ──────────────────────────────────────────────── 58 + ╭─[crates/mdbookkit/tests/tests/link-forever.md:53:8] 62 59 52 │ 63 - 53 │ found: <https://example.org/book/tests/ra-known-quirks.html> 60 + 53 │ found: <https://example.org/book/tests/ra-known-quirks> 61 + · ──────────────────────────────────────────────── 62 + 54 │ 63 + 55 │ found: <https://example.org/book/tests/ra-known-quirks.html> 64 64 · ───────────────────────────────────────────────────── 65 - 54 │ 65 + 56 │ 66 + ╰──── 67 + 68 + info: path converted to relative path 69 + ╭─[crates/mdbookkit/tests/tests/link-forever.md:13:1] 70 + 12 │ 71 + 13 │ [link-forever.md](/crates/mdbookkit/tests/tests/link-forever.md#absolute-paths) 72 + · ───────────────────────────────────────┬─────────────────────────────────────── 73 + · ╰── crates/mdbookkit/tests/tests/link-forever.md 74 + 14 │ 66 75 ╰──── 67 76 68 77 info: path converted to permalink ··· 89 98 ╰──── 90 99 91 100 warning: file not found 92 - ╭─[crates/mdbookkit/tests/tests/link-forever.md:35:1] 93 - 34 │ 94 - 35 │ [Cargo.lock](../../Cargo.lock) 101 + ╭─[crates/mdbookkit/tests/tests/link-forever.md:37:1] 102 + 36 │ 103 + 37 │ [Cargo.lock](../../Cargo.lock) 95 104 · ───────────────┬────────────── 96 105 · ╰── file does not exist at path: crates/mdbookkit/Cargo.lock 97 - 36 │ 98 - 37 │ [`//LICENSE-MIT.md`](//LICENSE-MIT.md) 106 + 38 │ 107 + 39 │ [`//LICENSE-MIT.md`](//LICENSE-MIT.md) 99 108 · ───────────────────┬────────────────── 100 109 · ╰── file does not exist at path: //LICENSE-MIT.md 101 - 38 │ 102 - 39 │ ![shinjuku.jpg](shinjuku.jpg) 110 + 40 │ 111 + 41 │ ![shinjuku.jpg](shinjuku.jpg) 103 112 · ──────────────┬────────────── 104 113 · ╰── file does not exist at path: crates/mdbookkit/tests/tests/shinjuku.jpg 105 - 40 │ 106 - 41 │ # fragment not found 107 114 42 │ 108 - 43 │ [associated items](../tests/ra-known-quirks.md#associated_items_on_primitive_types) 115 + 43 │ # fragment not found 109 116 44 │ 110 - 45 │ ## heading: $\sqrt{3x-1}+(1+x)^2$ 117 + 45 │ [associated items](../tests/ra-known-quirks.md#associated_items_on_primitive_types) 111 118 46 │ 112 - 47 │ ## heading: <https://räksmörgås.josefsson.org/> 119 + 47 │ ## heading: $\sqrt{3x-1}+(1+x)^2$ 113 120 48 │ 114 - 49 │ # canonical urls 121 + 49 │ ## heading: <https://räksmörgås.josefsson.org/> 115 122 50 │ 116 - 51 │ found: <https://example.org/book/tests/ra-known-quirks> 123 + 51 │ # canonical urls 117 124 52 │ 118 - 53 │ found: <https://example.org/book/tests/ra-known-quirks.html> 125 + 53 │ found: <https://example.org/book/tests/ra-known-quirks> 119 126 54 │ 120 - 55 │ missing: <https://example.org/book/404> 127 + 55 │ found: <https://example.org/book/tests/ra-known-quirks.html> 128 + 56 │ 129 + 57 │ missing: <https://example.org/book/404> 121 130 · ───────────────┬────────────── 122 131 · ╰── file does not exist at path: crates/mdbookkit/tests/404.md 123 - 56 │ 132 + 58 │ 124 133 ╰──── 125 134 126 135 warning: no such fragment 127 - ╭─[crates/mdbookkit/tests/tests/link-forever.md:43:1] 128 - 42 │ 129 - 43 │ [associated items](../tests/ra-known-quirks.md#associated_items_on_primitive_types) 136 + ╭─[crates/mdbookkit/tests/tests/link-forever.md:45:1] 137 + 44 │ 138 + 45 │ [associated items](../tests/ra-known-quirks.md#associated_items_on_primitive_types) 130 139 · ─────────────────────────────────────────┬───────────────────────────────────────── 131 140 · ╰── #associated_items_on_primitive_types not found in crates/mdbookkit/tests/tests/ra-known-quirks.md 132 - 44 │ 141 + 46 │ 133 142 ╰────

+2

crates/mdbookkit/tests/tests/link-forever.md

··· 10 10 11 11 [LICENSE-APACHE.md](/LICENSE-APACHE.md) 12 12 13 + [link-forever.md](/crates/mdbookkit/tests/tests/link-forever.md#absolute-paths) 14 + 13 15 # book files 14 16 15 17 [Known quirks](./ra-known-quirks.md)

+1 -1

docs/book.toml

··· 8 8 [build] 9 9 build-dir = "dist" 10 10 create-missing = false 11 - extra-watch-dirs = ["app", "../crates/mdbookkit"] 11 + extra-watch-dirs = ["app"] 12 12 13 13 [rust] 14 14 edition = "2021"

+4

docs/src/link-forever/working-with-include.md

··· 75 75 76 76 </figure> 77 77 78 + > [!NOTE] 79 + > 80 + > `book-url` only enables validation, and is only for links to your book, not to GitHub. 81 + 78 82  79 83 80 84 [mdbook-include]: https://rust-lang.github.io/mdBook/format/mdbook.html#including-files

Configure Feed

Configure Feed