rs-rich-ext 0.0.21

Extensions for the `rich` Rust port: diagnostics, structured data, clap and tracing integration, diffs, workflow renderables and a plugin registry
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

//! Diffs: an engine, terminal views and the inputs they read.
//!
//! - [`engine`]: Myers' O(ND) diff in linear space over any hashable
//!   elements ([`diff_lines`], [`diff_slices`]), word and character diffs for
//!   intra-line emphasis ([`diff_words`], [`diff_chars`]), [`Hunk`] grouping
//!   and [`TextDiff`], whose [`unified`](TextDiff::unified) output matches
//!   `diff -u` minus timestamps.
//! - [`DiffView`]: a renderable diff, unified or side by side, of plain text,
//!   ANSI text ([`DiffView::ansi`], which also reports style-only changes) or,
//!   with the `testing` feature, render snapshots.
//! - [`SourceDiff`]: a syntax-highlighted source diff with optional line links.
//! - [`ConflictFile`] and [`ConflictView`]: three-way merge conflicts parsed
//!   from the markers a merge leaves (diff3's base included) and shown ours,
//!   base and theirs side by side or stacked.
//! - [`git`]: a `git diff` parser and [`PatchView`](git::PatchView), a
//!   review-style renderer with a file tree, annotations and links.
//! - `test_report` (feature `test-report`): JUnit XML and libtest JSON test
//!   results and the `TestReport` renderable.
//! - `assert_rich_eq!` and friends (feature `testing`): assertions that
//!   panic with a rendered diff.
//!
//! With colour off every change stays visible: `-`, `+` and `~` (style only)
//! markers lead each changed line.

mod conflict;
pub mod engine;
pub mod git;
mod render;
mod source;
pub mod transform;
mod view;

#[cfg(feature = "testing")]
pub mod assert;
#[cfg(feature = "test-report")]
pub mod test_report;

pub use conflict::{
    Conflict, ConflictError, ConflictFile, ConflictLayout, ConflictSide, ConflictView,
    MAX_CONFLICT_SOURCE, MAX_CONFLICTS, Pick,
};
pub use engine::{
    Hunk, Op, TextDiff, diff_chars, diff_lines, diff_slices, diff_words, group_hunks, hunk_header,
    tokenize,
};
pub use source::SourceDiff;
pub use view::{DiffView, Side};

use rich::{Console, Style};

/// The default styles for diff and test-report keys. [`extended_theme`]
/// includes them; renderers fall back to them when a theme lacks a key.
///
/// [`extended_theme`]: crate::theme::extended_theme
pub const STYLES: &[(&str, &str)] = &[
    ("diff.added", "green"),
    ("diff.removed", "red"),
    ("diff.added.emphasis", "bold underline green"),
    ("diff.removed.emphasis", "bold underline red"),
    ("diff.hunk", "cyan"),
    ("diff.header", "bold"),
    ("diff.line_number", "dim"),
    ("diff.context", "none"),
    ("diff.conflict.ours", "green"),
    ("diff.conflict.base", "yellow"),
    ("diff.conflict.theirs", "blue"),
    ("diff.conflict.label", "bold"),
    ("test.passed", "green"),
    ("test.failed", "bold red"),
    ("test.errored", "bold magenta"),
    ("test.skipped", "yellow"),
];

/// The console theme's style for `key`, else its default from [`STYLES`].
pub(crate) fn style(console: &Console, key: &str) -> Style {
    let fallback = STYLES
        .iter()
        .find(|(name, _)| *name == key)
        .map_or("none", |(_, spec)| spec);
    crate::event::theme_style(console, key, fallback)
}

/// How a diff is laid out.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub enum Layout {
    /// One column, removed lines before added ones (the default).
    #[default]
    Unified,
    /// Old on the left, new on the right, each half the width.
    SideBySide,
}