24 releases

0.11.4 Jun 15, 2024
0.11.2 Apr 27, 2024
0.11.1 Mar 21, 2024
0.10.0 Dec 13, 2023
0.1.0 May 22, 2018

#8 in Programming languages

Download history 102288/week @ 2024-07-17 87651/week @ 2024-07-24 90701/week @ 2024-07-31 90977/week @ 2024-08-07 87608/week @ 2024-08-14 80930/week @ 2024-08-21 86856/week @ 2024-08-28 90404/week @ 2024-09-04 90172/week @ 2024-09-11 83102/week @ 2024-09-18 109279/week @ 2024-09-25 101810/week @ 2024-10-02 98680/week @ 2024-10-09 103699/week @ 2024-10-16 109139/week @ 2024-10-23 106959/week @ 2024-10-30

434,424 downloads per month
Used in 259 crates (53 directly)

Apache-2.0/MIT

76KB
1.5K SLoC

annotate-snippets

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

crates.io documentation build status

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:

Screenshot

Local Development

cargo build
cargo test

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


lib.rs:

A library for formatting of text or programming code snippets.

It's primary purpose is to build an ASCII-graphical representation of the snippet with annotations.

Example

The crate uses a three stage process with two conversions between states:

Message --> Renderer --> impl Display

The input type - [Message] is a structure designed to align with likely output from any parser whose code snippet is to be annotated.

The middle structure - [Renderer] is a structure designed to convert a snippet into an internal structure that is designed to store the snippet data in a way that is easy to format. [Renderer] also handles the user-configurable formatting options, such as color, or margins.

Finally, impl Display into a final String output.

features

  • testing-colors - Makes Renderer::styled colors OS independent, which allows for easier testing when testing colored output. It should be added as a feature in [dev-dependencies], which can be done with the following command:
cargo add annotate-snippets --dev --feature testing-colors

Dependencies

~1.5MB
~19K SLoC