Only render hyperlinks for terminals known to support them (#21519)

Author: MichaReiser

Cargo.lock

@@ -173,6 +173,7 @@ snapbox = { version = "0.6.0", features = [
 static_assertions = "1.1.0"
 strum = { version = "0.27.0", features = ["strum_macros"] }
 strum_macros = { version = "0.27.0" }
+supports-hyperlinks = { version = "3.1.0" }
 syn = { version = "2.0.55" }
 tempfile = { version = "3.9.0" }
 test-case = { version = "3.3.1" }

Cargo.toml

@@ -155,6 +155,11 @@ impl Renderer {
         self
     }
 
+    pub const fn hyperlink(mut self, hyperlink: bool) -> Self {
+        self.stylesheet.hyperlink = hyperlink;
+        self
+    }
+
     /// Set the string used for when a long line is cut.
     ///
     /// The default is `...` (three `U+002E` characters).

crates/ruff_annotate_snippets/src/renderer/mod.rs

@@ -42,6 +42,7 @@ schemars = { workspace = true, optional = true }
 serde = { workspace = true, optional = true }
 serde_json = { workspace = true, optional = true }
 similar = { workspace = true }
+supports-hyperlinks = { workspace = true }
 thiserror = { workspace = true }
 tracing = { workspace = true }
 tracing-subscriber = { workspace = true, optional = true }

crates/ruff_db/Cargo.toml

@@ -49,7 +49,8 @@ impl<'a> FullRenderer<'a> {
             .help(stylesheet.help)
             .line_no(stylesheet.line_no)
             .emphasis(stylesheet.emphasis)
-            .none(stylesheet.none);
+            .none(stylesheet.none)
+            .hyperlink(stylesheet.hyperlink);
 
         for diag in diagnostics {
             let resolved = Resolved::new(self.resolver, diag, self.config);
@@ -703,52 +704,7 @@ print()
         env.show_fix_status(true);
         env.fix_applicability(Applicability::DisplayOnly);
 
-        insta::assert_snapshot!(env.render_diagnostics(&diagnostics), @r"
-        error[unused-import][*]: `os` imported but unused
-         --> notebook.ipynb:cell 1:2:8
-          |
-        1 | # cell 1
-        2 | import os
-          |        ^^
-          |
-        help: Remove unused import: `os`
-         ::: cell 1
-        1 | # cell 1
-          - import os
-
-        error[unused-import][*]: `math` imported but unused
-         --> notebook.ipynb:cell 2:2:8
-          |
-        1 | # cell 2
-        2 | import math
-          |        ^^^^
-        3 |
-        4 | print('hello world')
-          |
-        help: Remove unused import: `math`
-         ::: cell 2
-        1 | # cell 2
-          - import math
-        2 | 
-        3 | print('hello world')
-
-        error[unused-variable][*]: Local variable `x` is assigned to but never used
-         --> notebook.ipynb:cell 3:4:5
-          |
-        2 | def foo():
-        3 |     print()
-        4 |     x = 1
-          |     ^
-          |
-        help: Remove assignment to unused variable `x`
-         ::: cell 3
-        1 | # cell 3
-        2 | def foo():
-        3 |     print()
-          -     x = 1
-        4 | 
-        note: This is an unsafe fix and may change runtime behavior
-        ");
+        insta::assert_snapshot!(env.render_diagnostics(&diagnostics));
     }
 
     #[test]
@@ -768,31 +724,7 @@ print()
         }
         *fix = Fix::unsafe_edits(edits.remove(0), edits);
 
-        insta::assert_snapshot!(env.render(&diagnostic), @r"
-        error[unused-import][*]: `os` imported but unused
-         --> notebook.ipynb:cell 1:2:8
-          |
-        1 | # cell 1
-        2 | import os
-          |        ^^
-          |
-        help: Remove unused import: `os`
-         ::: cell 1
-        1 | # cell 1
-          - import os
-         ::: cell 2
-        1 | # cell 2
-          - import math
-        2 | 
-        3 | print('hello world')
-         ::: cell 3
-        1 | # cell 3
-        2 | def foo():
-        3 |     print()
-          -     x = 1
-        4 | 
-        note: This is an unsafe fix and may change runtime behavior
-        ");
+        insta::assert_snapshot!(env.render(&diagnostic));
     }
 
     /// Carriage return (`\r`) is a valid line-ending in Python, so we should normalize this to a

crates/ruff_db/src/diagnostic/render/full.rs

@@ -0,0 +1,48 @@
+---
+source: crates/ruff_db/src/diagnostic/render/full.rs
+expression: env.render_diagnostics(&diagnostics)
+---
+error[unused-import][*]: `os` imported but unused
+ --> notebook.ipynb:cell 1:2:8
+  |
+1 | # cell 1
+2 | import os
+  |        ^^
+  |
+help: Remove unused import: `os`
+ ::: cell 1
+1 | # cell 1
+  - import os
+
+error[unused-import][*]: `math` imported but unused
+ --> notebook.ipynb:cell 2:2:8
+  |
+1 | # cell 2
+2 | import math
+  |        ^^^^
+3 |
+4 | print('hello world')
+  |
+help: Remove unused import: `math`
+ ::: cell 2
+1 | # cell 2
+  - import math
+2 | 
+3 | print('hello world')
+
+error[unused-variable][*]: Local variable `x` is assigned to but never used
+ --> notebook.ipynb:cell 3:4:5
+  |
+2 | def foo():
+3 |     print()
+4 |     x = 1
+  |     ^
+  |
+help: Remove assignment to unused variable `x`
+ ::: cell 3
+1 | # cell 3
+2 | def foo():
+3 |     print()
+  -     x = 1
+4 | 
+note: This is an unsafe fix and may change runtime behavior

crates/ruff_db/src/diagnostic/render/snapshots/ruff_db__diagnostic__render__full__tests__notebook_output_with_diff.snap

@@ -0,0 +1,27 @@
+---
+source: crates/ruff_db/src/diagnostic/render/full.rs
+expression: env.render(&diagnostic)
+---
+error[unused-import][*]: `os` imported but unused
+ --> notebook.ipynb:cell 1:2:8
+  |
+1 | # cell 1
+2 | import os
+  |        ^^
+  |
+help: Remove unused import: `os`
+ ::: cell 1
+1 | # cell 1
+  - import os
+ ::: cell 2
+1 | # cell 2
+  - import math
+2 | 
+3 | print('hello world')
+ ::: cell 3
+1 | # cell 3
+2 | def foo():
+3 |     print()
+  -     x = 1
+4 | 
+note: This is an unsafe fix and may change runtime behavior

crates/ruff_db/src/diagnostic/render/snapshots/ruff_db__diagnostic__render__full__tests__notebook_output_with_diff_spanning_cells.snap

@@ -97,6 +97,8 @@ impl DiagnosticStylesheet {
     /// Default terminal styling
     pub fn styled() -> Self {
         let bright_blue = AnsiColor::BrightBlue.on_default();
+
+        let hyperlink = supports_hyperlinks::supports_hyperlinks();
         Self {
             error: AnsiColor::BrightRed.on_default().effects(Effects::BOLD),
             warning: AnsiColor::Yellow.on_default().effects(Effects::BOLD),
@@ -112,7 +114,7 @@ impl DiagnosticStylesheet {
             deletion: AnsiColor::Red.on_default(),
             insertion_line_no: AnsiColor::Green.on_default().effects(Effects::BOLD),
             deletion_line_no: AnsiColor::Red.on_default().effects(Effects::BOLD),
-            hyperlink: true,
+            hyperlink,
         }
     }