java-diff-report

• java-diff-report
  • What is this for
  • How to get the jar
  • API Javadoc
  • Sample usage

java-diff-report

• link back to the project

What is this for

The java-diff-report is a small Java libary which aims to supplement the java-diff-utils library. The java-diff-report accepts 2 input texts (as Files, Paths, Strings, URLs) and call the java-diff-utils to generate the Diff. The java-diff-report accepts the output Diff info from the java-diff-utils libary and compiles a report in Markdown format.

How to get the jar

The jar is available at

• Maven Central

• Releases page of the project’s GitHub repository

API Javadoc

• javadoc

Sample usage

package com.kazurayam.sample;

import com.kazurayam.difflib.text.Differ;
import com.kazurayam.difflib.text.DiffInfo;
import com.kazurayam.difflib.text.MarkdownReporter;

import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) throws Exception {
        Path original = Paths.get("./src/test/fixtures/text1.txt");
        Path revised = Paths.get("./src/test/fixtures/text2.txt");
        Path output = Paths.get("./build/tmp/report.md");
        Files.createDirectories(output.getParent());

        DiffInfo diffInfo = Differ.diffFiles(original, revised);
        diffInfo.setTitle("Sample diff report of 2 text files");
        MarkdownReporter reporter = new MarkdownReporter.Builder(diffInfo).build();
        Files.writeString(output, reporter.compileMarkdownReport());
        System.out.println(reporter.compileStats());
    }
}

Output:

• https://kazurayam.github.io/java-diff-report/sample-report.md

This will be rendered as this:

]