commit	f8f0e2d628a925cb11a0c96760fd69d82216690b	[log] [tgz]
author	Wei Li <[email protected]>	Tue Jul 30 02:51:04 2024 +0000
committer	Automerger Merge Worker <[email protected]>	Tue Jul 30 02:51:04 2024 +0000
tree	59abcbfffe4bc61813aa6859ccb6533238889cfd
parent	edfce89105925e12113261ae4f4299ebf833aa39 [diff]
parent	855a1cba7cf6321a2124f9cf9dfddb435b0eedfe [diff]

tree: 59abcbfffe4bc61813aa6859ccb6533238889cfd

README.md

annotate-snippets

annotate-snippets is a Rust library for annotation of programming code slices.

The library helps visualize meta information annotating source code slices. It takes a data structure called Snippet on the input and produces a String which may look like this:

error[E0308]: mismatched types
  --> src/format.rs:52:1
   |
51 |   ) -> Option<String> {
   |        -------------- expected `Option<String>` because of return type
52 | /     for ann in annotations {
53 | |         match (ann.range.0, ann.range.1) {
54 | |             (None, None) => continue,
55 | |             (Some(start), Some(end)) if start > end_index => continue,
...  |
71 | |         }
72 | |     }
   | |_____^ expected enum `std::option::Option`, found ()

Documentation

Usage

use annotate_snippets::{
    display_list::{DisplayList, FormatOptions},
    snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation},
};

fn main() {
    let snippet = Snippet {
        title: Some(Annotation {
            label: Some("expected type, found `22`"),
            id: None,
            annotation_type: AnnotationType::Error,
        }),
        footer: vec![],
        slices: vec![Slice {
            source: r#"                annotations: vec![SourceAnnotation {
                label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
                    ,
                range: <22, 25>,"#,
            line_start: 26,
            origin: Some("examples/footer.rs"),
            fold: true,
            annotations: vec![
                SourceAnnotation {
                    label: "",
                    annotation_type: AnnotationType::Error,
                    range: (187, 189),
                },
                SourceAnnotation {
                    label: "while parsing this struct",
                    annotation_type: AnnotationType::Info,
                    range: (34, 50),
                },
            ],
        }],
        opt: FormatOptions {
            color: true,
            ..Default::default()
        },
    };

    let dl = DisplayList::from(snippet);
    println!("{}", dl);
}

Local Development

cargo build
cargo test

When submitting a PR please use cargo fmt (nightly).