https://github.com/rust-lang/annotate-snippets-rs

Library for snippet annotations
https://github.com/rust-lang/annotate-snippets-rs

annotator ascii library parser-library

Last synced: about 2 months ago
JSON representation

Library for snippet annotations

• Host: GitHub
• URL: https://github.com/rust-lang/annotate-snippets-rs
• Owner: rust-lang
• License: apache-2.0
• Created: 2018-03-12T22:16:03.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-05-07T14:14:41.000Z (2 months ago)
• Last Synced: 2025-05-08T00:03:48.821Z (2 months ago)
• Topics: annotator, ascii, library, parser-library
• Language: Rust
• Size: 746 KB
• Stars: 314
• Watchers: 22
• Forks: 44
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# annotate-snippets

`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:

![Screenshot](./examples/expected_type.svg)

Local Development

-----------------

    cargo build

    cargo test

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

[`cargo fmt`]: https://github.com/rust-lang/rustfmt

[Documentation]: https://docs.rs/annotate-snippets/