Getting started with OneDiff

dotnet new console -o OneDiffStart
cd OneDiffStart
dotnet add package RecursiveAI.OneDiff --version 1.0.0

using OneDiff;
using OneDiff.Merge;
 
string oldText = "Deliver within 30 days.\nPay within 45 days.\n";
string newText = "Deliver within 21 days.\nPay within 45 days.\n";
 
// The words that changed, as Markdown
Console.WriteLine(Diff.ToMarkdownInline(Diff.Words(oldText, newText)));
 
// A unified patch, and applying it
string patch = Diff.Unified(oldText, newText, "a/terms.txt", "b/terms.txt");
Console.Write(patch);
Console.WriteLine($"applied: {Diff.ApplyUnified(oldText, patch).Text == newText}");
 
// A three-way merge: edits to different lines merge
string baseText = "one\ntwo\nthree\nfour\n";
string ours     = "ONE\ntwo\nthree\nfour\n";
string theirs   = "one\ntwo\nthree\nFOUR\n";
TextMerge merged = Diff.Merge(baseText, ours, theirs);
Console.Write(merged.Text);
Console.WriteLine($"conflicts: {merged.HasConflicts}");

Deliver within <del>30</del><ins>21</ins> days.
Pay within 45 days.
 
--- a/terms.txt
+++ b/terms.txt
@@ -1,2 +1,2 @@
-Deliver within 30 days.
+Deliver within 21 days.
 Pay within 45 days.
applied: True
ONE
two
three
FOUR
conflicts: False

dotnet add package RecursiveAI.OneDiff.Documents --version 1.0.0

1. Supply. The Supplier shall deliver the goods within 30 days of each order.
 
2. Payment. The Customer shall pay each invoice within 45 days of its date.

using OneDiff.Documents;
using OneDiff.Documents.Serialization;
 
Comparison cmp = Comparison.Of("v1.txt", "v2.txt");
 
foreach (Change c in cmp.Changes.Where(c => c.IsSubstantive))
{
    Console.WriteLine($"{c.Kind}: {c.Old.Text} -> {c.New.Text}");
    if (c.OldValue is { } was && c.NewValue is { } now)
        Console.WriteLine($"  {c.Type}: {was.Canonical} -> {now.Canonical}");
}
Console.WriteLine($"complete: {cmp.Verification.Passed}");
 
// The output form follows the extension
cmp.SaveAs("redline.html");
cmp.SaveAs("changes.json");
 
Comparison again = ComparisonJson.Read(File.ReadAllBytes("changes.json"));
Console.WriteLine($"read back: {again.Changes.Length} changes, complete: {again.Verification.Passed}");

Replace: 30 days -> 21 days
  Duration: 30 d -> 21 d
complete: True
read back: 1 changes, complete: True

dotnet add package RecursiveAI.OneDiff.Pdf --version 1.0.0

using OneDiff.Documents;
using OneDiff.Pdf;
 
PdfRedline.Register();   // once at startup
 
// Highlights on v2.pdf's own pages, with the old text in the pop-ups
Redline.Create("v1.pdf", "v2.pdf", "markup.pdf");
 
// A rendered redline: a new, tagged PDF laid out from the comparison
Comparison cmp = Comparison.Of("v1.pdf", "v2.pdf");
cmp.SaveAs("redline.pdf", PdfRedline.Rendered);
cmp.SaveAs("side-by-side.html", RedlineForm.HtmlSideBySide);
 
foreach (Change c in cmp.Changes.Where(c => c.IsSubstantive))
    Console.WriteLine($"{c.Kind}: {c.Old.Text} -> {c.New.Text}");

Replace: 30 days -> 21 days

InvalidDataException: This PDF has no text layer, so it is probably a scan. Reference RecursiveAI.OneDiff.Ocr and call OcrRedline.Register() to read it by OCR.

dotnet add package RecursiveAI.OneDiff.Ocr --version 1.0.0

using OneDiff.Documents;
using OneDiff.Ocr;
 
OcrRedline.Register();   // once at startup; reads scans and digital PDFs
 
Redline.Create("scan-v1.png", "scan-v2.png", "scan-markup.pdf");
 
foreach (Change c in Comparison.Of("scan-v1.png", "scan-v2.png").Changes)
    Console.WriteLine($"{c.Kind}: {c.Old.Text} -> {c.New.Text}, " +
                      $"confidence {c.OcrConfidence:0.00}, possible OCR error: {c.PossibleOcrError}");

Replace: 30 days -> 21 days, confidence 0.98, possible OCR error: False

dotnet tool install --global RecursiveAI.OneDiff.Tool --version 1.0.0
onediff diff v1.txt v2.txt
onediff compare v1.pdf v2.pdf -o markup.pdf

--- v1.txt
+++ v2.txt
@@ -1,3 +1,3 @@
-1. Supply. The Supplier shall deliver the goods within 30 days of each order.
+1. Supply. The Supplier shall deliver the goods within 21 days of each order.
 
 2. Payment. The Customer shall pay each invoice within 45 days of its date.