Skip to content

Commit a0936e1

Browse files
nedtwiggnedtwigg
authored
Remove unused userData param in Ktlint format step (#1891)
2 parents 2c2c4f7 + 7cb08d1 commit a0936e1

File tree

14 files changed

+48
-68
lines changed

14 files changed

+48
-68
lines changed

‎lib/src/compatKtLint0Dot48Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot48Dot0Adapter.java

+6-3
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,12 @@ public Unit invoke(LintError lint, Boolean corrected) {
7373
}
7474

7575
@Override
76-
public String format(final String text, Path path, final boolean isScript,
77-
Path editorConfigPath, final Map<String, String> userData,
78-
final Map<String, Object> editorConfigOverrideMap) {
76+
public String format(
77+
String text,
78+
Path path,
79+
boolean isScript,
80+
Path editorConfigPath,
81+
Map<String, Object> editorConfigOverrideMap) {
7982
final FormatterCallback formatterCallback = new FormatterCallback();
8083

8184
Set<RuleProvider> allRuleProviders = ServiceLoader.load(RuleSetProviderV2.class, RuleSetProviderV2.class.getClassLoader())

‎lib/src/compatKtLint0Dot49Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot49Dot0Adapter.java

+6-3
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,12 @@ public Unit invoke(LintError lint, Boolean corrected) {
119119
}
120120

121121
@Override
122-
public String format(final String text, Path path, final boolean isScript,
123-
Path editorConfigPath, final Map<String, String> userData,
124-
final Map<String, Object> editorConfigOverrideMap) {
122+
public String format(
123+
String text,
124+
Path path,
125+
boolean isScript,
126+
Path editorConfigPath,
127+
Map<String, Object> editorConfigOverrideMap) {
125128
final FormatterCallback formatterCallback = new FormatterCallback();
126129

127130
Set<RuleProvider> allRuleProviders = ServiceLoader.load(RuleSetProviderV3.class, RuleSetProviderV3.class.getClassLoader())

‎lib/src/compatKtLint0Dot50Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot50Dot0Adapter.java

+6-3
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,12 @@ public Unit invoke(LintError lint, Boolean corrected) {
8282
}
8383

8484
@Override
85-
public String format(final String text, Path path, final boolean isScript,
86-
Path editorConfigPath, final Map<String, String> userData,
87-
final Map<String, Object> editorConfigOverrideMap) {
85+
public String format(
86+
String text,
87+
Path path,
88+
boolean isScript,
89+
Path editorConfigPath,
90+
Map<String, Object> editorConfigOverrideMap) {
8891
final FormatterCallback formatterCallback = new FormatterCallback();
8992

9093
Set<RuleProvider> allRuleProviders = ServiceLoader.load(RuleSetProviderV3.class, RuleSetProviderV3.class.getClassLoader())

‎lib/src/compatKtLint1Dot0Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat1Dot0Dot0Adapter.java

+6-3
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,12 @@ public Unit invoke(LintError lint, Boolean corrected) {
8282
}
8383

8484
@Override
85-
public String format(final String text, Path path, final boolean isScript,
86-
Path editorConfigPath, final Map<String, String> userData,
87-
final Map<String, Object> editorConfigOverrideMap) {
85+
public String format(
86+
String text,
87+
Path path,
88+
boolean isScript,
89+
Path editorConfigPath,
90+
Map<String, Object> editorConfigOverrideMap) {
8891
final FormatterCallback formatterCallback = new FormatterCallback();
8992

9093
Set<RuleProvider> allRuleProviders = ServiceLoader.load(RuleSetProviderV3.class, RuleSetProviderV3.class.getClassLoader())

‎lib/src/compatKtLintApi/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompatAdapter.java

+5-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@
2020

2121
public interface KtLintCompatAdapter {
2222

23-
String format(String text, Path path, boolean isScript, Path editorConfigPath, Map<String, String> userData,
23+
String format(
24+
String text,
25+
Path path,
26+
boolean isScript,
27+
Path editorConfigPath,
2428
Map<String, Object> editorConfigOverrideMap);
2529
}

‎lib/src/ktlint/java/com/diffplug/spotless/glue/ktlint/KtlintFormatterFunc.java

+2-4
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,12 @@
2525

2626
public class KtlintFormatterFunc implements FormatterFunc.NeedsFile {
2727

28-
private final Map<String, String> userData;
2928
private final boolean isScript;
3029
private final KtLintCompatAdapter adapter;
3130
private final FileSignature editorConfigPath;
3231
private final Map<String, Object> editorConfigOverrideMap;
3332

34-
public KtlintFormatterFunc(String version, boolean isScript, FileSignature editorConfigPath, Map<String, String> userData,
33+
public KtlintFormatterFunc(String version, boolean isScript, FileSignature editorConfigPath,
3534
Map<String, Object> editorConfigOverrideMap) {
3635
String[] versions = version.split("\\.");
3736
int majorVersion = Integer.parseInt(versions[0]);
@@ -58,7 +57,6 @@ public KtlintFormatterFunc(String version, boolean isScript, FileSignature edito
5857
}
5958
this.editorConfigPath = editorConfigPath;
6059
this.editorConfigOverrideMap = editorConfigOverrideMap;
61-
this.userData = userData;
6260
this.isScript = isScript;
6361
}
6462

@@ -69,6 +67,6 @@ public String applyWithFile(String unix, File file) {
6967
if (editorConfigPath != null) {
7068
absoluteEditorConfigPath = editorConfigPath.getOnlyFile().toPath();
7169
}
72-
return adapter.format(unix, file.toPath(), isScript, absoluteEditorConfigPath, userData, editorConfigOverrideMap);
70+
return adapter.format(unix, file.toPath(), isScript, absoluteEditorConfigPath, editorConfigOverrideMap);
7371
}
7472
}

‎lib/src/main/java/com/diffplug/spotless/kotlin/KtLintStep.java

+6-10
Original file line numberDiff line numberDiff line change
@@ -46,24 +46,23 @@ public static FormatterStep create(Provisioner provisioner) {
4646
}
4747

4848
public static FormatterStep create(String version, Provisioner provisioner) {
49-
return create(version, provisioner, Collections.emptyMap(), Collections.emptyMap());
49+
return create(version, provisioner, Collections.emptyMap());
5050
}
5151

5252
public static FormatterStep create(String version, Provisioner provisioner,
53-
Map<String, String> userData, Map<String, Object> editorConfigOverride) {
54-
return create(version, provisioner, false, null, userData, editorConfigOverride);
53+
Map<String, Object> editorConfigOverride) {
54+
return create(version, provisioner, false, null, editorConfigOverride);
5555
}
5656

5757
public static FormatterStep create(String version,
5858
Provisioner provisioner,
5959
boolean isScript,
6060
@Nullable FileSignature editorConfig,
61-
Map<String, String> userData,
6261
Map<String, Object> editorConfigOverride) {
6362
Objects.requireNonNull(version, "version");
6463
Objects.requireNonNull(provisioner, "provisioner");
6564
return FormatterStep.createLazy(NAME,
66-
() -> new State(version, provisioner, isScript, editorConfig, userData, editorConfigOverride),
65+
() -> new State(version, provisioner, isScript, editorConfig, editorConfigOverride),
6766
State::createFormat);
6867
}
6968

@@ -78,7 +77,6 @@ static final class State implements Serializable {
7877
private final boolean isScript;
7978
/** The jar that contains the formatter. */
8079
final JarState jarState;
81-
private final TreeMap<String, String> userData;
8280
private final TreeMap<String, Object> editorConfigOverride;
8381
private final String version;
8482
@Nullable
@@ -88,10 +86,8 @@ static final class State implements Serializable {
8886
Provisioner provisioner,
8987
boolean isScript,
9088
@Nullable FileSignature editorConfigPath,
91-
Map<String, String> userData,
9289
Map<String, Object> editorConfigOverride) throws IOException {
9390
this.version = version;
94-
this.userData = new TreeMap<>(userData);
9591
this.editorConfigOverride = new TreeMap<>(editorConfigOverride);
9692
this.jarState = JarState.from((version.startsWith("0.") ? MAVEN_COORDINATE_0_DOT : MAVEN_COORDINATE_1_DOT) + version,
9793
provisioner);
@@ -103,8 +99,8 @@ FormatterFunc createFormat() throws Exception {
10399
final ClassLoader classLoader = jarState.getClassLoader();
104100
Class<?> formatterFunc = classLoader.loadClass("com.diffplug.spotless.glue.ktlint.KtlintFormatterFunc");
105101
Constructor<?> constructor = formatterFunc.getConstructor(
106-
String.class, boolean.class, FileSignature.class, Map.class, Map.class);
107-
return (FormatterFunc.NeedsFile) constructor.newInstance(version, isScript, editorConfigPath, userData, editorConfigOverride);
102+
String.class, boolean.class, FileSignature.class, Map.class);
103+
return (FormatterFunc.NeedsFile) constructor.newInstance(version, isScript, editorConfigPath, editorConfigOverride);
108104
}
109105
}
110106
}

‎lib/src/testCompatKtLint0Dot48Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot48Dot0AdapterTest.java

+2-6
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,9 @@ public void testDefaults(@TempDir Path path) throws IOException {
3636
String text = loadAndWriteText(path, "empty_class_body.kt");
3737
final Path filePath = Paths.get(path.toString(), "empty_class_body.kt");
3838

39-
Map<String, String> userData = new HashMap<>();
40-
4139
Map<String, Object> editorConfigOverrideMap = new HashMap<>();
4240

43-
String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, false, null, userData, editorConfigOverrideMap);
41+
String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
4442
assertEquals("class empty_class_body\n", formatted);
4543
}
4644

@@ -50,15 +48,13 @@ public void testEditorConfigCanDisable(@TempDir Path path) throws IOException {
5048
String text = loadAndWriteText(path, "fails_no_semicolons.kt");
5149
final Path filePath = Paths.get(path.toString(), "fails_no_semicolons.kt");
5250

53-
Map<String, String> userData = new HashMap<>();
54-
5551
Map<String, Object> editorConfigOverrideMap = new HashMap<>();
5652
editorConfigOverrideMap.put("indent_style", "tab");
5753
editorConfigOverrideMap.put("ktlint_standard_no-semi", "disabled");
5854
// ktlint_filename is an invalid rule in ktlint 0.48.0
5955
editorConfigOverrideMap.put("ktlint_filename", "disabled");
6056

61-
String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, false, null, userData, editorConfigOverrideMap);
57+
String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
6258
assertEquals("class fails_no_semicolons {\n\tval i = 0;\n}\n", formatted);
6359
}
6460

‎lib/src/testCompatKtLint0Dot49Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot49Dot0AdapterTest.java

+2-6
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,9 @@ public void testDefaults(@TempDir Path path) throws IOException {
3636
String text = loadAndWriteText(path, "EmptyClassBody.kt");
3737
final Path filePath = Paths.get(path.toString(), "EmptyClassBody.kt");
3838

39-
Map<String, String> userData = new HashMap<>();
40-
4139
Map<String, Object> editorConfigOverrideMap = new HashMap<>();
4240

43-
String formatted = ktLintCompat0Dot49Dot0Adapter.format(text, filePath, false, null, userData, editorConfigOverrideMap);
41+
String formatted = ktLintCompat0Dot49Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
4442
assertEquals("class EmptyClassBody\n", formatted);
4543
}
4644

@@ -50,13 +48,11 @@ public void testEditorConfigCanDisable(@TempDir Path path) throws IOException {
5048
String text = loadAndWriteText(path, "FailsNoSemicolons.kt");
5149
final Path filePath = Paths.get(path.toString(), "FailsNoSemicolons.kt");
5250

53-
Map<String, String> userData = new HashMap<>();
54-
5551
Map<String, Object> editorConfigOverrideMap = new HashMap<>();
5652
editorConfigOverrideMap.put("indent_style", "tab");
5753
editorConfigOverrideMap.put("ktlint_standard_no-semi", "disabled");
5854

59-
String formatted = ktLintCompat0Dot49Dot0Adapter.format(text, filePath, false, null, userData, editorConfigOverrideMap);
55+
String formatted = ktLintCompat0Dot49Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
6056
assertEquals("class FailsNoSemicolons {\n\tval i = 0;\n}\n", formatted);
6157
}
6258

‎lib/src/testCompatKtLint0Dot50Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot50Dot0AdapterTest.java

+2-6
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,9 @@ public void testDefaults(@TempDir Path path) throws IOException {
3636
String text = loadAndWriteText(path, "EmptyClassBody.kt");
3737
final Path filePath = Paths.get(path.toString(), "EmptyClassBody.kt");
3838

39-
Map<String, String> userData = new HashMap<>();
40-
4139
Map<String, Object> editorConfigOverrideMap = new HashMap<>();
4240

43-
String formatted = KtLintCompat0Dot50Dot0Adapter.format(text, filePath, false, null, userData, editorConfigOverrideMap);
41+
String formatted = KtLintCompat0Dot50Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
4442
assertEquals("class EmptyClassBody\n", formatted);
4543
}
4644

@@ -50,13 +48,11 @@ public void testEditorConfigCanDisable(@TempDir Path path) throws IOException {
5048
String text = loadAndWriteText(path, "FailsNoSemicolons.kt");
5149
final Path filePath = Paths.get(path.toString(), "FailsNoSemicolons.kt");
5250

53-
Map<String, String> userData = new HashMap<>();
54-
5551
Map<String, Object> editorConfigOverrideMap = new HashMap<>();
5652
editorConfigOverrideMap.put("indent_style", "tab");
5753
editorConfigOverrideMap.put("ktlint_standard_no-semi", "disabled");
5854

59-
String formatted = KtLintCompat0Dot50Dot0Adapter.format(text, filePath, false, null, userData, editorConfigOverrideMap);
55+
String formatted = KtLintCompat0Dot50Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
6056
assertEquals("class FailsNoSemicolons {\n\tval i = 0;\n}\n", formatted);
6157
}
6258

‎lib/src/testCompatKtLint1Dot0Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat1Dot0Dot0AdapterTest.java

+2-6
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,9 @@ public void testDefaults(@TempDir Path path) throws IOException {
3636
String text = loadAndWriteText(path, "EmptyClassBody.kt");
3737
final Path filePath = Paths.get(path.toString(), "EmptyClassBody.kt");
3838

39-
Map<String, String> userData = new HashMap<>();
40-
4139
Map<String, Object> editorConfigOverrideMap = new HashMap<>();
4240

43-
String formatted = KtLintCompat1Dot0Dot0Adapter.format(text, filePath, false, null, userData, editorConfigOverrideMap);
41+
String formatted = KtLintCompat1Dot0Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
4442
assertEquals("class EmptyClassBody\n", formatted);
4543
}
4644

@@ -50,13 +48,11 @@ public void testEditorConfigCanDisable(@TempDir Path path) throws IOException {
5048
String text = loadAndWriteText(path, "FailsNoSemicolons.kt");
5149
final Path filePath = Paths.get(path.toString(), "FailsNoSemicolons.kt");
5250

53-
Map<String, String> userData = new HashMap<>();
54-
5551
Map<String, Object> editorConfigOverrideMap = new HashMap<>();
5652
editorConfigOverrideMap.put("indent_style", "tab");
5753
editorConfigOverrideMap.put("ktlint_standard_no-semi", "disabled");
5854

59-
String formatted = KtLintCompat1Dot0Dot0Adapter.format(text, filePath, false, null, userData, editorConfigOverrideMap);
55+
String formatted = KtLintCompat1Dot0Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
6056
assertEquals("class FailsNoSemicolons {\n\tval i = 0;\n}\n", formatted);
6157
}
6258

‎plugin-gradle/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -399,9 +399,8 @@ Additionally, `editorConfigOverride` options will override what's supplied in `.
399399
```kotlin
400400
spotless {
401401
kotlin {
402-
// version, userData and editorConfigOverride are all optional
402+
// version, editorConfigPath and editorConfigOverride are all optional
403403
ktlint("1.0.0")
404-
.userData(mapOf("android" to "true"))
405404
.setEditorConfigPath("$projectDir/config/.editorconfig") // sample unusual placement
406405
.editorConfigOverride(
407406
mapOf(

‎plugin-gradle/src/main/java/com/diffplug/gradle/spotless/BaseKotlinExtension.java

+1-13
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public KtlintConfig ktlint() throws IOException {
5151

5252
/** Adds the specified version of <a href="https://github.com/pinterest/ktlint">ktlint</a>. */
5353
public KtlintConfig ktlint(String version) throws IOException {
54-
return new KtlintConfig(version, Collections.emptyMap(), Collections.emptyMap());
54+
return new KtlintConfig(version, Collections.emptyMap());
5555
}
5656

5757
/** Uses the <a href="https://github.com/facebookincubator/ktfmt">ktfmt</a> jar to format source code. */
@@ -146,19 +146,16 @@ private void configure(Consumer<KtfmtStep.KtfmtFormattingOptions> optionsConfigu
146146
public class KtlintConfig {
147147
private final String version;
148148
private FileSignature editorConfigPath;
149-
private Map<String, String> userData;
150149
private Map<String, Object> editorConfigOverride;
151150

152151
private KtlintConfig(
153152
String version,
154-
Map<String, String> userData,
155153
Map<String, Object> editorConfigOverride) throws IOException {
156154
Objects.requireNonNull(version);
157155
File defaultEditorConfig = getProject().getRootProject().file(".editorconfig");
158156
FileSignature editorConfigPath = defaultEditorConfig.exists() ? FileSignature.signAsList(defaultEditorConfig) : null;
159157
this.version = version;
160158
this.editorConfigPath = editorConfigPath;
161-
this.userData = userData;
162159
this.editorConfigOverride = editorConfigOverride;
163160
addStep(createStep());
164161
}
@@ -177,14 +174,6 @@ public KtlintConfig setEditorConfigPath(@Nullable Object editorConfigPath) throw
177174
return this;
178175
}
179176

180-
public KtlintConfig userData(Map<String, String> userData) {
181-
// Copy the map to a sorted map because up-to-date checking is based on binary-equals of the serialized
182-
// representation.
183-
this.userData = ImmutableSortedMap.copyOf(userData);
184-
replaceStep(createStep());
185-
return this;
186-
}
187-
188177
public KtlintConfig editorConfigOverride(Map<String, Object> editorConfigOverride) {
189178
// Copy the map to a sorted map because up-to-date checking is based on binary-equals of the serialized
190179
// representation.
@@ -199,7 +188,6 @@ private FormatterStep createStep() {
199188
provisioner(),
200189
isScript(),
201190
editorConfigPath,
202-
userData,
203191
editorConfigOverride);
204192
}
205193
}

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
*/
1616
package com.diffplug.spotless.maven.kotlin;
1717

18-
import java.util.Collections;
1918
import java.util.HashMap;
2019
import java.util.Map;
2120

@@ -48,6 +47,6 @@ public FormatterStep newFormatterStep(final FormatterStepConfig stepConfig) {
4847
editorConfigOverride = new HashMap<>();
4948
}
5049

51-
return KtLintStep.create(ktlintVersion, stepConfig.getProvisioner(), false, configPath, Collections.emptyMap(), editorConfigOverride);
50+
return KtLintStep.create(ktlintVersion, stepConfig.getProvisioner(), false, configPath, editorConfigOverride);
5251
}
5352
}

0 commit comments

Comments
 (0)