Add option to configure management of trailing commas in ktfmt (#2177)

Author: hick209

CHANGES.md

@@ -16,6 +16,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 * Renamed property `ktfmt` option `removeUnusedImport` -> `removeUnusedImports` to match `ktfmt`. ([#2172](https://github.com/diffplug/spotless/pull/2172))
 ### Fixed
 * Fix compatibility issue introduced by `ktfmt` `0.51`. ([#2172](https://github.com/diffplug/spotless/issues/2172))
+### Added
+* Added option `manageTrailingCommas` to `ktfmt`. ([#2177](https://github.com/diffplug/spotless/pull/2177))
 
 ## [3.0.0.BETA1] - 2024-06-04
 ### Added

lib/src/ktfmt/java/com/diffplug/spotless/glue/ktfmt/KtfmtFormatterFunc.java

@@ -75,8 +75,8 @@ private FormattingOptions createFormattingOptions() throws Exception {
 ktfmtFormattingOptions.getMaxWidth().orElse(formattingOptions.getMaxWidth()),
 ktfmtFormattingOptions.getBlockIndent().orElse(formattingOptions.getBlockIndent()),
 ktfmtFormattingOptions.getContinuationIndent().orElse(formattingOptions.getContinuationIndent()),
-formattingOptions.getManageTrailingCommas(),
-ktfmtFormattingOptions.getRemoveUnusedImport().orElse(formattingOptions.getRemoveUnusedImports()),
+ktfmtFormattingOptions.getManageTrailingCommas().orElse(formattingOptions.getManageTrailingCommas()),
+ktfmtFormattingOptions.getRemoveUnusedImports().orElse(formattingOptions.getRemoveUnusedImports()),
 formattingOptions.getDebuggingPrintOpsAfterFormatting());
 }
 

lib/src/ktfmt/java/com/diffplug/spotless/glue/ktfmt/KtfmtFormattingOptions.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,17 +32,22 @@ public final class KtfmtFormattingOptions {
 private Integer continuationIndent;
 
 @Nullable
-private Boolean removeUnusedImport;
+private Boolean removeUnusedImports;
+
+@Nullable
+private Boolean manageTrailingCommas;
 
 public KtfmtFormattingOptions(
 @Nullable Integer maxWidth,
 @Nullable Integer blockIndent,
 @Nullable Integer continuationIndent,
-@Nullable Boolean removeUnusedImport) {
+@Nullable Boolean removeUnusedImports,
+@Nullable Boolean manageTrailingCommas) {
 this.maxWidth = maxWidth;
 this.blockIndent = blockIndent;
 this.continuationIndent = continuationIndent;
-this.removeUnusedImport = removeUnusedImport;
+this.removeUnusedImports = removeUnusedImports;
+this.manageTrailingCommas = manageTrailingCommas;
 }
 
 @Nonnull
@@ -61,8 +66,13 @@ public Optional<Integer> getContinuationIndent() {
 }
 
 @Nonnull
-public Optional<Boolean> getRemoveUnusedImport() {
-return Optional.ofNullable(removeUnusedImport);
+public Optional<Boolean> getRemoveUnusedImports() {
+return Optional.ofNullable(removeUnusedImports);
+}
+
+@Nonnull
+public Optional<Boolean> getManageTrailingCommas() {
+return Optional.ofNullable(manageTrailingCommas);
 }
 
 public void setMaxWidth(int maxWidth) {
@@ -86,7 +96,11 @@ public void setContinuationIndent(int continuationIndent) {
 this.continuationIndent = continuationIndent;
 }
 
-public void setRemoveUnusedImport(boolean removeUnusedImport) {
-this.removeUnusedImport = removeUnusedImport;
+public void setRemoveUnusedImports(boolean removeUnusedImports) {
+this.removeUnusedImports = removeUnusedImports;
+}
+
+public void setManageTrailingCommas(boolean manageTrailingCommas) {
+this.manageTrailingCommas = manageTrailingCommas;
 }
 }

lib/src/main/java/com/diffplug/spotless/kotlin/KtfmtStep.java

@@ -126,17 +126,22 @@ public static class KtfmtFormattingOptions implements Serializable {
 @Nullable
 private Boolean removeUnusedImports = null;
 
+@Nullable
+private Boolean manageTrailingCommas = null;
+
 public KtfmtFormattingOptions() {}
 
 public KtfmtFormattingOptions(
 @Nullable Integer maxWidth,
 @Nullable Integer blockIndent,
 @Nullable Integer continuationIndent,
-@Nullable Boolean removeUnusedImports) {
+@Nullable Boolean removeUnusedImports,
+@Nullable Boolean manageTrailingCommas) {
 this.maxWidth = maxWidth;
 this.blockIndent = blockIndent;
 this.continuationIndent = continuationIndent;
 this.removeUnusedImports = removeUnusedImports;
+this.manageTrailingCommas = manageTrailingCommas;
 }
 
 public void setMaxWidth(int maxWidth) {
@@ -154,6 +159,10 @@ public void setContinuationIndent(int continuationIndent) {
 public void setRemoveUnusedImports(boolean removeUnusedImports) {
 this.removeUnusedImports = removeUnusedImports;
 }
+
+public void setManageTrailingCommas(boolean manageTrailingCommas) {
+this.manageTrailingCommas = manageTrailingCommas;
+}
 }
 
 /** Creates a step which formats everything - code, import order, and unused imports. */
@@ -228,9 +237,9 @@ FormatterFunc createFormat() throws Exception {
 }
 
 final Constructor<?> optionsConstructor = ktfmtFormattingOptionsClass.getConstructor(
-Integer.class, Integer.class, Integer.class, Boolean.class);
+Integer.class, Integer.class, Integer.class, Boolean.class, Boolean.class);
 final Object ktfmtFormattingOptions = optionsConstructor.newInstance(
-options.maxWidth, options.blockIndent, options.continuationIndent, options.removeUnusedImports);
+options.maxWidth, options.blockIndent, options.continuationIndent, options.removeUnusedImports, options.manageTrailingCommas);
 if (style == null) {
 final Constructor<?> constructor = formatterFuncClass.getConstructor(ktfmtFormattingOptionsClass);
 return (FormatterFunc) constructor.newInstance(ktfmtFormattingOptions);
@@ -365,7 +374,7 @@ private Object getCustomFormattingOptions(Class<?> formatterClass) throws Except
 /* continuationIndent = */ Optional.ofNullable(options.continuationIndent).orElse((Integer) formattingOptionsClass.getMethod("getContinuationIndent").invoke(formattingOptions)),
 /* removeUnusedImports = */ Optional.ofNullable(options.removeUnusedImports).orElse((Boolean) formattingOptionsClass.getMethod("getRemoveUnusedImports").invoke(formattingOptions)),
 /* debuggingPrintOpsAfterFormatting = */ (Boolean) formattingOptionsClass.getMethod("getDebuggingPrintOpsAfterFormatting").invoke(formattingOptions),
-/* manageTrailingCommas */ (Boolean) formattingOptionsClass.getMethod("getManageTrailingCommas").invoke(formattingOptions));
+/* manageTrailingCommas */ Optional.ofNullable(options.manageTrailingCommas).orElse((Boolean) formattingOptionsClass.getMethod("getManageTrailingCommas").invoke(formattingOptions)));
 }
 }
 

plugin-gradle/CHANGES.md

@@ -9,6 +9,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 * Renamed property `ktfmt` option `removeUnusedImport` -> `removeUnusedImports` to match `ktfmt`. ([#2172](https://github.com/diffplug/spotless/pull/2172))
 ### Fixed
 * Fix compatibility issue introduced by `ktfmt` `0.51`. ([#2172](https://github.com/diffplug/spotless/issues/2172))
+### Added
+* Added option `manageTrailingCommas` to `ktfmt`. ([#2177](https://github.com/diffplug/spotless/pull/2177))
 
 ## [7.0.0.BETA1] - 2024-06-04
 ### Added

plugin-gradle/README.md

@@ -399,6 +399,7 @@ spotless {
  it.setBlockIndent(4)
  it.setContinuationIndent(4)
  it.setRemoveUnusedImports(false)
+ it.setManageTrailingCommas(false)
  }
  }
 }

plugin-gradle/src/test/java/com/diffplug/gradle/spotless/KotlinExtensionTest.java

@@ -59,6 +59,7 @@ void integrationKtfmtDropboxStyleWithPublicApi() throws IOException {
 " it.setBlockIndent(4)",
 " it.setContinuationIndent(4)",
 " it.setRemoveUnusedImports(false)",
+" it.setManageTrailingCommas(false)",
 " }",
 " }",
 "}");

plugin-maven/CHANGES.md

@@ -9,6 +9,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 * Renamed property `ktfmt` option `removeUnusedImport` -> `removeUnusedImports` to match `ktfmt`. ([#2172](https://github.com/diffplug/spotless/pull/2172))
 ### Fixed
 * Fix compatibility issue introduced by `ktfmt` `0.51`. ([#2172](https://github.com/diffplug/spotless/issues/2172))
+### Added
+* Added option `manageTrailingCommas` to `ktfmt`. ([#2177](https://github.com/diffplug/spotless/pull/2177))
 
 ## [2.44.0.BETA1] - 2024-06-04
 ### Added

plugin-maven/README.md

@@ -402,6 +402,7 @@ Groovy-Eclipse formatting errors/warnings lead per default to a build failure. T
  <blockIndent>4</blockIndent> <!-- optional -->
  <continuationIndent>8</continuationIndent> <!-- optional -->
  <removeUnusedImports>false</removeUnusedImports> <!-- optional -->
+ <manageTrailingCommas>true</manageTrailingCommas> <!-- optional -->
 </ktfmt>
 ```
 

plugin-maven/src/main/java/com/diffplug/spotless/maven/kotlin/Ktfmt.java

@@ -44,11 +44,14 @@ public class Ktfmt implements FormatterStepFactory {
 @Parameter
 private Boolean removeUnusedImports;
 
+@Parameter
+private Boolean manageTrailingCommas;
+
 @Override
 public FormatterStep newFormatterStep(FormatterStepConfig config) {
 String version = this.version != null ? this.version : KtfmtStep.defaultVersion();
 Style style = this.style != null ? Style.valueOf(this.style) : null;
-KtfmtFormattingOptions options = new KtfmtFormattingOptions(maxWidth, blockIndent, continuationIndent, removeUnusedImports);
+KtfmtFormattingOptions options = new KtfmtFormattingOptions(maxWidth, blockIndent, continuationIndent, removeUnusedImports, manageTrailingCommas);
 return KtfmtStep.create(version, config.getProvisioner(), style, options);
 }
 }