ruff/crates/ruff_annotate_snippets/README.md
Andrew Gallant 9c27c57b5b crates: vendor annotate-snippets crate
This merely adds the crate to our repository. Some cosmetic changes are
made to make it work in our repo and follow our conventions, such as
changing the name to `ruff_annotate_snippets`. We retain the original
license information. We do drop some things, such as benchmarks, but
keep tests and examples.
2025-01-15 13:37:52 -05:00

15 lines
821 B
Markdown

This is a fork of the [`annotate-snippets` crate]. The principle motivation for
this fork, at the time of writing, is [issue #167]. Specifically, we wanted to
upgrade our version of `annotate-snippets`, but do so _without_ changing our
diagnostic message format.
This copy of `annotate-snippets` is basically identical to upstream, but with
an extra `Level::None` variant that permits skipping over a new non-optional
header emitted by `annotate-snippets`.
More generally, it seems plausible that we may want to tweak other aspects of
the output format in the future, so it might make sense to stick with our own
copy so that we can be masters of our own destiny.
[issue #167]: https://github.com/rust-lang/annotate-snippets-rs/issues/167
[`annotate-snippets` crate]: https://github.com/rust-lang/annotate-snippets-rs