Custom Spotless Task

[t-rad679]

Hello!

I'm trying to create a custom spotless task that only acts on files changed in git. I would also like the option to act on all files, so ideally I would have two separate tasks. For example, spotlessJavaCheck should check the pattern **/*.java, while spotlessChangedCheck should check only the files changed in git.

I've already written a function in the build script which identifies the changed files, and I would like to set the spotless target to these files.

Any advice?

[nedtwigg]

You can use -Pfiles=... to specify files manually at the command line, see #178 for details. We have plans to implement something like this directly in #511.

[t-rad679]

Thanks for the reply!

Is there a way to do this directly from a custom gradle task? The goal is for our engineers to be able to just run a task without having to do any additional configuration. Or is this what you're working on?

[t-rad679]

Also, I'm unable to get that to work...either with files or spotlessFiles mentioned on the readme.

[t-rad679]

More specifically, I run ./gradlew spotlessJavaCheck -Pfiles=Test.Java (and the same thing with -PspotlessFiles and it checks all files. I have triple checked that Test.java is located in the current working dir (which is the project root dir) and that it contains errors that should trigger a spotless error. I have also tried setting this property in gradle.properties and programmatically in the build script, to no avail.

[nedtwigg]

Ah, sorry, -PspotlessFiles is the right one, not -Pfiles. I'm not sure why it's not working for you (I assume the .Java vs .java in your paragraph above is a typo). The property gets ingested here:

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

Lines 282 to 289 in e870e78

	String filePatterns;
	if (project.hasProperty(FILES_PROPERTY) && project.property(FILES_PROPERTY) instanceof String) {
	filePatterns = (String) project.property(FILES_PROPERTY);
	} else {
	// needs to be non-null since it is an @Input property of the task
	filePatterns = "";
	}
	spotlessTask.setFilePatterns(filePatterns);

And then it takes effect here:

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

Lines 190 to 211 in e870e78

	Predicate<File> shouldInclude;
	if (this.filePatterns.isEmpty()) {
	shouldInclude = file -> true;
	} else {
	// a list of files has been passed in via project property
	final String[] includePatterns = this.filePatterns.split(",");
	final List<Pattern> compiledIncludePatterns = Arrays.stream(includePatterns)
	.map(Pattern::compile)
	.collect(Collectors.toList());
	shouldInclude = file -> compiledIncludePatterns
	.stream()
	.anyMatch(filePattern -> filePattern.matcher(file.getAbsolutePath())
	.matches());
	}
	// find the outOfDate files
	List<File> outOfDate = new ArrayList<>();
	inputs.outOfDate(inputDetails -> {
	File file = inputDetails.getFile();
	if (shouldInclude.test(file) && file.isFile() && !file.equals(getCacheFile())) {
	outOfDate.add(file);
	}
	});

And here is the gradle plugin test which makes sure that it still works:
https://github.com/diffplug/spotless/blob/e870e78999887595d8480c699c4ef71c9e974b32/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/SpecificFilesTest.java

So that's the first thing to figure out - why -PspotlessFiles isn't working for you. Once we've got that figured out, I'm happy to help figure out any remaining pieces.

[t-rad679]

Excellent. I'll dig around, thank you!

And yes, the capital J was a typo. I double checked after you mentioned it.

[t-rad679]

Ok, so here's the progress I've made:

I played around with printing both the filePatterns variable and the spotlessFiles property itselfI. I have been using a separate gradle file to handle the spotless logic (i.e., in build.gradle.kts I have apply(from = "style.gradle.kts") and style.gradle.kts is where the spotless configuration lives). When I moved all that logic to the base config file, I was at least able to get spotlessFiles to populate as a property, but filePatterns is not populated even then.

Also note, it is pretty important to me to be able to configure the Spotless logic outside of the base build script. I want to share this logic between projects. I still can't make it work even by using the base script, but if at all possible I want to make it work with the dependency script.

[nedtwigg]

That's pretty strange. Can you provide a verbatim command-line that you're executing? For example, one of the commands used from the test linked above is:

./gradlew spotlessApply -PspotlessFiles=.*/src/main/java/test(1|3).java

I wonder if perhaps there is a missing ". For example

./gradlew spotlessApply "-PspotlessFiles=.*/src/main/java/test(1|3).java"

it is pretty important to me to be able to configure the Spotless logic outside of the base

Almost everywhere that I use Spotless, I configure it exclusively through apply from: blah, so that should be fine. One trick you can use in Gradle 6+ is the pluginManagement / plugins apply false trick, although that shouldn't be related to problems in the -PspotlessFiles=blah stuff.

[t-rad679]

Okay, I am now able to get spotlessFiles to populate from my dependency build script. Still no filePatterns though.

[nedtwigg]

One important thing is that filePatterns is set in an afterEvaluate block. Looking at it now, I don't see a good reason for it, but it shouldn't be a problem either (unless you're also getting warnings like using method Project#afterEvaluate(Action) when the project is already evaluated has been deprecated, in which case there's the problem!)

Depending on when you are doing println() on filePatterns, that might explain why you're not seeing it. The only thing that matters is the filePatterns value during task execution - where in the execution path are you looking at the filePatterns value? Make sure it's a doFirst {} block on a task.

[t-rad679]

I mess around with it here and there to see what happens, but the main command I'm using is:

./gradlew spotlessCheck -PspotlessFiles=Test.java

I'm running this from the root directory of the project, and have confirmed that Test.java is located there.

And you were correct about why filePatterns was not showing up in my print statements...I added them to a doFirst block and now it shows up as expected.

[nedtwigg]

Okay, so we know that -PspotlessFiles=Test.java is setting filePatterns, as expected. In the tests, filePatterns is also behaving as expected. But you are still observing that it checks all files, rather than only the files you want it to check? The logic linked above is pretty simple, are you sure the patterns you're supplying and the output you're getting are not the expected result? If we have that figured out, you can use this to create a second task.

[t-rad679]

What it's doing now is not checking any of the files. I'm playing around with it to see if it's that particular file, but I don't think so. I tried Test.java both with the indent I expect and with another commonly expected indent, then I tried putting in a file that the full, normal run of Spotless returned errors from. I've also tried using both absolute and relative paths.

[nedtwigg]

I would try this:

• pick a file, let's say dir/SomeClass.java
• mutilate its formatting
• ./gradlew spotlessApply
• confirm it is fixed
• mutilate its formatting
• ./gradlew -PspotlessFiles=
• confirm it is not fixed
• ./gradlew -PspotlessFiles=SomeClass.java
• confirm it is fixed