Add reviewDog property and pipe it to spotlessCheck

Signed-off-by: yongjunhong <[email protected]>

Author: YongGoose

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessCheck.java

@@ -38,6 +38,7 @@
 import com.diffplug.spotless.FileSignature;
 import com.diffplug.spotless.ThrowingEx;
 import com.diffplug.spotless.extra.integration.DiffMessageFormatter;
+import com.diffplug.spotless.extra.middleware.ReviewDogGenerator;
 
 @DisableCachingByDefault(because = "not worth caching")
 public abstract class SpotlessCheck extends SpotlessTaskService.ClientTask {
@@ -47,6 +48,9 @@ public abstract class SpotlessCheck extends SpotlessTaskService.ClientTask {
 	@Input
 	public abstract Property<String> getRunToFixMessage();
 
+	@Input
+	public abstract Property<Boolean> getReviewDog();
+
 	public void performActionTest() throws IOException {
 		performAction(true);
 	}
@@ -61,29 +65,50 @@ private void performAction(boolean isTest) throws IOException {
 		ConfigurableFileTree lintsFiles = getConfigCacheWorkaround().fileTree().from(getSpotlessLintsDirectory().get());
 		if (cleanFiles.isEmpty() && lintsFiles.isEmpty()) {
 			getState().setDidWork(sourceDidWork());
-		} else if (!isTest && applyHasRun()) {
+			return;
+		}
+		if (!isTest && applyHasRun()) {
 			// if our matching apply has already run, then we don't need to do anything
 			getState().setDidWork(false);
-		} else {
-			List<File> unformattedFiles = getUncleanFiles(cleanFiles);
-			if (!unformattedFiles.isEmpty()) {
-				// if any files are unformatted, we show those
-				throw new GradleException(DiffMessageFormatter.builder()
-						.runToFix(getRunToFixMessage().get())
-						.formatterFolder(
-								getProjectDir().get().getAsFile().toPath(),
-								getSpotlessCleanDirectory().get().toPath(),
-								getEncoding().get())
-						.problemFiles(unformattedFiles)
-						.getMessage());
-			} else {
-				// We only show lints if there are no unformatted files.
-				// This is because lint line numbers are relative to the
-				// formatted content, and formatting often fixes lints.
-				boolean detailed = false;
-				throw new GradleException(super.allLintsErrorMsgDetailed(lintsFiles, detailed));
+			return;
+		}
+
+		List<File> unformattedFiles = getUncleanFiles(cleanFiles);
+		if (!unformattedFiles.isEmpty()) {
+			if (getReviewDog().get()) {
+				for (File file : unformattedFiles) {
+					String originalContent = new String(Files.readAllBytes(file.toPath()), getEncoding().get());
+					File cleanFile = new File(getSpotlessCleanDirectory().get().getName(), getProjectDir().get().getAsFile().toPath().relativize(file.toPath()).toString());
+					String formattedContent = new String(Files.readAllBytes(cleanFile.toPath()), getEncoding().get());
+
+					// TODO : send or save the output of ReviewDogGenerator.rdjsonlDiff
+					ReviewDogGenerator.rdjsonlDiff(file.getPath(), originalContent, formattedContent);
+				}
+			}
+
+			throw new GradleException(DiffMessageFormatter.builder()
+					.runToFix(getRunToFixMessage().get())
+					.formatterFolder(
+							getProjectDir().get().getAsFile().toPath(),
+							getSpotlessCleanDirectory().get().toPath(),
+							getEncoding().get())
+					.problemFiles(unformattedFiles)
+					.getMessage());
+		}
+
+		if (getReviewDog().get()) {
+			for (File file : lintsFiles.getFiles()) {
+				String path = file.getPath();
+				// TODO : send or save the output of ReviewDogGenerator.rdjsonlLints
+				ReviewDogGenerator.rdjsonlLints(path, null, null);
 			}
 		}
+
+		// We only show lints if there are no unformatted files.
+		// This is because lint line numbers are relative to the
+		// formatted content, and formatting often fixes lints.
+		boolean detailed = false;
+		throw new GradleException(super.allLintsErrorMsgDetailed(lintsFiles, detailed));
 	}
 
 	private @NotNull List<File> getUncleanFiles(ConfigurableFileTree cleanFiles) {

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessExtension.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2024 DiffPlug
+ * Copyright 2016-2025 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -267,6 +267,24 @@ public void setEnforceCheck(boolean enforceCheck) {
 		this.enforceCheck = enforceCheck;
 	}
 
+	boolean reviewDog = false;
+
+	/**
+	 * Returns {@code true} if ReviewDog output should be generated; {@code false} otherwise.
+	 */
+	public boolean isReviewDog() {
+		return reviewDog;
+	}
+
+	/**
+	 * Configures Spotless to generate ReviewDog output if {@code true}.
+	 * <p>
+	 * {@code false} by default.
+	 */
+	public void setReviewDog(boolean reviewDog) {
+		this.reviewDog = reviewDog;
+	}
+
 	@SuppressWarnings("unchecked")
 	public <T extends FormatExtension> void format(String name, Class<T> clazz, Action<T> configure) {
 		maybeCreate(name, clazz).lazyActions.add((Action<FormatExtension>) configure);

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessExtensionImpl.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2024 DiffPlug
+ * Copyright 2016-2025 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -91,6 +91,9 @@ protected void createFormatTasks(String name, FormatExtension formatExtension) {
 
 			// if the user runs both, make sure that apply happens first,
 			task.mustRunAfter(applyTask);
+
+			// if the user enables the review dog, spotlessCheck will return the review dog format output
+			task.getReviewDog().set(this.reviewDog);
 		});
 		rootCheckTask.configure(task -> task.dependsOn(checkTask));