feat: Add support for hyperlinks in snippet origin

Author: scrabsha

src/renderer/render.rs

@@ -5,7 +5,7 @@ use alloc::collections::BTreeMap;
 use alloc::string::{String, ToString};
 use alloc::{format, vec, vec::Vec};
 use core::cmp::{Ordering, Reverse, max, min};
-use core::fmt;
+use core::fmt::{self, Display, Formatter};
 
 use anstyle::Style;
 
@@ -20,8 +20,8 @@ use crate::renderer::source_map::{
 use crate::renderer::styled_buffer::StyledBuffer;
 use crate::snippet::Id;
 use crate::{
-    Annotation, AnnotationKind, Element, Group, Message, Origin, Padding, Patch, Report, Snippet,
-    Title,
+    Annotation, AnnotationKind, Element, Group, Message, Origin, Padding, Patch, PathUrlFormatter,
+    Report, Snippet, Title,
 };
 
 const ANONYMIZED_LINE_NUM: &str = "LL";
@@ -271,6 +271,13 @@ fn render_short_message(renderer: &Renderer, groups: &[Group<'_>]) -> Result<Str
             let mut origin = Origin::path(path.as_ref());
 
             let source_map = SourceMap::new(&cause.source, cause.line_start);
+            if let Some(primary_span) = cause.primary_span()
+                && let Some(path_url_formatter) = &cause.url
+            {
+                let (line, byte_col) = source_map.byte_to_line_byte_col(primary_span.start);
+                let url = path_url_formatter.format_url(line, byte_col);
+                origin.url = Some(Cow::from(url));
+            }
             let (_depth, annotated_lines) =
                 source_map.annotated_lines(cause.markers.clone(), cause.fold);
 
@@ -359,9 +366,7 @@ fn render_title(
         label_width += title.level().as_str().len();
         if let Some(Id { id: Some(id), url }) = &title.id() {
             buffer.append(buffer_msg_line_offset, "[", label_style);
-            let link = Hyperlink {
-                url: url.as_deref(),
-            };
+            let link = Hyperlink::from(url.as_deref());
             buffer.append(
                 buffer_msg_line_offset,
                 &format!("{link}{id}{link:#}"),
@@ -485,6 +490,9 @@ fn render_origin(
         _ => origin.path.to_string(),
     };
 
+    let link = Hyperlink::from(origin.url.as_deref());
+    let str = format!("{link}{str}{link:#}");
+
     buffer.append(buffer_msg_line_offset, &str, ElementStyle::LineAndColumn);
     if !renderer.short_message {
         for _ in 0..max_line_num_len {
@@ -552,6 +560,15 @@ fn render_snippet_annotations(
                 }
             }
         }
+
+        if let Some(primary_span) = snippet.primary_span()
+            && let Some(url_formatter) = &snippet.url
+        {
+            let (line, byte_col) = sm.byte_to_line_byte_col(primary_span.start);
+            let url = url_formatter.format_url(line, byte_col);
+            origin.url = Some(Cow::from(url));
+        }
+
         let buffer_msg_line_offset = buffer.num_lines();
         render_origin(
             renderer,
@@ -1447,11 +1464,18 @@ fn emit_suggestion_default(
         && let Some(path) = suggestion.path.as_ref()
         && !matches_previous_suggestion
     {
-        let (loc, _) = sm.span_to_locations(parts[0].span.clone());
-        let origin = Origin::path(path.as_ref())
+        let span = parts[0].span.clone();
+        let (loc, _) = sm.span_to_locations(span.clone());
+        let mut origin = Origin::path(path.as_ref())
             .line(loc.line)
             .char_column(loc.char + 1);
 
+        if let Some(formatter) = &suggestion.url {
+            let (line, byte_col) = sm.byte_to_line_byte_col(span.start);
+            let url = formatter.format_url(line, byte_col);
+            origin.url = Some(Cow::from(url));
+        }
+
         render_origin(
             renderer,
             buffer,
@@ -2758,18 +2782,18 @@ fn newline_count(body: &str) -> usize {
     }
 }
 
-struct Hyperlink<D: fmt::Display> {
-    url: Option<D>,
+struct Hyperlink<'a> {
+    url: Option<&'a str>,
 }
 
-impl<D: fmt::Display> Default for Hyperlink<D> {
-    fn default() -> Self {
-        Self { url: None }
+impl<'a> From<Option<&'a str>> for Hyperlink<'a> {
+    fn from(url: Option<&'a str>) -> Self {
+        Hyperlink { url }
     }
 }
 
-impl<D: fmt::Display> fmt::Display for Hyperlink<D> {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+impl<'a> Display for Hyperlink<'a> {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
         let Some(url) = self.url.as_ref() else {
             return Ok(());
         };

src/renderer/source_map.rs

@@ -566,6 +566,19 @@ impl<'a> SourceMap<'a> {
             Some((buf, trimmed_patches, highlights))
         }
     }
+
+    pub(crate) fn byte_to_line_byte_col(&self, byte: usize) -> (usize, usize) {
+        let start_info = self
+            .lines
+            .iter()
+            .find(|info| byte >= info.start_byte && byte < info.end_byte)
+            .unwrap_or(self.lines.last().unwrap());
+
+        let line = start_info.line_index;
+        let byte_col = byte - start_info.start_byte;
+
+        (line, byte_col)
+    }
 }
 
 #[derive(Clone, Debug, PartialOrd, Ord, PartialEq, Eq)]