Crate termdiff

This library is for helping you create diff for displaying on the terminal

Examples

use termdiff::{arrows_theme, diff};
let old = "Double, double toil and trouble;
Fire burn and
Caldron bubble.";
let new = "Double, double toil and trouble;
Fire burn and
caldron bubble.
Cool it with a baboon's blood,
Then the charm is firm and good.";
let mut buffer: Vec<u8> = Vec::new();
diff(&mut buffer, old, new, arrows_theme()).unwrap();
let actual: String = String::from_utf8(buffer).expect("Not valid UTF-8");

assert_eq!(
    actual,
    "< left / > right
 Double, double toil and trouble;
 Fire burn and
<Caldron bubble.
>caldron bubble.
>Cool it with a baboon's blood,
>Then the charm is firm and good.
"
);

Alternatively if you are dropping this into a format! or similar, you might want to use the displayable instead

use termdiff::{signs_theme, DrawDiff};
let old = "Double, double toil and trouble;
Fire burn and
Caldron bubble.";
let new = "Double, double toil and trouble;
Fire burn and
caldron bubble.
Cool it with a baboon's blood,
Then the charm is firm and good.";
let actual = format!("{}", DrawDiff::new(old, new, signs_theme()));

assert_eq!(
    actual,
    "--- remove | insert +++
 Double, double toil and trouble;
 Fire burn and
-Caldron bubble.
+caldron bubble.
+Cool it with a baboon's blood,
+Then the charm is firm and good.
"
);

You can define your own theme if you like

use termdiff::DrawDiff;
use termdiff::Theme;
use crossterm::style::Stylize;

let my_theme = Theme {
header: format!("{}\n", "Header"),
highlight_insert: crossterm::style::Stylize::stylize,
highlight_delete: crossterm::style::Stylize::stylize,
equal_prefix: "=".to_string(),
equal_content: crossterm::style::Stylize::stylize,
delete_prefix: "!".to_string(),
delete_content: crossterm::style::Stylize::stylize,
insert_prefix: "|".to_string(),
insert_line: crossterm::style::Stylize::stylize,
line_end: "\n".into(),
};

let old = "Double, double toil and trouble;
Fire burn and
Caldron bubble.";
let new = "Double, double toil and trouble;
Fire burn and
caldron bubble.
Cool it with a baboon's blood,
Then the charm is firm and good.";
let actual = format!("{}", DrawDiff::new(old, new, my_theme));

assert_eq!(
    actual,
    "Header
=Double, double toil and trouble;
=Fire burn and
!Caldron bubble.
|caldron bubble.
|Cool it with a baboon's blood,
|Then the charm is firm and good.
"
);

Structs

DrawDiff

The struct that draws the diff

Theme

A Theme for the diff

Functions

arrows_color_theme

A simple colorful theme using arrows

arrows_theme

A simple colorless using arrows theme

diff

Print a diff to a writer

signs_color_theme

A simple colorful theme using signs

signs_theme

A simple colorless using signs theme