Merge pull request #93 from epage/readme

docs: Shift example code from README to lib.rs

Author: Muscraft

Cargo.lock

@@ -29,11 +29,12 @@ itertools = "0.12.1"
 unicode-width = "0.1.11"
 
 [dev-dependencies]
+anstream = "0.6.13"
 criterion = "0.5.1"
 difference = "2.0.0"
 glob = "0.3.1"
 serde = { version = "1.0.197", features = ["derive"] }
-snapbox = { version = "0.5.8", features = ["diff", "harness", "path", "term-svg"] }
+snapbox = { version = "0.5.8", features = ["diff", "harness", "path", "term-svg", "cmd", "examples"] }
 toml = "0.5.11"
 
 [[bench]]

Cargo.toml

@@ -3,73 +3,14 @@
 `annotate-snippets` is a Rust library for annotation of programming code slices.
 
 [![crates.io](https://img.shields.io/crates/v/annotate-snippets.svg)](https://crates.io/crates/annotate-snippets)
+[![documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
 ![build status](https://github.com/rust-lang/annotate-snippets-rs/actions/workflows/ci.yml/badge.svg)
 
 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:
 
-```text
-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][]
-
-[Documentation]: https://docs.rs/annotate-snippets/
-
-Usage
------
-
-```rust
-use annotate_snippets::{Annotation, AnnotationType, Renderer, 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: (193, 195),
-                },
-                SourceAnnotation {
-                    label: "while parsing this struct",
-                    annotation_type: AnnotationType::Info,
-                    range: (34, 50),
-                },
-            ],
-        }],
-    };
-
-    let renderer = Renderer::plain();
-    println!("{}", renderer.render(snippet));
-}
-```
+![Screenshot](./examples/expected_type.svg)
 
 Local Development
 -----------------
@@ -80,3 +21,5 @@ Local Development
 When submitting a PR please use  [`cargo fmt`][] (nightly).
 
 [`cargo fmt`]: https://github.com/rust-lang/rustfmt
+
+[Documentation]: https://docs.rs/annotate-snippets/

README.md

@@ -18,6 +18,6 @@ fn main() {
             .annotation(Label::info("while parsing this struct").span(34..50)),
     );
 
-    let renderer = Renderer::plain();
-    println!("{}", renderer.render(snippet));
+    let renderer = Renderer::styled();
+    anstream::println!("{}", renderer.render(snippet));
 }

examples/expected_type.rs

@@ -17,6 +17,6 @@ fn main() {
             "expected type: `snippet::Annotation`\n   found type: `__&__snippet::Annotation`",
         ));
 
-    let renderer = Renderer::plain();
-    println!("{}", renderer.render(snippet));
+    let renderer = Renderer::styled();
+    anstream::println!("{}", renderer.render(snippet));
 }

examples/expected_type.svg

@@ -32,6 +32,6 @@ fn main() {
             .annotation(Label::error("expected enum `std::option::Option`").span(26..724)),
     );
 
-    let renderer = Renderer::plain();
-    println!("{}", renderer.render(snippet));
+    let renderer = Renderer::styled();
+    anstream::println!("{}", renderer.render(snippet));
 }

examples/footer.rs

@@ -5,6 +5,6 @@ fn main() {
         .slice(Slice::new("Foo", 51).origin("src/format.rs"))
         .slice(Slice::new("Faa", 129).origin("src/display.rs"));
 
-    let renderer = Renderer::plain();
-    println!("{}", renderer.render(snippet));
+    let renderer = Renderer::styled();
+    anstream::println!("{}", renderer.render(snippet));
 }