feat: Implement conversion of diff content to ReviewDog format

[YongGoose]

Related issue: #655

[nedtwigg]

Starting a draft PR is a great approach!

The Gradle tests are quite slow. I would create a ReviewDogGenerator in the lib-extra project, running tests there is much faster than in the Gradle project. Once we can generate a ReviewDog file, then we can wire it up with Gradle.

As for the wiring, this is how it works now

graph TD
    spotlessJava --> spotlessJavaCheck
    spotlessJava --> spotlessJavaApply
    spotlessJavaCheck --> spotlessCheck
    spotlessJavaApply --> spotlessApply

    spotlessKotlin --> spotlessKotlinCheck
    spotlessKotlin --> spotlessKotlinApply
    spotlessKotlinCheck --> spotlessCheck
    spotlessKotlinApply --> spotlessApply

Loading

All of the work happens in spotlessJava, and it happens in a way which supports caching and up-to-dateness, etc

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

Lines 77 to 97 in 6f1919f

	@TaskAction
	public void performAction(InputChanges inputs) throws Exception {
	IdeHook.State ideHook = getIdeHookState().getOrNull();
	if (ideHook != null && ideHook.path != null) {
	IdeHook.performHook(this, ideHook);
	return;
	}
	SpotlessTaskService taskService = getTaskService().get();
	taskService.registerSourceAlreadyRan(this);
	if (target == null) {
	throw new GradleException("You must specify 'Iterable<File> target'");
	}
	if (!inputs.isIncremental()) {
	getLogger().info("Not incremental: removing prior outputs");
	getFs().delete(d -> d.delete(cleanDirectory));
	getFs().delete(d -> d.delete(lintsDirectory));
	Files.createDirectories(cleanDirectory.toPath());
	Files.createDirectories(lintsDirectory.toPath());
	}

Then spotlessJavaCheck and spotlessJavaApply just look at those folders and copy them around

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

Lines 59 to 68 in 6f1919f

	private void performAction(boolean isTest) throws IOException {
	ConfigurableFileTree cleanFiles = getConfigCacheWorkaround().fileTree().from(getSpotlessCleanDirectory().get());
	ConfigurableFileTree lintsFiles = getConfigCacheWorkaround().fileTree().from(getSpotlessLintsDirectory().get());
	if (cleanFiles.isEmpty() && lintsFiles.isEmpty()) {
	getState().setDidWork(sourceDidWork());
	} else 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);

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

Lines 33 to 39 in 6f1919f

	public void performAction() {
	getTaskService().get().registerApplyAlreadyRan(this);
	ConfigurableFileTree cleanFiles = getConfigCacheWorkaround().fileTree().from(getSpotlessCleanDirectory().get());
	ConfigurableFileTree lintsFiles = getConfigCacheWorkaround().fileTree().from(getSpotlessLintsDirectory().get());
	if (cleanFiles.isEmpty() && lintsFiles.isEmpty()) {
	getState().setDidWork(sourceDidWork());
	} else {

I would expect spotlessReviewDog to work in that same structure. But probably we should get the guts working in lib-extra, and also write some docs for plugin-gradle, before we spend too much time implementing the wiring.

[nedtwigg]

I don't think everybody needs the diff task.

[YongGoose]

@nedtwigg

I’m planning to implement this feature in three steps:

1. Create the ReviewDogGenerator class
2. Add a task in the Gradle-plugin that uses the information stored by ReviewDogGenerator
3. Write test codes

This dc52b26 includes only the implementation of step 1.

Also, I have a question!

After ReviewDogGenerator generates a diff for ReviewDog, I’d like to store that information in a separate directory (like SpotlessTaskImpl does).
However, it seems that classes from gradle.api can’t be used within the lib-extra directory.

Would you be able to offer some guidance on this?

[nedtwigg]

Here is my suggestion:

class ReviewDog {
  public static String rdjsonlDiff(String path, String actualContent, String formattedContent)
  public static String rdjsonlLints(String path, String formattedContent, List<FormatterStep> steps, List<List<Lint>> lintsPerStep)
}

You can test this easily in lib-extra

class ReviewDogTest {
  @Test
  public void diffSingleLine() {
    expectSelfie(ReviewDog.rdjsonlDiff("test.txt", "dirty", "clean")).toBe_TODO()
  }
  ... etc
}

So you can build and test the ReviewDog features in isolation, no gradle API required. Once these are working, you can pipe them together in a Gradle task.