feat(highlighting): implement syntax highlighting for unnamed source codes

README.md

@@ -100,7 +100,7 @@ You can derive a `Diagnostic` from any `std::error::Error` type.
 
 `thiserror` is a great way to define them, and plays nicely with `miette`!
 */
-use miette::{Diagnostic, NamedSource, SourceSpan};
+use miette::{Diagnostic, MietteSourceCode, SourceSpan};
 use thiserror::Error;
 
 #[derive(Error, Debug, Diagnostic)]
@@ -114,7 +114,7 @@ struct MyBad {
     // The Source that we're gonna be printing snippets out of.
     // This can be a String if you don't have or care about file names.
     #[source_code]
-    src: NamedSource<String>,
+    src: MietteSourceCode<String>,
     // Snippets and highlights can be included in the diagnostic!
     #[label("This bit here")]
     bad_bit: SourceSpan,
@@ -134,7 +134,7 @@ fn this_fails() -> Result<()> {
     let src = "source\n  text\n    here".to_string();
 
     Err(MyBad {
-        src: NamedSource::new("bad_file.rs", src),
+        src: MietteSourceCode::new(src).with_name("bad_file.rs"),
         bad_bit: (9, 4).into(),
     })?;
 
@@ -649,7 +649,6 @@ If you...
   [`MietteDiagnostic`] directly to create diagnostic on the fly.
 
 ```rust
-
 let source = "2 + 2 * 2 = 8".to_string();
 let report = miette!(
   labels = vec![
@@ -665,23 +664,32 @@ println!("{:?}", report)
 
 `miette` can be configured to highlight syntax in source code snippets.
 
-<!-- TODO: screenshot goes here once default Theme is decided -->
+<img src="https://raw.githubusercontent.com/zkat/miette/main/images/syntax_highlight.png"/>
 
 To use the built-in highlighting functionality, you must enable the
 `syntect-highlighter` crate feature. When this feature is enabled, `miette` will
 automatically use the [`syntect`] crate to highlight the `#[source_code]`
 field of your [`Diagnostic`].
 
-Syntax detection with [`syntect`] is handled by checking 2 methods on the [`SpanContents`] trait, in order:
-* [`language()`](SpanContents::language) - Provides the name of the language
+Syntax detection with [`syntect`] is handled by checking 2 methods on the [`SourceCode`] trait, in order:
+* [`language()`](SourceCode::language) - Provides the name of the language
   as a string. For example `"Rust"` will indicate Rust syntax highlighting.
-  You can set the language of the [`SpanContents`] produced by a
-  [`NamedSource`] via the [`with_language`](NamedSource::with_language)
+  You can set the language of a [`SourceCode`] by using a
+  [`MietteSourceCode`], via the [`with_language`](MietteSourceCode::with_language)
   method.
-* [`name()`](SpanContents::name) - In the absence of an explicitly set
+* [`name()`](SourceCode::name) - In the absence of an explicitly set
   language, the name is assumed to contain a file name or file path.
   The highlighter will check for a file extension at the end of the name and
-  try to guess the syntax from that.
+  try to guess the syntax from that. Can also be set via the
+  [`with_name`](MietteSourceCod::with_name) method.
+
+```rust
+let src = MietteSourceCode::new("fn hello(oops) -> &str { \"hello!\" }").with_language("Rust");
+let report = miette!(
+    labels = vec![LabeledSpan::at((9, 4), "this is wrong")],
+    "invalid syntax!",
+).with_source_code(src);
+```
 
 If you want to use a custom highlighter, you can provide a custom
 implementation of the [`Highlighter`](highlighters::Highlighter)

src/handlers/graphical.rs

@@ -619,7 +619,7 @@ impl GraphicalReportHandler {
             .map(|(label, st)| FancySpan::new(label.label().map(String::from), *label.inner(), st))
             .collect::<Vec<_>>();
 
-        let mut highlighter_state = self.highlighter.start_highlighter_state(&*contents);
+        let mut highlighter_state = self.highlighter.start_highlighter_state(source, &*contents);
 
         // The max number of gutter-lines that will be active at any given
         // point. We need this to figure out indentation, so we do one loop
@@ -663,7 +663,7 @@ impl GraphicalReportHandler {
             None => contents,
         };
 
-        if let Some(source_name) = primary_contents.name() {
+        if let Some(source_name) = source.name() {
             writeln!(
                 f,
                 "[{}]",

src/handlers/json.rs

@@ -159,8 +159,8 @@ impl JSONReportHandler {
     ) -> fmt::Result {
         if let Some(mut labels) = diagnostic.labels() {
             if let Some(label) = labels.next() {
-                if let Ok(span_content) = source.read_span(label.inner(), 0, 0) {
-                    let filename = span_content.name().unwrap_or_default();
+                if source.read_span(label.inner(), 0, 0).is_ok() {
+                    let filename = source.name().unwrap_or_default();
                     return write!(f, r#""filename": "{}","#, escape(filename));
                 }
             }

src/handlers/narratable.rs

@@ -227,7 +227,7 @@ impl NarratableReportHandler {
     ) -> fmt::Result {
         let (contents, lines) = self.get_lines(source, context.inner())?;
         write!(f, "Begin snippet")?;
-        if let Some(filename) = contents.name() {
+        if let Some(filename) = source.name() {
             write!(f, " for {}", filename,)?;
         }
         writeln!(

src/highlighters/blank.rs

@@ -1,6 +1,6 @@
 use owo_colors::Style;
 
-use crate::SpanContents;
+use crate::{SourceCode, SpanContents};
 
 use super::{Highlighter, HighlighterState};
 
@@ -12,7 +12,8 @@ pub struct BlankHighlighter;
 impl Highlighter for BlankHighlighter {
     fn start_highlighter_state<'h>(
         &'h self,
-        _source: &dyn SpanContents<'_>,
+        _source: &dyn SourceCode,
+        _span: &dyn SpanContents<'_>,
     ) -> Box<dyn super::HighlighterState + 'h> {
         Box::new(BlankHighlighterState)
     }

src/highlighters/mod.rs

@@ -13,7 +13,7 @@
 
 use std::{ops::Deref, sync::Arc};
 
-use crate::SpanContents;
+use crate::{SourceCode, SpanContents};
 use owo_colors::Styled;
 
 #[cfg(feature = "syntect-highlighter")]
@@ -39,7 +39,8 @@ pub trait Highlighter {
     /// responsible for the actual rendering.
     fn start_highlighter_state<'h>(
         &'h self,
-        source: &dyn SpanContents<'_>,
+        source: &dyn SourceCode,
+        span: &dyn SpanContents<'_>,
     ) -> Box<dyn HighlighterState + 'h>;
 }
 

src/highlighters/syntect.rs

@@ -15,7 +15,7 @@ use owo_colors::{Rgb, Style, Styled};
 
 use crate::{
     highlighters::{Highlighter, HighlighterState},
-    SpanContents,
+    SourceCode, SpanContents,
 };
 
 use super::BlankHighlighterState;
@@ -42,9 +42,10 @@ impl Default for SyntectHighlighter {
 impl Highlighter for SyntectHighlighter {
     fn start_highlighter_state<'h>(
         &'h self,
-        source: &dyn SpanContents<'_>,
+        source: &dyn SourceCode,
+        span: &dyn SpanContents<'_>,
     ) -> Box<dyn HighlighterState + 'h> {
-        if let Some(syntax) = self.detect_syntax(source) {
+        if let Some(syntax) = self.detect_syntax(source, span) {
             let highlighter = syntect::Highlighter::new(&self.theme);
             let parse_state = syntect::ParseState::new(syntax);
             let highlight_state =
@@ -82,26 +83,26 @@ impl SyntectHighlighter {
     }
 
     /// Determine syntect [`SyntaxReference`] to use for given [`SpanContents`].
-    fn detect_syntax(&self, contents: &dyn SpanContents<'_>) -> Option<&syntect::SyntaxReference> {
+    fn detect_syntax(
+        &self,
+        source: &dyn SourceCode,
+        span: &dyn SpanContents<'_>,
+    ) -> Option<&syntect::SyntaxReference> {
         // use language if given
-        if let Some(language) = contents.language() {
+        if let Some(language) = source.language() {
             return self.syntax_set.find_syntax_by_name(language);
         }
         // otherwise try to use any file extension provided in the name
-        if let Some(name) = contents.name() {
+        if let Some(name) = source.name() {
             if let Some(ext) = Path::new(name).extension() {
                 return self
                     .syntax_set
                     .find_syntax_by_extension(ext.to_string_lossy().as_ref());
             }
         }
         // finally, attempt to guess syntax based on first line
-        return self.syntax_set.find_syntax_by_first_line(
-            std::str::from_utf8(contents.data())
-                .ok()?
-                .split('\n')
-                .next()?,
-        );
+        self.syntax_set
+            .find_syntax_by_first_line(std::str::from_utf8(span.data()).ok()?.split('\n').next()?)
     }
 }
 

src/lib.rs

@@ -100,7 +100,7 @@
 //!
 //! `thiserror` is a great way to define them, and plays nicely with `miette`!
 //! */
-//! use miette::{Diagnostic, NamedSource, SourceSpan};
+//! use miette::{Diagnostic, MietteSourceCode, SourceSpan};
 //! use thiserror::Error;
 //!
 //! #[derive(Error, Debug, Diagnostic)]
@@ -114,7 +114,7 @@
 //!     // The Source that we're gonna be printing snippets out of.
 //!     // This can be a String if you don't have or care about file names.
 //!     #[source_code]
-//!     src: NamedSource<String>,
+//!     src: MietteSourceCode<String>,
 //!     // Snippets and highlights can be included in the diagnostic!
 //!     #[label("This bit here")]
 //!     bad_bit: SourceSpan,
@@ -134,7 +134,7 @@
 //!     let src = "source\n  text\n    here".to_string();
 //!
 //!     Err(MyBad {
-//!         src: NamedSource::new("bad_file.rs", src),
+//!         src: MietteSourceCode::new(src).with_name("bad_file.rs"),
 //!         bad_bit: (9, 4).into(),
 //!     })?;
 //!
@@ -650,7 +650,6 @@
 //!
 //! ```rust,ignore
 //! # use miette::{miette, LabeledSpan, Report};
-//!
 //! let source = "2 + 2 * 2 = 8".to_string();
 //! let report = miette!(
 //!   labels = vec![
@@ -666,23 +665,34 @@
 //!
 //! `miette` can be configured to highlight syntax in source code snippets.
 //!
-//! <!-- TODO: screenshot goes here once default Theme is decided -->
+//! <img src="https://raw.githubusercontent.com/zkat/miette/main/images/syntax_highlight.png"/>
 //!
 //! To use the built-in highlighting functionality, you must enable the
 //! `syntect-highlighter` crate feature. When this feature is enabled, `miette` will
 //! automatically use the [`syntect`] crate to highlight the `#[source_code]`
 //! field of your [`Diagnostic`].
 //!
-//! Syntax detection with [`syntect`] is handled by checking 2 methods on the [`SpanContents`] trait, in order:
-//! * [`language()`](SpanContents::language) - Provides the name of the language
+//! Syntax detection with [`syntect`] is handled by checking 2 methods on the [`SourceCode`] trait, in order:
+//! * [`language()`](SourceCode::language) - Provides the name of the language
 //!   as a string. For example `"Rust"` will indicate Rust syntax highlighting.
-//!   You can set the language of the [`SpanContents`] produced by a
-//!   [`NamedSource`] via the [`with_language`](NamedSource::with_language)
+//!   You can set the language of a [`SourceCode`] by using a
+//!   [`MietteSourceCode`], via the [`with_language`](MietteSourceCode::with_language)
 //!   method.
-//! * [`name()`](SpanContents::name) - In the absence of an explicitly set
+//! * [`name()`](SourceCode::name) - In the absence of an explicitly set
 //!   language, the name is assumed to contain a file name or file path.
 //!   The highlighter will check for a file extension at the end of the name and
-//!   try to guess the syntax from that.
+//!   try to guess the syntax from that. Can also be set via the
+//!   [`with_name`](MietteSourceCod::with_name) method.
+//!
+//! ```rust
+//! # use miette::{miette, LabeledSpan, MietteSourceCode};
+//! # use miette::Result;
+//! let src = MietteSourceCode::new("fn hello(oops) -> &str { \"hello!\" }").with_language("Rust");
+//! let report = miette!(
+//!     labels = vec![LabeledSpan::at((9, 4), "this is wrong")],
+//!     "invalid syntax!",
+//! ).with_source_code(src);
+//! ```
 //!
 //! If you want to use a custom highlighter, you can provide a custom
 //! implementation of the [`Highlighter`](highlighters::Highlighter)
@@ -781,10 +791,10 @@ pub use eyreish::*;
 pub use handler::*;
 pub use handlers::*;
 pub use miette_diagnostic::*;
-pub use named_source::*;
 #[cfg(feature = "fancy")]
 pub use panic::*;
 pub use protocol::*;
+pub use source_code::*;
 
 mod chain;
 mod diagnostic_chain;
@@ -799,8 +809,8 @@ pub mod highlighters;
 #[doc(hidden)]
 pub mod macro_helpers;
 mod miette_diagnostic;
-mod named_source;
 #[cfg(feature = "fancy")]
 mod panic;
 mod protocol;
+mod source_code;
 mod source_impls;