Skip to content

Commit 7bbe908

Browse files
authored
Support toning down sortPom (#2185)
2 parents b456d1c + d0d71d6 commit 7bbe908

File tree

7 files changed

+24
-2
lines changed

7 files changed

+24
-2
lines changed

CHANGES.md

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
1111

1212
## [Unreleased]
1313
### Changed
14+
* Support toning down sortPom logging. ([#2185](https://github.com/diffplug/spotless/pull/2185))
1415
* Bump default `ktlint` version to latest `1.2.1` -> `1.3.0`. ([#2165](https://github.com/diffplug/spotless/pull/2165))
1516
* Bump default `ktfmt` version to latest `0.49` -> `0.51`. ([#2172](https://github.com/diffplug/spotless/pull/2172))
1617
* Rename property `ktfmt` option `removeUnusedImport` -> `removeUnusedImports` to match `ktfmt`. ([#2172](https://github.com/diffplug/spotless/pull/2172))

lib/src/main/java/com/diffplug/spotless/pom/SortPomCfg.java

+2
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ public class SortPomCfg implements Serializable {
4545

4646
public String predefinedSortOrder = "recommended_2008_06";
4747

48+
public boolean quiet = false;
49+
4850
public String sortOrderFile = null;
4951

5052
public String sortDependencies = null;

lib/src/sortPom/java/com/diffplug/spotless/glue/pom/SortPomFormatterFunc.java

+10-2
Original file line numberDiff line numberDiff line change
@@ -85,20 +85,28 @@ public String apply(String input) throws Exception {
8585
.setSortEntities(cfg.sortDependencies, cfg.sortDependencyExclusions, cfg.sortDependencyManagement,
8686
cfg.sortPlugins, cfg.sortProperties, cfg.sortModules, cfg.sortExecutions)
8787
.setIgnoreLineSeparators(false);
88-
sortPom.setup(new MySortPomLogger(), builder.build());
88+
sortPom.setup(new MySortPomLogger(cfg.quiet), builder.build());
8989
sortPom.sortPom();
9090
return Files.readString(pom.toPath(), Charset.forName(cfg.encoding));
9191
}
9292

9393
private static class MySortPomLogger implements SortPomLogger {
94+
private final boolean quiet;
95+
96+
public MySortPomLogger(boolean quiet) {
97+
this.quiet = quiet;
98+
}
99+
94100
@Override
95101
public void warn(String content) {
96102
logger.warn(content);
97103
}
98104

99105
@Override
100106
public void info(String content) {
101-
logger.info(content);
107+
if (!quiet) {
108+
logger.info(content);
109+
}
102110
}
103111

104112
@Override

plugin-gradle/CHANGES.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
44

55
## [Unreleased]
66
### Changed
7+
* Support toning down sortPom logging. ([#2185](https://github.com/diffplug/spotless/pull/2185))
78
* Bump default `ktlint` version to latest `1.2.1` -> `1.3.0`. ([#2165](https://github.com/diffplug/spotless/pull/2165))
89
* Bump default `ktfmt` version to latest `0.49` -> `0.51`. ([#2172](https://github.com/diffplug/spotless/pull/2172))
910
* Rename property `ktfmt` option `removeUnusedImport` -> `removeUnusedImports` to match `ktfmt`. ([#2172](https://github.com/diffplug/spotless/pull/2172))

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

+5
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,11 @@ public SortPomGradleConfig predefinedSortOrder(String predefinedSortOrder) {
117117
return this;
118118
}
119119

120+
public SortPomGradleConfig quiet(boolean quiet) {
121+
cfg.quiet = quiet;
122+
return this;
123+
}
124+
120125
public SortPomGradleConfig sortOrderFile(String sortOrderFile) {
121126
cfg.sortOrderFile = sortOrderFile;
122127
return this;

plugin-maven/CHANGES.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
44

55
## [Unreleased]
66
### Changed
7+
* Support toning down sortPom logging. ([#2185](https://github.com/diffplug/spotless/pull/2185))
78
* Bump default `ktlint` version to latest `1.2.1` -> `1.3.0`. ([#2165](https://github.com/diffplug/spotless/pull/2165))
89
* Bump default `ktfmt` version to latest `0.49` -> `0.51`. ([#2172](https://github.com/diffplug/spotless/pull/2172))
910
* Rename property `ktfmt` option `removeUnusedImport` -> `removeUnusedImports` to match `ktfmt`. ([#2172](https://github.com/diffplug/spotless/pull/2172))

plugin-maven/src/main/java/com/diffplug/spotless/maven/pom/SortPom.java

+4
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ public class SortPom implements FormatterStepFactory {
6262
@Parameter
6363
String predefinedSortOrder = defaultValues.predefinedSortOrder;
6464

65+
@Parameter
66+
boolean quiet = defaultValues.quiet;
67+
6568
@Parameter
6669
String sortOrderFile = defaultValues.sortOrderFile;
6770

@@ -101,6 +104,7 @@ public FormatterStep newFormatterStep(FormatterStepConfig stepConfig) {
101104
cfg.indentSchemaLocation = indentSchemaLocation;
102105
cfg.indentAttribute = indentAttribute;
103106
cfg.predefinedSortOrder = predefinedSortOrder;
107+
cfg.quiet = quiet;
104108
cfg.sortOrderFile = sortOrderFile;
105109
cfg.sortDependencies = sortDependencies;
106110
cfg.sortDependencyManagement = sortDependencyManagement;

0 commit comments

Comments
 (0)