codespan

codespan-reporting

Beautiful diagnostic reporting for text-based programming languages.

Languages like Rust and Elm already support beautiful error reporting output, but it can take a significant amount work to implement this for new programming languages! The codespan-reporting crate aims to make beautiful error diagnostics easy and relatively painless for everyone!

We're still working on improving the crate to help it support broader use cases, and improving the quality of the diagnostic rendering, so stay tuned for updates and please give us feedback if you have it. Contributions are also very welcome!

Example

…

Running the CLI example

To get an idea of what the colored CLI output looks like, clone the repository and run the following shell command:

cargo run --example term

More examples of using codespan-reporting can be found in the examples directory.

Projects using codespan-reporting

codespan-reporting is currently used in the following projects:

• cargo-deny
• cargo-about
• CXX
• full_moon
• Gleam
• Gluon
• MDBook LinkCheck
• mos
• Pikelet
• Naga
• Spade

... any many more

Alternatives to codespan-reporting

There are a number of alternatives to codespan-reporting, including:

• annotate-snippets
• codemap
• language-reporting (a fork of codespan)

These are all ultimately inspired by rustc's excellent error reporting infrastructure.

Contributing

A guide to contributing to codespan-reporting can be found here.

Code of Conduct

Please note that this project is released with a Code of Conduct. By participating in this project you agree to abide by its terms.