diffplug · nedtwigg · Feb 4, 2023 · Feb 4, 2023
diff --git a/plugin-maven/CHANGES.md b/plugin-maven/CHANGES.md
@@ -5,6 +5,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ## [Unreleased]
 ### Added
 * A synthesis log with the number of considered files is added after each formatter execution ([#1507](https://github.com/diffplug/spotless/pull/1507))
+### Fixed
+* Respect `sourceDirectory` and `testSourceDirectory` POM configurations for Java formatters ([#1553](https://github.com/diffplug/spotless/pull/1553))
 ### Changes
 * **POTENTIALLY BREAKING** `sortByKeys` for JSON formatting now takes into account objects inside arrays ([#1546](https://github.com/diffplug/spotless/pull/1546))
 * Any commit of the Spotless maven plugin now available via JitPack ([#1547](https://github.com/diffplug/spotless/pull/1547))

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/AbstractSpotlessMojo.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/AbstractSpotlessMojo.java
@@ -320,7 +320,7 @@ private static String withTrailingSeparator(String path) {
 
  private Set<String> getIncludes(FormatterFactory formatterFactory) {
  Set<String> configuredIncludes = formatterFactory.includes();
- Set<String> includes = configuredIncludes.isEmpty() ? formatterFactory.defaultIncludes() : configuredIncludes;
+ Set<String> includes = configuredIncludes.isEmpty() ? formatterFactory.defaultIncludes(project) : configuredIncludes;
  if (includes.isEmpty()) {
  throw new PluginException("You must specify some files to include, such as '<includes><include>src/**/*.blah</include></includes>'");
  }

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/FormatterFactory.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/FormatterFactory.java
@@ -29,6 +29,7 @@
 import java.util.stream.Collectors;
 
 import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.project.MavenProject;
 
 import com.diffplug.common.collect.Sets;
 import com.diffplug.spotless.FormatExceptionPolicyStrict;
@@ -71,7 +72,7 @@ public abstract class FormatterFactory {
 
  private ToggleOffOn toggle;
 
- public abstract Set<String> defaultIncludes();
+ public abstract Set<String> defaultIncludes(MavenProject project);
 
  public abstract String licenseHeaderDelimiter();
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/antlr4/Antlr4.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/antlr4/Antlr4.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,8 @@
 
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.common.collect.ImmutableSet;
 import com.diffplug.spotless.antlr4.Antlr4Defaults;
 import com.diffplug.spotless.maven.FormatterFactory;
@@ -30,7 +32,7 @@
  */
 public class Antlr4 extends FormatterFactory {
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return ImmutableSet.of(Antlr4Defaults.includes());
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/cpp/Cpp.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/cpp/Cpp.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,8 @@
 import java.util.Collections;
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.spotless.cpp.CppDefaults;
 import com.diffplug.spotless.maven.FormatterFactory;
 import com.diffplug.spotless.maven.generic.LicenseHeader;
@@ -30,7 +32,7 @@
  */
 public class Cpp extends FormatterFactory {
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return Collections.emptySet();
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/Format.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/Format.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,8 @@
 import java.util.Collections;
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.spotless.maven.FormatterFactory;
 
 /**
@@ -29,7 +31,7 @@
 public class Format extends FormatterFactory {
 
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return Collections.emptySet();
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/groovy/Groovy.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/groovy/Groovy.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 DiffPlug
+ * Copyright 2020-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,8 @@
 
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.common.collect.ImmutableSet;
 import com.diffplug.spotless.maven.FormatterFactory;
 import com.diffplug.spotless.maven.generic.LicenseHeader;
@@ -33,7 +35,7 @@ public class Groovy extends FormatterFactory {
  private static final String LICENSE_HEADER_DELIMITER = "package ";
 
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return DEFAULT_INCLUDES;
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/java/Java.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/java/Java.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2022 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,9 +15,17 @@
  */
 package com.diffplug.spotless.maven.java;
 
+import static java.util.stream.Collectors.toSet;
+
+import java.io.File;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.Set;
+import java.util.stream.Stream;
+
+import org.apache.maven.model.Build;
+import org.apache.maven.project.MavenProject;
 
-import com.diffplug.common.collect.ImmutableSet;
 import com.diffplug.spotless.maven.FormatterFactory;
 import com.diffplug.spotless.maven.generic.LicenseHeader;
 
@@ -29,12 +37,17 @@
  */
 public class Java extends FormatterFactory {
 
- private static final Set<String> DEFAULT_INCLUDES = ImmutableSet.of("src/main/java/**/*.java", "src/test/java/**/*.java");
  private static final String LICENSE_HEADER_DELIMITER = "package ";
 
  @Override
- public Set<String> defaultIncludes() {
- return DEFAULT_INCLUDES;
+ public Set<String> defaultIncludes(MavenProject project) {
+ Path projectDir = project.getBasedir().toPath();
+ Build build = project.getBuild();
+ return Stream.of(build.getSourceDirectory(), build.getTestSourceDirectory())
+ .map(Paths::get)
+ .map(projectDir::relativize)
+ .map(Java::fileMask)
+ .collect(toSet());
  }
 
  @Override
@@ -65,4 +78,12 @@ public void addRemoveUnusedImports(RemoveUnusedImports removeUnusedImports) {
  public void addFormatAnnotations(FormatAnnotations formatAnnotations) {
  addStepFactory(formatAnnotations);
  }
+
+ private static String fileMask(Path path) {
+ String dir = path.toString();
+ if (!dir.endsWith(File.separator)) {
+ dir += File.separator;
+ }
+ return dir + "**" + File.separator + "*.java";
+ }
 }
diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/javascript/Javascript.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/javascript/Javascript.java
@@ -18,6 +18,8 @@
 import java.util.Collections;
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.spotless.maven.FormatterFactory;
 
 /**
@@ -27,7 +29,7 @@
  */
 public class Javascript extends FormatterFactory {
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return Collections.emptySet();
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/json/Json.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/json/Json.java
@@ -18,6 +18,8 @@
 import java.util.Collections;
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.spotless.maven.FormatterFactory;
 
 /**
@@ -27,7 +29,7 @@ public class Json extends FormatterFactory {
  public static final int DEFAULT_INDENTATION = 4;
 
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return Collections.emptySet();
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/kotlin/Kotlin.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/kotlin/Kotlin.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,6 +19,8 @@
 
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.common.collect.ImmutableSet;
 import com.diffplug.spotless.maven.FormatterFactory;
 
@@ -27,7 +29,7 @@ public class Kotlin extends FormatterFactory {
  private static final Set<String> DEFAULT_INCLUDES = ImmutableSet.of("src/main/kotlin/**/*.kt", "src/test/kotlin/**/*.kt");
 
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return DEFAULT_INCLUDES;
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/markdown/Markdown.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/markdown/Markdown.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 DiffPlug
+ * Copyright 2021-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,8 @@
 import java.util.Collections;
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.spotless.maven.FormatterFactory;
 import com.diffplug.spotless.maven.generic.LicenseHeader;
 
@@ -29,7 +31,7 @@
  */
 public class Markdown extends FormatterFactory {
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return Collections.emptySet();
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/pom/Pom.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/pom/Pom.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 DiffPlug
+ * Copyright 2021-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,8 @@
 
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.common.collect.ImmutableSet;
 import com.diffplug.spotless.maven.FormatterFactory;
 import com.diffplug.spotless.maven.generic.LicenseHeader;
@@ -29,7 +31,7 @@
  */
 public class Pom extends FormatterFactory {
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return ImmutableSet.of("pom.xml");
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/python/Python.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/python/Python.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 DiffPlug
+ * Copyright 2021-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,8 @@
 import java.util.Collections;
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.spotless.maven.FormatterFactory;
 import com.diffplug.spotless.maven.generic.LicenseHeader;
 
@@ -30,7 +32,7 @@
 public class Python extends FormatterFactory {
 
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return Collections.emptySet();
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/scala/Scala.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/scala/Scala.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,8 @@
 
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.common.collect.ImmutableSet;
 import com.diffplug.spotless.maven.FormatterFactory;
 import com.diffplug.spotless.maven.generic.LicenseHeader;
@@ -34,7 +36,7 @@ public class Scala extends FormatterFactory {
  private static final String LICENSE_HEADER_DELIMITER = "package ";
 
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return DEFAULT_INCLUDES;
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/sql/Sql.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/sql/Sql.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 DiffPlug
+ * Copyright 2020-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,8 @@
 import java.util.Collections;
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.spotless.maven.FormatterFactory;
 
 /**
@@ -27,7 +29,7 @@
  */
 public class Sql extends FormatterFactory {
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return Collections.emptySet();
  }
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/typescript/Typescript.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/typescript/Typescript.java
@@ -18,6 +18,8 @@
 import java.util.Collections;
 import java.util.Set;
 
+import org.apache.maven.project.MavenProject;
+
 import com.diffplug.spotless.maven.FormatterFactory;
 
 /**
@@ -27,7 +29,7 @@
  */
 public class Typescript extends FormatterFactory {
  @Override
- public Set<String> defaultIncludes() {
+ public Set<String> defaultIncludes(MavenProject project) {
  return Collections.emptySet();
  }