Support toning down sortPom (#2185)

diffplug · Jul 2, 2024 · 7bbe908 · 7bbe908
2 parents b456d1c + d0d71d6
commit 7bbe908
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 2 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -11,6 +11,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 
 ## [Unreleased]
 ### Changed
+* Support toning down sortPom logging. ([#2185](https://github.com/diffplug/spotless/pull/2185))
 * Bump default `ktlint` version to latest `1.2.1` -> `1.3.0`. ([#2165](https://github.com/diffplug/spotless/pull/2165))
 * Bump default `ktfmt` version to latest `0.49` -> `0.51`. ([#2172](https://github.com/diffplug/spotless/pull/2172))
 * Rename property `ktfmt` option `removeUnusedImport` -> `removeUnusedImports` to match `ktfmt`. ([#2172](https://github.com/diffplug/spotless/pull/2172))

diff --git a/lib/src/main/java/com/diffplug/spotless/pom/SortPomCfg.java b/lib/src/main/java/com/diffplug/spotless/pom/SortPomCfg.java
@@ -45,6 +45,8 @@ public class SortPomCfg implements Serializable {
 
 	public String predefinedSortOrder = "recommended_2008_06";
 
+	public boolean quiet = false;
+
 	public String sortOrderFile = null;
 
 	public String sortDependencies = null;

diff --git a/lib/src/sortPom/java/com/diffplug/spotless/glue/pom/SortPomFormatterFunc.java b/lib/src/sortPom/java/com/diffplug/spotless/glue/pom/SortPomFormatterFunc.java
@@ -85,20 +85,28 @@ public String apply(String input) throws Exception {
 				.setSortEntities(cfg.sortDependencies, cfg.sortDependencyExclusions, cfg.sortDependencyManagement,
 						cfg.sortPlugins, cfg.sortProperties, cfg.sortModules, cfg.sortExecutions)
 				.setIgnoreLineSeparators(false);
-		sortPom.setup(new MySortPomLogger(), builder.build());
+		sortPom.setup(new MySortPomLogger(cfg.quiet), builder.build());
 		sortPom.sortPom();
 		return Files.readString(pom.toPath(), Charset.forName(cfg.encoding));
 	}
 
 	private static class MySortPomLogger implements SortPomLogger {
+		private final boolean quiet;
+
+		public MySortPomLogger(boolean quiet) {
+			this.quiet = quiet;
+		}
+
 		@Override
 		public void warn(String content) {
 			logger.warn(content);
 		}
 
 		@Override
 		public void info(String content) {
-			logger.info(content);
+			if (!quiet) {
+				logger.info(content);
+			}
 		}
 
 		@Override

diff --git a/plugin-gradle/CHANGES.md b/plugin-gradle/CHANGES.md
@@ -4,6 +4,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 
 ## [Unreleased]
 ### Changed
+* Support toning down sortPom logging. ([#2185](https://github.com/diffplug/spotless/pull/2185))
 * Bump default `ktlint` version to latest `1.2.1` -> `1.3.0`. ([#2165](https://github.com/diffplug/spotless/pull/2165))
 * Bump default `ktfmt` version to latest `0.49` -> `0.51`. ([#2172](https://github.com/diffplug/spotless/pull/2172))
 * Rename property `ktfmt` option `removeUnusedImport` -> `removeUnusedImports` to match `ktfmt`. ([#2172](https://github.com/diffplug/spotless/pull/2172))

diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/PomExtension.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/PomExtension.java
@@ -117,6 +117,11 @@ public SortPomGradleConfig predefinedSortOrder(String predefinedSortOrder) {
 			return this;
 		}
 
+		public SortPomGradleConfig quiet(boolean quiet) {
+			cfg.quiet = quiet;
+			return this;
+		}
+
 		public SortPomGradleConfig sortOrderFile(String sortOrderFile) {
 			cfg.sortOrderFile = sortOrderFile;
 			return this;

diff --git a/plugin-maven/CHANGES.md b/plugin-maven/CHANGES.md
@@ -4,6 +4,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 
 ## [Unreleased]
 ### Changed
+* Support toning down sortPom logging. ([#2185](https://github.com/diffplug/spotless/pull/2185))
 * Bump default `ktlint` version to latest `1.2.1` -> `1.3.0`. ([#2165](https://github.com/diffplug/spotless/pull/2165))
 * Bump default `ktfmt` version to latest `0.49` -> `0.51`. ([#2172](https://github.com/diffplug/spotless/pull/2172))
 * Rename property `ktfmt` option `removeUnusedImport` -> `removeUnusedImports` to match `ktfmt`. ([#2172](https://github.com/diffplug/spotless/pull/2172))

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/pom/SortPom.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/pom/SortPom.java
@@ -62,6 +62,9 @@ public class SortPom implements FormatterStepFactory {
 	@Parameter
 	String predefinedSortOrder = defaultValues.predefinedSortOrder;
 
+	@Parameter
+	boolean quiet = defaultValues.quiet;
+
 	@Parameter
 	String sortOrderFile = defaultValues.sortOrderFile;
 
@@ -101,6 +104,7 @@ public FormatterStep newFormatterStep(FormatterStepConfig stepConfig) {
 		cfg.indentSchemaLocation = indentSchemaLocation;
 		cfg.indentAttribute = indentAttribute;
 		cfg.predefinedSortOrder = predefinedSortOrder;
+		cfg.quiet = quiet;
 		cfg.sortOrderFile = sortOrderFile;
 		cfg.sortDependencies = sortDependencies;
 		cfg.sortDependencyManagement = sortDependencyManagement;