Support ktfmt dropbox style in maven plugin (#764)

diffplug · Jan 3, 2021 · 49af781 · 49af781
2 parents 2e59dfa + 3f48d2c
commit 49af781
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 6 deletions.
diff --git a/lib/src/main/java/com/diffplug/spotless/kotlin/KtfmtStep.java b/lib/src/main/java/com/diffplug/spotless/kotlin/KtfmtStep.java
@@ -79,6 +79,10 @@ public static String defaultVersion() {
 		return DEFAULT_VERSION;
 	}
 
+	public static String defaultStyle() {
+		return Style.DEFAULT.name();
+	}
+
 	static final class State implements Serializable {
 		private static final long serialVersionUID = 1L;
 

diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/KotlinExtension.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/KotlinExtension.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 DiffPlug
+ * Copyright 2016-2021 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -109,7 +109,11 @@ public class KtfmtConfig {
 		}
 
 		public void dropboxStyle() {
-			style = Style.DROPBOX;
+			style(Style.DROPBOX);
+		}
+
+		public void style(Style style) {
+			this.style = style;
 			replaceStep(createStep());
 		}
 

diff --git a/plugin-maven/CHANGES.md b/plugin-maven/CHANGES.md
@@ -7,6 +7,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 * Added support for eclipse-cdt 4.18.0.
 * Added support for eclipse-jdt 4.18.0.
 * Added support for eclipse-wtp 4.18.0.
+* Added ability to specify dropbox style for ktfmt `<style>DROPBOX</style>` ([#764](https://github.com/diffplug/spotless/pull/764))
 ### Changed
 * Updated default eclipse-jdt from 4.17.0 to 4.18.0.
 * Updated default eclipse-wtp from 4.17.0 to 4.18.0.

diff --git a/plugin-maven/README.md b/plugin-maven/README.md
@@ -306,7 +306,8 @@ Groovy-Eclipse formatting errors/warnings lead per default to a build failure. T
 
 ```xml
 <ktfmt>
-  <version>0.13</version> <!-- optional -->
+  <version>0.18</version> <!-- optional -->
+  <style>DEFAULT</style> <!-- optional, other option is DROPBOX -->
 </ktfmt>
 ```
 

diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/kotlin/Ktfmt.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/kotlin/Ktfmt.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 DiffPlug
+ * Copyright 2016-2021 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,7 @@
 
 import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.kotlin.KtfmtStep;
+import com.diffplug.spotless.kotlin.KtfmtStep.Style;
 import com.diffplug.spotless.maven.FormatterStepConfig;
 import com.diffplug.spotless.maven.FormatterStepFactory;
 
@@ -27,9 +28,13 @@ public class Ktfmt implements FormatterStepFactory {
 	@Parameter
 	private String version;
 
+	@Parameter
+	private String style;
+
 	@Override
 	public FormatterStep newFormatterStep(FormatterStepConfig config) {
 		String version = this.version != null ? this.version : KtfmtStep.defaultVersion();
-		return KtfmtStep.create(version, config.getProvisioner());
+		String style = this.style != null ? this.style : KtfmtStep.defaultStyle();
+		return KtfmtStep.create(version, config.getProvisioner(), Style.valueOf(style));
 	}
 }
diff --git a/plugin-maven/src/test/java/com/diffplug/spotless/maven/kotlin/KtfmtTest.java b/plugin-maven/src/test/java/com/diffplug/spotless/maven/kotlin/KtfmtTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 DiffPlug
+ * Copyright 2016-2021 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,4 +39,16 @@ public void testKtfmt() throws Exception {
 		assertFile(path1).sameAsResource("kotlin/ktfmt/basic.clean");
 		assertFile(path2).sameAsResource("kotlin/ktfmt/basic.clean");
 	}
+
+	@Test
+	public void testKtfmtStyle() throws Exception {
+		// ktfmt's dependency, google-java-format 1.8 requires a minimum of JRE 11+.
+		JreVersion.assume11OrGreater();
+
+		writePomWithKotlinSteps("<ktfmt><style>DROPBOX</style></ktfmt>");
+
+		setFile("src/main/kotlin/main.kt").toResource("kotlin/ktfmt/basic.dirty");
+		mavenRunner().withArguments("spotless:apply").runNoError();
+		assertFile("src/main/kotlin/main.kt").sameAsResource("kotlin/ktfmt/basic-dropboxstyle.clean");
+	}
 }