lyneate's Introduction

Lyneate

Display beautiful code reports in the terminal with support for single-line and multi-line highlighting.

Example

use colored::Colorize;
use lyneate::Report;

fn main() {
    println!(
        "{} Mismatched match expression branch return types\n",
        "Error:".bright_red()
    );

    let report = Report::new_char_spanned(
        include_str!("basic.pseudo"),
        [
            (
                29..102,
                format!("{}", "In this match expression".dimmed()),
                (255, 64, 112),
            ),
            (
                64..75,
                format!("{} {}", "This is of type".dimmed(), "int".bright_white()),
                (255, 159, 64),
            ),
            (
                87..92,
                format!("{} {}", "This is of type".dimmed(), "string".bright_white()),
                (207, 255, 64),
            ),
        ],
    );

    report.display();
}

More examples

Usage

This crate provides:

the Report struct which takes the source code and an iterator over the span, text, and color of all messages
the Theme, ThemeChars, ThemeEffects, and ThemeSizing structs which can be used to customize the appearance of a report display

Code spans can be byte-aligned or char-aligned. Different methods for constructing a Report for either are provided.

The API is kept simple in order to allow as much flexibility as possible to the user. It does not make any assumptions or care about the provenance of the source code.