getFormatterFactories() {
- return Stream.concat(formats.stream(), Stream.of(groovy, java, scala, kotlin, cpp, typescript, antlr4, sql, python))
+ return Stream.concat(formats.stream(), Stream.of(groovy, java, scala, kotlin, cpp, typescript, antlr4, pom, sql, python))
.filter(Objects::nonNull)
.collect(toList());
}
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
new file mode 100644
index 0000000000..f083a17c89
--- /dev/null
+++ b/plugin-maven/src/main/java/com/diffplug/spotless/maven/pom/Pom.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2021 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.spotless.maven.pom;
+
+import java.util.Set;
+
+import com.diffplug.common.collect.ImmutableSet;
+import com.diffplug.spotless.maven.FormatterFactory;
+import com.diffplug.spotless.maven.generic.LicenseHeader;
+
+/**
+ * A {@link FormatterFactory} implementation that corresponds to {@code ...} configuration element.
+ *
+ * It defines a formatter for Maven pom files that can execute both language agnostic (e.g. {@link LicenseHeader})
+ * and pom-specific (e.g. {@link SortPom}) steps.
+ */
+public class Pom extends FormatterFactory {
+ @Override
+ public Set defaultIncludes() {
+ return ImmutableSet.of("pom.xml");
+ }
+
+ @Override
+ public String licenseHeaderDelimiter() {
+ return null;
+ }
+
+ public void addSortPom(SortPom sortPom) {
+ addStepFactory(sortPom);
+ }
+
+}
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
new file mode 100644
index 0000000000..f4fe8cb96b
--- /dev/null
+++ b/plugin-maven/src/main/java/com/diffplug/spotless/maven/pom/SortPom.java
@@ -0,0 +1,98 @@
+/*
+ * Copyright 2021 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.spotless.maven.pom;
+
+import org.apache.maven.plugins.annotations.Parameter;
+
+import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.maven.FormatterStepConfig;
+import com.diffplug.spotless.maven.FormatterStepFactory;
+import com.diffplug.spotless.pom.SortPomCfg;
+import com.diffplug.spotless.pom.SortPomStep;
+
+public class SortPom implements FormatterStepFactory {
+ private final SortPomCfg defaultValues = new SortPomCfg();
+
+ @Parameter
+ String encoding = defaultValues.encoding;
+
+ @Parameter
+ String lineSeparator = defaultValues.lineSeparator;
+
+ @Parameter
+ boolean expandEmptyElements = defaultValues.expandEmptyElements;
+
+ @Parameter
+ boolean spaceBeforeCloseEmptyElement = defaultValues.spaceBeforeCloseEmptyElement;
+
+ @Parameter
+ boolean keepBlankLines = defaultValues.keepBlankLines;
+
+ @Parameter
+ int nrOfIndentSpace = defaultValues.nrOfIndentSpace;
+
+ @Parameter
+ boolean indentBlankLines = defaultValues.indentBlankLines;
+
+ @Parameter
+ boolean indentSchemaLocation = defaultValues.indentSchemaLocation;
+
+ @Parameter
+ String predefinedSortOrder = defaultValues.predefinedSortOrder;
+
+ @Parameter
+ String sortOrderFile = defaultValues.sortOrderFile;
+
+ @Parameter
+ String sortDependencies = defaultValues.sortDependencies;
+
+ @Parameter
+ String sortDependencyExclusions = defaultValues.sortDependencyExclusions;
+
+ @Parameter
+ String sortPlugins = defaultValues.sortPlugins;
+
+ @Parameter
+ boolean sortProperties = defaultValues.sortProperties;
+
+ @Parameter
+ boolean sortModules = defaultValues.sortModules;
+
+ @Parameter
+ boolean sortExecutions = defaultValues.sortExecutions;
+
+ @Override
+ public FormatterStep newFormatterStep(FormatterStepConfig stepConfig) {
+ SortPomCfg cfg = new SortPomCfg();
+ cfg.encoding = encoding;
+ cfg.lineSeparator = lineSeparator;
+ cfg.expandEmptyElements = expandEmptyElements;
+ cfg.spaceBeforeCloseEmptyElement = spaceBeforeCloseEmptyElement;
+ cfg.keepBlankLines = keepBlankLines;
+ cfg.nrOfIndentSpace = nrOfIndentSpace;
+ cfg.indentBlankLines = indentBlankLines;
+ cfg.indentSchemaLocation = indentSchemaLocation;
+ cfg.predefinedSortOrder = predefinedSortOrder;
+ cfg.sortOrderFile = sortOrderFile;
+ cfg.sortDependencies = sortDependencies;
+ cfg.sortDependencyExclusions = sortDependencyExclusions;
+ cfg.sortPlugins = sortPlugins;
+ cfg.sortProperties = sortProperties;
+ cfg.sortModules = sortModules;
+ cfg.sortExecutions = sortExecutions;
+ return SortPomStep.create(cfg, stepConfig.getProvisioner());
+ }
+}
diff --git a/plugin-maven/src/test/java/com/diffplug/spotless/maven/MavenIntegrationHarness.java b/plugin-maven/src/test/java/com/diffplug/spotless/maven/MavenIntegrationHarness.java
index a7dd49b2fb..fa5224bb8d 100644
--- a/plugin-maven/src/test/java/com/diffplug/spotless/maven/MavenIntegrationHarness.java
+++ b/plugin-maven/src/test/java/com/diffplug/spotless/maven/MavenIntegrationHarness.java
@@ -134,6 +134,10 @@ protected void writePomWithPrettierSteps(String includes, String... steps) throw
writePom(formats(groupWithSteps("format", including(includes), steps)));
}
+ protected void writePomWithPomSteps(String... steps) throws IOException {
+ writePom(groupWithSteps("pom", including("pom_test.xml"), steps));
+ }
+
protected void writePom(String... configuration) throws IOException {
writePom(null, configuration);
}
diff --git a/plugin-maven/src/test/java/com/diffplug/spotless/maven/pom/SortPomMavenTest.java b/plugin-maven/src/test/java/com/diffplug/spotless/maven/pom/SortPomMavenTest.java
new file mode 100644
index 0000000000..ca9d77a6e3
--- /dev/null
+++ b/plugin-maven/src/test/java/com/diffplug/spotless/maven/pom/SortPomMavenTest.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2021 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.spotless.maven.pom;
+
+import org.junit.jupiter.api.Test;
+
+import com.diffplug.spotless.maven.MavenIntegrationHarness;
+
+public class SortPomMavenTest extends MavenIntegrationHarness {
+ @Test
+ public void testSortPomWithDefaultConfig() throws Exception {
+ writePomWithPomSteps("");
+
+ setFile("pom_test.xml").toResource("pom/pom_dirty.xml");
+ mavenRunner().withArguments("spotless:apply").runNoError().error();
+ assertFile("pom_test.xml").sameAsResource("pom/pom_clean_default.xml");
+ }
+}
diff --git a/testlib/build.gradle b/testlib/build.gradle
index 9975a9db26..edf9196d38 100644
--- a/testlib/build.gradle
+++ b/testlib/build.gradle
@@ -7,6 +7,7 @@ apply from: rootProject.file('gradle/java-setup.gradle')
dependencies {
api project(':lib')
+ api files(project(':lib').sourceSets.sortPom.output.classesDirs)
api "com.diffplug.durian:durian-core:${VER_DURIAN}"
api "com.diffplug.durian:durian-testlib:${VER_DURIAN}"
api "org.junit.jupiter:junit-jupiter:${VER_JUNIT}"
diff --git a/testlib/src/main/resources/pom/pom_clean_default.xml b/testlib/src/main/resources/pom/pom_clean_default.xml
new file mode 100644
index 0000000000..b4173f3b49
--- /dev/null
+++ b/testlib/src/main/resources/pom/pom_clean_default.xml
@@ -0,0 +1,40 @@
+
+
+ 4.0.0
+
+ spotless.test
+ minimal-pom
+ 1.0-SNAPSHOT
+ jar
+
+ minimal-pom
+ http://maven.apache.org
+
+
+ UTF-8
+ 1.8
+
+
+
+
+ junit
+ junit
+ 4.11
+ test
+
+
+
+
+
+
+ org.apache.maven.plugins
+ maven-compiler-plugin
+ 3.1
+
+ ${java.version}
+ ${java.version}
+
+
+
+
+
diff --git a/testlib/src/main/resources/pom/pom_dirty.xml b/testlib/src/main/resources/pom/pom_dirty.xml
new file mode 100644
index 0000000000..6d019c7df6
--- /dev/null
+++ b/testlib/src/main/resources/pom/pom_dirty.xml
@@ -0,0 +1,41 @@
+
+ minimal-pom
+ 4.0.0
+
+ spotless.test
+ jar
+ 1.0-SNAPSHOT
+
+ minimal-pom
+ http://maven.apache.org
+
+
+ UTF-8
+ 1.8
+
+
+
+
+
+ org.apache.maven.plugins
+ maven-compiler-plugin
+ 3.1
+
+ ${java.version}
+ ${java.version}
+
+
+
+
+
+
+
+ junit
+ junit
+ 4.11
+ test
+
+
+
diff --git a/testlib/src/test/java/com/diffplug/spotless/pom/SortPomTest.java b/testlib/src/test/java/com/diffplug/spotless/pom/SortPomTest.java
new file mode 100644
index 0000000000..f397962086
--- /dev/null
+++ b/testlib/src/test/java/com/diffplug/spotless/pom/SortPomTest.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2021 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.spotless.pom;
+
+import org.junit.jupiter.api.Test;
+
+import com.diffplug.spotless.Provisioner;
+import com.diffplug.spotless.StepHarness;
+import com.diffplug.spotless.TestProvisioner;
+
+public class SortPomTest {
+ @Test
+ public void testSortPomWithDefaultConfig() throws Exception {
+ SortPomCfg cfg = new SortPomCfg();
+ Provisioner provisioner = TestProvisioner.mavenCentral();
+ StepHarness harness = StepHarness.forStep(SortPomStep.create(cfg, provisioner));
+ harness.testResource("pom/pom_dirty.xml", "pom/pom_clean_default.xml");
+ }
+}