From 29913cfa83d6eeb1edaf2290ccdc90fb571af25d Mon Sep 17 00:00:00 2001 From: Guillaume Nodet Date: Wed, 26 Jun 2024 07:13:55 +0200 Subject: [PATCH 1/3] Support toning down sortPom --- .../java/com/diffplug/spotless/pom/SortPomCfg.java | 2 ++ .../spotless/glue/pom/SortPomFormatterFunc.java | 12 ++++++++++-- .../com/diffplug/spotless/maven/pom/SortPom.java | 4 ++++ 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/lib/src/main/java/com/diffplug/spotless/pom/SortPomCfg.java b/lib/src/main/java/com/diffplug/spotless/pom/SortPomCfg.java index 656b6f16f4..08a0308178 100644 --- 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 index d1ab469af0..f5abef6614 100644 --- 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,12 +85,18 @@ 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); @@ -98,7 +104,9 @@ public void warn(String content) { @Override public void info(String content) { - logger.info(content); + if (!quiet) { + logger.info(content); + } } @Override 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 index 8b0df8a7b0..eba179cb1e 100644 --- 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; From 0ca23f3f86cec227081728e230b3b4ff2c5963a5 Mon Sep 17 00:00:00 2001 From: Guillaume Nodet Date: Wed, 26 Jun 2024 07:19:50 +0200 Subject: [PATCH 2/3] Also support gradle plugin --- .../main/java/com/diffplug/gradle/spotless/PomExtension.java | 5 +++++ 1 file changed, 5 insertions(+) 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 index 4474a36385..4fd92c1f02 100644 --- 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; From 74f041d4505beccfc245ddbb17b67cef8d97faaa Mon Sep 17 00:00:00 2001 From: Guillaume Nodet Date: Wed, 26 Jun 2024 07:20:00 +0200 Subject: [PATCH 3/3] Add changes --- CHANGES.md | 1 + plugin-gradle/CHANGES.md | 1 + plugin-maven/CHANGES.md | 1 + 3 files changed, 3 insertions(+) diff --git a/CHANGES.md b/CHANGES.md index b6daeb77f1..2b7f4afbad 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -11,6 +11,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format ( ## [Unreleased] ### Changes +* 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/CHANGES.md b/plugin-gradle/CHANGES.md index f0459ea885..16a3aad061 100644 --- 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] ### Changes +* 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/CHANGES.md b/plugin-maven/CHANGES.md index 21becc4f4a..ef568d75f6 100644 --- 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] ### Changes +* 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))