Add OSC 8 link support to filepath in headers

Author: bemyak

src/display/inline.rs

@@ -65,10 +65,18 @@ pub(crate) fn print(
     let opposite_to_rhs = opposite_positions(rhs_mps);
 
     for (i, hunk) in hunks.iter().enumerate() {
+        let first_line = hunk
+            .novel_lhs
+            .iter()
+            .min()
+            .or_else(|| hunk.novel_rhs.iter().min())
+            .copied();
+
         println!(
             "{}",
             style::header(
                 display_path,
+                first_line,
                 extra_info.as_ref(),
                 i + 1,
                 hunks.len(),

src/display/side_by_side.rs

@@ -90,6 +90,7 @@ fn display_single_column(
     let mut header_line = String::new();
     header_line.push_str(&style::header(
         display_path,
+        Some(0.into()),
         old_path,
         1,
         1,
@@ -598,10 +599,18 @@ pub(crate) fn print(
     );
 
     for (i, hunk) in hunks.iter().enumerate() {
+        let first_line = hunk
+            .novel_lhs
+            .iter()
+            .min()
+            .or_else(|| hunk.novel_rhs.iter().min())
+            .copied();
+
         println!(
             "{}",
             style::header(
                 display_path,
+                first_line,
                 old_path,
                 i + 1,
                 hunks.len(),

src/display/style.rs

@@ -1,7 +1,9 @@
 //! Apply colours and styling to strings.
 
 use std::cmp::{max, min};
+use std::path::Path;
 
+use crossterm::tty::IsTty;
 use line_numbers::{LineNumber, SingleLineSpan};
 use owo_colors::{OwoColorize, Style};
 use unicode_width::{UnicodeWidthChar, UnicodeWidthStr};
@@ -13,6 +15,12 @@ use crate::options::DisplayOptions;
 use crate::parse::syntax::{AtomKind, MatchKind, MatchedPos, StringKind, TokenKind};
 use crate::summary::FileFormat;
 
+// OSC 8 hyperlink escape sequences
+// See: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
+const OSC_8_START: &str = "\x1b]8;;";
+const OSC_8_ST: &str = "\x1b\\";
+const OSC_8_END: &str = "\x1b]8;;\x1b\\";
+
 #[derive(Clone, Copy, Debug)]
 pub(crate) enum BackgroundColor {
     Dark,
@@ -536,8 +544,27 @@ pub(crate) fn apply_line_number_color(
     }
 }
 
+fn make_path_hyperlink(display_path: &str, line_number: Option<LineNumber>) -> String {
+    if !std::io::stdout().is_tty() {
+        return display_path.to_owned();
+    }
+
+    let path = Path::new(display_path);
+
+    let Ok(canonical_path) = path.canonicalize() else {
+        return display_path.to_owned();
+    };
+
+    let mut url = format!("file://{}", canonical_path.display());
+    if let Some(line_num) = line_number {
+        url.push_str(&format!(":{}", line_num.0 + 1));
+    }
+    format!("{OSC_8_START}{url}{OSC_8_ST}{display_path}{OSC_8_END}")
+}
+
 pub(crate) fn header(
     display_path: &str,
+    first_line_number: Option<LineNumber>,
     extra_info: Option<&String>,
     hunk_num: usize,
     hunk_total: usize,
@@ -551,7 +578,7 @@ pub(crate) fn header(
     };
 
     let display_path_pretty = apply_header_color(
-        display_path,
+        &make_path_hyperlink(display_path, first_line_number),
         display_options.use_color,
         display_options.background_color,
         hunk_num,

src/main.rs

@@ -884,6 +884,7 @@ fn print_diff_result(display_options: &DisplayOptions, summary: &DiffResult) {
                         "{}",
                         display::style::header(
                             &summary.display_path,
+                            None,
                             summary.extra_info.as_ref(),
                             1,
                             1,
@@ -911,6 +912,7 @@ fn print_diff_result(display_options: &DisplayOptions, summary: &DiffResult) {
                     "{}",
                     display::style::header(
                         &summary.display_path,
+                        None,
                         summary.extra_info.as_ref(),
                         1,
                         1,
@@ -966,6 +968,7 @@ fn print_diff_result(display_options: &DisplayOptions, summary: &DiffResult) {
                     "{}",
                     display::style::header(
                         &summary.display_path,
+                        None,
                         summary.extra_info.as_ref(),
                         1,
                         1,
@@ -1014,6 +1017,7 @@ fn print_diff_result(display_options: &DisplayOptions, summary: &DiffResult) {
                 "{}",
                 display::style::header(
                     &summary.display_path,
+                    None,
                     summary.extra_info.as_ref(),
                     1,
                     1,