New option to generate reports in Markdown format --markdown

README.md

@@ -105,7 +105,7 @@ in less than one second and therewith can be easily integrated in each build.
 
 * Comparison of two jar archives without the need to add all of their dependencies to the classpath.
 * Differences are printed on the command line in a simple diff format.
-* Differences can optionally be printed as XML or HTML file.
+* Differences can optionally be printed as [Markdown](https://www.markdownguide.org/), XML or HTML file.
 * Per default private and package protected classes and class members are not compared. If necessary, the access modifier of the classes and class members to be
   compared can be set to public, protected, package or private.
 * Per default all classes are tracked. If necessary, certain packages, classes, methods or fields can be excluded or explicitly included. Inclusion and exclusion is also possible based on annotations.

japicmp-ant-task/src/main/java/japicmp/ant/JApiCmpTask.java

@@ -9,6 +9,7 @@
 import japicmp.output.html.HtmlOutputGenerator;
 import japicmp.output.html.HtmlOutputGeneratorOptions;
 import japicmp.output.incompatible.IncompatibleErrorOutput;
+import japicmp.output.markdown.MarkdownOutputGenerator;
 import japicmp.output.semver.SemverOut;
 import japicmp.output.stdout.StdoutOutputGenerator;
 import japicmp.output.xml.XmlOutput;
@@ -38,6 +39,7 @@ public class JApiCmpTask extends Task {
 	private boolean includeSynthetic = false;
 	private boolean noAnnotations = false;
 	private boolean semanticVersioning = false;
+	private boolean markdown = false;
 	private boolean reportOnlyFilename = false;
 	private boolean reportOnlySummary = false;
 	private boolean ignoreMissingClasses = false;
@@ -46,6 +48,7 @@ public class JApiCmpTask extends Task {
 	private final List<String> ignoreMissingClassesByRegularExpressions = new ArrayList<>();
 	private String accessModifier = "protected";
 	private String semanticVersionProperty;
+	private String markdownProperty;
 	private String oldJar;
 	private String newJar;
 	private Path oldClassPath;
@@ -88,6 +91,15 @@ public void setSemVerProperty(String semverProperty) {
 		semanticVersionProperty = semverProperty;
 	}
 
+	public void setMarkdown(String markdown) {
+		this.markdown = Project.toBoolean(markdown);
+	}
+
+	public void setMarkdownProperty(String mdProperty) {
+		markdown = Boolean.TRUE;
+		markdownProperty = mdProperty;
+	}
+
 	public void setReportOnlyFilename(String reportOnlyFilename) {
 		this.reportOnlyFilename = Project.toBoolean(reportOnlyFilename);
 	}
@@ -284,6 +296,14 @@ private void generateOutput(Options options, List<JApiClass> jApiClasses, JarArc
 			}
 			log(semver);
 			return;
+		} else if (markdown) {
+			MarkdownOutputGenerator markdownOutputGenerator = new MarkdownOutputGenerator(options, jApiClasses);
+			String md = markdownOutputGenerator.generate();
+			if (markdownProperty != null) {
+				getProject().setProperty(markdownProperty, md);
+			}
+			log(md);
+			return;
 		}
 
 		if (!options.getXmlOutputFile().isPresent() && !options.getHtmlOutputFile().isPresent()) {

japicmp-maven-plugin/src/main/java/japicmp/maven/JApiCmpMojo.java

@@ -15,6 +15,8 @@
 import japicmp.output.html.HtmlOutputGenerator;
 import japicmp.output.html.HtmlOutputGeneratorOptions;
 import japicmp.output.incompatible.IncompatibleErrorOutput;
+import japicmp.output.markdown.MarkdownOutputGenerator;
+import japicmp.output.markdown.config.MarkdownOptions;
 import japicmp.output.semver.SemverOut;
 import japicmp.output.stdout.StdoutOutputGenerator;
 import japicmp.output.xml.XmlOutput;
@@ -77,6 +79,8 @@ public class JApiCmpMojo extends AbstractMojo {
 	private boolean skip;
 	@org.apache.maven.plugins.annotations.Parameter(property = "japicmp.skip", defaultValue = "false")
 	private boolean skipExec;
+	@org.apache.maven.plugins.annotations.Parameter(property = "japicmp.skipMarkdownReport", required = false)
+	private boolean skipMarkdownReport;
 	@org.apache.maven.plugins.annotations.Parameter(property = "japicmp.skipXmlReport", required = false)
 	private boolean skipXmlReport;
 	@org.apache.maven.plugins.annotations.Parameter(property = "japicmp.skipHtmlReport", required = false)
@@ -148,6 +152,9 @@ Optional<HtmlOutput> executeWithParameters(PluginParameters pluginParameters, Ma
 			SemverOut semverOut = new SemverOut(options, jApiClasses);
 			String semanticVersioningInformation = semverOut.generate();
 			generateDiffOutput(mavenParameters, pluginParameters, options, jApiClasses, jApiCmpBuildDir, semanticVersioningInformation);
+			if (!skipMarkdownReport(pluginParameters)) {
+				generateMarkdownOutput(mavenParameters, pluginParameters, options, jApiClasses, jApiCmpBuildDir);
+			}
 			if (!skipXmlReport(pluginParameters)) {
 				XmlOutput xmlOutput = generateXmlOutput(jApiClasses, jApiCmpBuildDir, options, mavenParameters, pluginParameters, semanticVersioningInformation);
 				if (pluginParameters.isWriteToFiles()) {
@@ -576,6 +583,18 @@ private void generateDiffOutput(MavenParameters mavenParameters, PluginParameter
 		}
 	}
 
+	private void generateMarkdownOutput(MavenParameters mavenParameters, PluginParameters pluginParameters, Options options,
+										List<JApiClass> jApiClasses, File jApiCmpBuildDir) throws IOException, MojoFailureException {
+		MarkdownOptions mdOptions = MarkdownOptions.newDefault(options);
+		if (pluginParameters.getParameterParam() != null && pluginParameters.getParameterParam().getMarkdownTitle() != null) {
+			mdOptions.title.report = pluginParameters.getParameterParam().getMarkdownTitle();
+		}
+		MarkdownOutputGenerator mdOut = new MarkdownOutputGenerator(mdOptions, jApiClasses);
+		String markdown = mdOut.generate();
+		File output = new File(jApiCmpBuildDir.getCanonicalPath() + File.separator + createFilename(mavenParameters) + ".md");
+		writeToFile(markdown, output);
+	}
+
 	private XmlOutput generateXmlOutput(List<JApiClass> jApiClasses, File jApiCmpBuildDir, Options options, MavenParameters mavenParameters,
 										PluginParameters pluginParameters, String semanticVersioningInformation) throws IOException {
 		String filename = createFilename(mavenParameters);
@@ -621,6 +640,14 @@ private boolean skipXmlReport(PluginParameters pluginParameters) {
 		return skipReport || this.skipXmlReport;
 	}
 
+	private boolean skipMarkdownReport(PluginParameters pluginParameters) {
+		boolean skipReport = false;
+		if (pluginParameters.getParameterParam() != null) {
+			skipReport = pluginParameters.getParameterParam().getSkipMarkdownReport();
+		}
+		return skipReport || this.skipMarkdownReport;
+	}
+
 	private String createFilename(MavenParameters mavenParameters) {
 		String filename = "japicmp";
 		String executionId = mavenParameters.getMojoExecution().getExecutionId();

japicmp-maven-plugin/src/main/java/japicmp/maven/Parameter.java

@@ -23,6 +23,8 @@ public class Parameter {
 	@org.apache.maven.plugins.annotations.Parameter(required = false)
 	private String htmlTitle;
 	@org.apache.maven.plugins.annotations.Parameter(required = false)
+	private String markdownTitle;
+	@org.apache.maven.plugins.annotations.Parameter(required = false)
 	private boolean noAnnotations;
 	@org.apache.maven.plugins.annotations.Parameter(required = false)
 	private String ignoreNonResolvableArtifacts;
@@ -35,6 +37,8 @@ public class Parameter {
 	@org.apache.maven.plugins.annotations.Parameter(required = false)
 	private boolean skipXmlReport;
 	@org.apache.maven.plugins.annotations.Parameter(required = false)
+	private boolean skipMarkdownReport;
+	@org.apache.maven.plugins.annotations.Parameter(required = false)
 	private boolean skipDiffReport;
 	@org.apache.maven.plugins.annotations.Parameter(required = false)
 	private boolean ignoreMissingOldVersion;
@@ -221,6 +225,14 @@ public void setHtmlTitle(String htmlTitle) {
 		this.htmlTitle = htmlTitle;
 	}
 
+	public String getMarkdownTitle() {
+		return markdownTitle;
+	}
+
+	public void setMarkdownTitle(String markdownTitle) {
+		this.markdownTitle = markdownTitle;
+	}
+
 	public String getIgnoreNonResolvableArtifacts() {
 		return ignoreNonResolvableArtifacts;
 	}
@@ -277,6 +289,14 @@ public void setSkipXmlReport(boolean skipXmlReport) {
 		this.skipXmlReport = skipXmlReport;
 	}
 
+	public boolean getSkipMarkdownReport() {
+		return skipMarkdownReport;
+	}
+
+	public void setSkipMarkdownReport(boolean skipMarkdownReport) {
+		this.skipMarkdownReport = skipMarkdownReport;
+	}
+
 	public boolean isSkipDiffReport() {
 		return skipDiffReport;
 	}

japicmp-testbase/japicmp-test-maven-plugin/pom.xml

@@ -108,6 +108,7 @@
 								<includeSynthetic>true</includeSynthetic>
 								<htmlStylesheet>${project.basedir}/src/main/resources/css/stylesheet.css</htmlStylesheet>
 								<htmlTitle>Test-Title</htmlTitle>
+								<markdownTitle>Test-Markdown-Title</markdownTitle>
 							</parameter>
 							<dependencies>
 								<dependency>
@@ -190,6 +191,7 @@
 								<onlyModified>true</onlyModified>
 								<skipXmlReport>true</skipXmlReport>
 								<skipHtmlReport>true</skipHtmlReport>
+								<skipMarkdownReport>true</skipMarkdownReport>
 							</parameter>
 							<dependencies>
 								<dependency>

japicmp-testbase/japicmp-test-maven-plugin/src/test/java/japicmp/test/ITClassFileFormatVersion.java

@@ -38,6 +38,24 @@ public void testClassFileFormatVersionIsPresent() throws IOException {
 		}
 	}
 
+	@Test
+	public void testMarkdownReportDiffClassFileFormatVersionIsPresent() throws IOException {
+		Path path = Paths.get(System.getProperty("user.dir"), "target", "japicmp", "class-file-format-version.md");
+		if (!Files.exists(path)) {
+			return; //in JDK 1.7 case
+		}
+		assertThat(Files.exists(path), is(true));
+		List<String> lines = Files.readAllLines(path, StandardCharsets.UTF_8);
+		boolean found = false;
+		for (String line : lines) {
+			if (line.contains("~~JDK 6~~ &rarr; **JDK 8**")) {
+				found = true;
+				break;
+			}
+		}
+		assertThat(found, is(true));
+	}
+
 	@Test
 	public void testStoutDiffClassFileFormatVersionIsPresent() throws IOException {
 		Path path = Paths.get(System.getProperty("user.dir"), "target", "japicmp", "class-file-format-version.diff");

japicmp-testbase/japicmp-test-maven-plugin/src/test/java/japicmp/test/ITMarkdownTitle.java

@@ -0,0 +1,30 @@
+package japicmp.test;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.core.Is.is;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+import org.junit.Test;
+
+public class ITMarkdownTitle {
+
+	@Test
+	public void testMarkdownTitle() throws IOException {
+		Path markdownPath = Paths.get(System.getProperty("user.dir"), "target", "japicmp", "single-version.md");
+		assertThat(Files.exists(markdownPath), is(true));
+		List<String> lines = Files.readAllLines(markdownPath, StandardCharsets.UTF_8);
+		boolean found = false;
+		for (String line : lines) {
+			if (line.equals("# Test-Markdown-Title")) {
+				found = true;
+				break;
+			}
+		}
+		assertThat(found, is(true));
+	}
+}

japicmp-testbase/japicmp-test-maven-plugin/src/test/java/japicmp/test/ITModuleExcluded.java

@@ -21,6 +21,11 @@ public void testHtmlReportNotGenerated() throws IOException {
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "ignore-module.xml")), is(false));
 	}
 
+	@Test
+	public void testMarkdownReportGenerated() throws IOException {
+		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "ignore-module.md")), is(false));
+	}
+
 	@Test
 	public void testDiffReportGenerated() throws IOException {
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "ignore-module.diff")), is(false));

japicmp-testbase/japicmp-test-maven-plugin/src/test/java/japicmp/test/ITMultipleExecutions.java

@@ -14,9 +14,11 @@ public class ITMultipleExecutions {
 	public void testThatXmlAndHtmlFilesAreWritten() {
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "multiple-versions.html")), is(true));
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "multiple-versions.xml")), is(true));
+		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "multiple-versions.md")), is(true));
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "multiple-versions.diff")), is(true));
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "single-version.html")), is(true));
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "single-version.xml")), is(true));
+		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "single-version.md")), is(true));
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "single-version.diff")), is(true));
 	}
 }

japicmp-testbase/japicmp-test-maven-plugin/src/test/java/japicmp/test/ITNoReports.java

@@ -21,6 +21,11 @@ public void testHtmlReportNotGenerated() throws IOException {
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "no-reports.xml")), is(false));
 	}
 
+	@Test
+	public void testMarkdownReportNotGenerated() throws IOException {
+		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "no-reports.md")), is(false));
+	}
+
 	@Test
 	public void testDiffReportGenerated() throws IOException {
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "no-reports.diff")), is(true));

japicmp-testbase/japicmp-test-maven-plugin/src/test/java/japicmp/test/ITSkip.java

@@ -21,6 +21,11 @@ public void testHtmlReportNotGenerated() throws IOException {
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "skip.xml")), is(false));
 	}
 
+	@Test
+	public void testMarkdownReportGenerated() throws IOException {
+		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "skip.md")), is(false));
+	}
+
 	@Test
 	public void testDiffReportGenerated() throws IOException {
 		assertThat(Files.exists(Paths.get(System.getProperty("user.dir"), "target", "japicmp", "skip.diff")), is(false));

japicmp/src/main/java/japicmp/cli/CliParser.java

@@ -64,6 +64,8 @@ public Options parse(String[] args) throws IllegalArgumentException {
 				options.setHtmlOutputFile(Optional.fromNullable(pathToHtmlOutputFile));
 			} else if ("-s".equals(arg) || "--semantic-versioning".equals(arg)) {
 				options.setSemanticVersioning(true);
+			} else if ("--markdown".equals(arg)) {
+				options.setMarkdown(true);
 			} else if ("--include-synthetic".equals(arg)) {
 				options.setIncludeSynthetic(true);
 			} else if (IGNORE_MISSING_CLASSES.equals(arg)) {
@@ -128,6 +130,7 @@ public static void printHelp() {
 			"                [--old-classpath <oldClassPath>]\n" +
 			"                [--report-only-filename] [--report-only-summary]\n" +
 			"                [(-s | --semantic-versioning)]\n" +
+			"                [--markdown]\n" +
 			"                [(-x <pathToXmlOutputFile> | --xml-file <pathToXmlOutputFile>)]\n" +
 			"                [--error-on-binary-incompatibility]\n" +
 			"                [--error-on-source-incompatibility]\n" +
@@ -215,6 +218,9 @@ public static void printHelp() {
 			"        -s, --semantic-versioning\n" +
 			"            Tells you which part of the version to increment.\n" +
 			"\n" +
+			"        --markdown\n" +
+			"            Generates output in Markdown format.\n" +
+			"\n" +
 			"        -x <pathToXmlOutputFile>, --xml-file <pathToXmlOutputFile>\n" +
 			"            Provides the path to the xml output file.\n" +
 			"\n" +

japicmp/src/main/java/japicmp/cli/JApiCli.java

@@ -9,6 +9,7 @@
 import japicmp.output.html.HtmlOutputGenerator;
 import japicmp.output.html.HtmlOutputGeneratorOptions;
 import japicmp.output.incompatible.IncompatibleErrorOutput;
+import japicmp.output.markdown.MarkdownOutputGenerator;
 import japicmp.output.semver.SemverOut;
 import japicmp.output.stdout.StdoutOutputGenerator;
 import japicmp.output.xml.XmlOutput;
@@ -46,6 +47,12 @@ private void generateOutput(Options options, List<JApiClass> jApiClasses, JarArc
 			System.out.println(output);
 			return;
 		}
+		if (options.isMarkdown()) {
+			MarkdownOutputGenerator markdownOutputGenerator = new MarkdownOutputGenerator(options, jApiClasses);
+			String output = markdownOutputGenerator.generate();
+			System.out.println(output);
+			return;
+		}
 		SemverOut semverOut = new SemverOut(options, jApiClasses);
 		if (options.getXmlOutputFile().isPresent()) {
 			XmlOutputGeneratorOptions xmlOutputGeneratorOptions = new XmlOutputGeneratorOptions();

japicmp/src/main/java/japicmp/config/Options.java

@@ -42,6 +42,7 @@ public class Options {
 	private boolean reportOnlyFilename;
 	private boolean reportOnlySummary;
 	private boolean semanticVersioning;
+	private boolean markdown;
 	private boolean errorOnBinaryIncompatibility;
 	private boolean errorOnSourceIncompatibility;
 	private boolean errorOnExclusionIncompatibility = true;
@@ -398,6 +399,14 @@ public boolean isSemanticVersioning() {
 		return semanticVersioning;
 	}
 
+	public void setMarkdown(boolean markdown) {
+		this.markdown = markdown;
+	}
+
+	public boolean isMarkdown() {
+		return markdown;
+	}
+
 	public boolean isErrorOnBinaryIncompatibility() {
 		return errorOnBinaryIncompatibility;
 	}