25 releases

new 0.11.5 Dec 9, 2024
0.11.4 Jun 15, 2024
0.11.2 Apr 27, 2024
0.11.1 Mar 21, 2024
0.1.0 May 22, 2018

#7 in Programming languages

Download history 82755/week @ 2024-08-19 82236/week @ 2024-08-26 90440/week @ 2024-09-02 91454/week @ 2024-09-09 84758/week @ 2024-09-16 96094/week @ 2024-09-23 110804/week @ 2024-09-30 97552/week @ 2024-10-07 100735/week @ 2024-10-14 108005/week @ 2024-10-21 108107/week @ 2024-10-28 106914/week @ 2024-11-04 113715/week @ 2024-11-11 110130/week @ 2024-11-18 108896/week @ 2024-11-25 117203/week @ 2024-12-02

458,866 downloads per month
Used in 280 crates (60 directly)

MIT/Apache

97KB
2K 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
~24K SLoC