Remove unused isScript param in Ktlint format step

Goooler · Goooler · commit b383706804b4 · 2023-11-21T12:01:34.000+08:00
diff --git a/lib/src/compatKtLint0Dot48Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot48Dot0Adapter.java b/lib/src/compatKtLint0Dot48Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot48Dot0Adapter.java
@@ -76,7 +76,6 @@ public Unit invoke(LintError lint, Boolean corrected) {
 	public String format(
 			String text,
 			Path path,
-			boolean isScript,
 			Path editorConfigPath,
 			Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
diff --git a/lib/src/compatKtLint0Dot49Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot49Dot0Adapter.java b/lib/src/compatKtLint0Dot49Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot49Dot0Adapter.java
@@ -122,7 +122,6 @@ public Unit invoke(LintError lint, Boolean corrected) {
 	public String format(
 			String text,
 			Path path,
-			boolean isScript,
 			Path editorConfigPath,
 			Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
diff --git a/lib/src/compatKtLint0Dot50Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot50Dot0Adapter.java b/lib/src/compatKtLint0Dot50Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot50Dot0Adapter.java
@@ -85,7 +85,6 @@ public Unit invoke(LintError lint, Boolean corrected) {
 	public String format(
 			String text,
 			Path path,
-			boolean isScript,
 			Path editorConfigPath,
 			Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
diff --git a/lib/src/compatKtLint1Dot0Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat1Dot0Dot0Adapter.java b/lib/src/compatKtLint1Dot0Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat1Dot0Dot0Adapter.java
@@ -85,7 +85,6 @@ public Unit invoke(LintError lint, Boolean corrected) {
 	public String format(
 			String text,
 			Path path,
-			boolean isScript,
 			Path editorConfigPath,
 			Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
diff --git a/lib/src/compatKtLintApi/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompatAdapter.java b/lib/src/compatKtLintApi/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompatAdapter.java
@@ -23,7 +23,6 @@ public interface KtLintCompatAdapter {
 	String format(
 			String text,
 			Path path,
-			boolean isScript,
 			Path editorConfigPath,
 			Map<String, Object> editorConfigOverrideMap);
 }
diff --git a/lib/src/ktlint/java/com/diffplug/spotless/glue/ktlint/KtlintFormatterFunc.java b/lib/src/ktlint/java/com/diffplug/spotless/glue/ktlint/KtlintFormatterFunc.java
@@ -25,12 +25,11 @@
 
 public class KtlintFormatterFunc implements FormatterFunc.NeedsFile {
 
-	private final boolean isScript;
 	private final KtLintCompatAdapter adapter;
 	private final FileSignature editorConfigPath;
 	private final Map<String, Object> editorConfigOverrideMap;
 
-	public KtlintFormatterFunc(String version, boolean isScript, FileSignature editorConfigPath,
+	public KtlintFormatterFunc(String version, FileSignature editorConfigPath,
 			Map<String, Object> editorConfigOverrideMap) {
 		String[] versions = version.split("\\.");
 		int majorVersion = Integer.parseInt(versions[0]);
@@ -57,7 +56,6 @@ public KtlintFormatterFunc(String version, boolean isScript, FileSignature edito
 		}
 		this.editorConfigPath = editorConfigPath;
 		this.editorConfigOverrideMap = editorConfigOverrideMap;
-		this.isScript = isScript;
 	}
 
 	@Override
@@ -67,6 +65,6 @@ public String applyWithFile(String unix, File file) {
 		if (editorConfigPath != null) {
 			absoluteEditorConfigPath = editorConfigPath.getOnlyFile().toPath();
 		}
-		return adapter.format(unix, file.toPath(), isScript, absoluteEditorConfigPath, editorConfigOverrideMap);
+		return adapter.format(unix, file.toPath(), absoluteEditorConfigPath, editorConfigOverrideMap);
 	}
 }
diff --git a/lib/src/main/java/com/diffplug/spotless/kotlin/KtLintStep.java b/lib/src/main/java/com/diffplug/spotless/kotlin/KtLintStep.java
@@ -46,23 +46,17 @@ public static FormatterStep create(Provisioner provisioner) {
 	}
 
 	public static FormatterStep create(String version, Provisioner provisioner) {
-		return create(version, provisioner, Collections.emptyMap());
-	}
-
-	public static FormatterStep create(String version, Provisioner provisioner,
-			Map<String, Object> editorConfigOverride) {
-		return create(version, provisioner, false, null, editorConfigOverride);
+		return create(version, provisioner, null, Collections.emptyMap());
 	}
 
 	public static FormatterStep create(String version,
 			Provisioner provisioner,
-			boolean isScript,
 			@Nullable FileSignature editorConfig,
 			Map<String, Object> editorConfigOverride) {
 		Objects.requireNonNull(version, "version");
 		Objects.requireNonNull(provisioner, "provisioner");
 		return FormatterStep.createLazy(NAME,
-				() -> new State(version, provisioner, isScript, editorConfig, editorConfigOverride),
+				() -> new State(version, provisioner, editorConfig, editorConfigOverride),
 				State::createFormat);
 	}
 
@@ -72,9 +66,6 @@ public static String defaultVersion() {
 
 	static final class State implements Serializable {
 		private static final long serialVersionUID = 1L;
-
-		/** Are the files being linted Kotlin script files. */
-		private final boolean isScript;
 		/** The jar that contains the formatter. */
 		final JarState jarState;
 		private final TreeMap<String, Object> editorConfigOverride;
@@ -84,23 +75,21 @@ static final class State implements Serializable {
 
 		State(String version,
 				Provisioner provisioner,
-				boolean isScript,
 				@Nullable FileSignature editorConfigPath,
 				Map<String, Object> editorConfigOverride) throws IOException {
 			this.version = version;
 			this.editorConfigOverride = new TreeMap<>(editorConfigOverride);
 			this.jarState = JarState.from((version.startsWith("0.") ? MAVEN_COORDINATE_0_DOT : MAVEN_COORDINATE_1_DOT) + version,
 					provisioner);
 			this.editorConfigPath = editorConfigPath;
-			this.isScript = isScript;
 		}
 
 		FormatterFunc createFormat() throws Exception {
 			final ClassLoader classLoader = jarState.getClassLoader();
 			Class<?> formatterFunc = classLoader.loadClass("com.diffplug.spotless.glue.ktlint.KtlintFormatterFunc");
 			Constructor<?> constructor = formatterFunc.getConstructor(
 					String.class, boolean.class, FileSignature.class, Map.class);
-			return (FormatterFunc.NeedsFile) constructor.newInstance(version, isScript, editorConfigPath, editorConfigOverride);
+			return (FormatterFunc.NeedsFile) constructor.newInstance(version, editorConfigPath, editorConfigOverride);
 		}
 	}
 }
diff --git a/lib/src/testCompatKtLint0Dot48Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot48Dot0AdapterTest.java b/lib/src/testCompatKtLint0Dot48Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot48Dot0AdapterTest.java
@@ -38,7 +38,7 @@ public void testDefaults(@TempDir Path path) throws IOException {
 
 		Map<String, Object> editorConfigOverrideMap = new HashMap<>();
 
-		String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
+		String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, null, editorConfigOverrideMap);
 		assertEquals("class empty_class_body\n", formatted);
 	}
 
@@ -54,7 +54,7 @@ public void testEditorConfigCanDisable(@TempDir Path path) throws IOException {
 		// ktlint_filename is an invalid rule in ktlint 0.48.0
 		editorConfigOverrideMap.put("ktlint_filename", "disabled");
 
-		String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
+		String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, null, editorConfigOverrideMap);
 		assertEquals("class fails_no_semicolons {\n\tval i = 0;\n}\n", formatted);
 	}
 
diff --git a/lib/src/testCompatKtLint0Dot49Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot49Dot0AdapterTest.java b/lib/src/testCompatKtLint0Dot49Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot49Dot0AdapterTest.java
@@ -38,7 +38,7 @@ public void testDefaults(@TempDir Path path) throws IOException {
 
 		Map<String, Object> editorConfigOverrideMap = new HashMap<>();
 
-		String formatted = ktLintCompat0Dot49Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
+		String formatted = ktLintCompat0Dot49Dot0Adapter.format(text, filePath, null, editorConfigOverrideMap);
 		assertEquals("class EmptyClassBody\n", formatted);
 	}
 
@@ -52,7 +52,7 @@ public void testEditorConfigCanDisable(@TempDir Path path) throws IOException {
 		editorConfigOverrideMap.put("indent_style", "tab");
 		editorConfigOverrideMap.put("ktlint_standard_no-semi", "disabled");
 
-		String formatted = ktLintCompat0Dot49Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
+		String formatted = ktLintCompat0Dot49Dot0Adapter.format(text, filePath, null, editorConfigOverrideMap);
 		assertEquals("class FailsNoSemicolons {\n\tval i = 0;\n}\n", formatted);
 	}
 
diff --git a/lib/src/testCompatKtLint0Dot50Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot50Dot0AdapterTest.java b/lib/src/testCompatKtLint0Dot50Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot50Dot0AdapterTest.java
@@ -38,7 +38,7 @@ public void testDefaults(@TempDir Path path) throws IOException {
 
 		Map<String, Object> editorConfigOverrideMap = new HashMap<>();
 
-		String formatted = KtLintCompat0Dot50Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
+		String formatted = KtLintCompat0Dot50Dot0Adapter.format(text, filePath, null, editorConfigOverrideMap);
 		assertEquals("class EmptyClassBody\n", formatted);
 	}
 
@@ -52,7 +52,7 @@ public void testEditorConfigCanDisable(@TempDir Path path) throws IOException {
 		editorConfigOverrideMap.put("indent_style", "tab");
 		editorConfigOverrideMap.put("ktlint_standard_no-semi", "disabled");
 
-		String formatted = KtLintCompat0Dot50Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
+		String formatted = KtLintCompat0Dot50Dot0Adapter.format(text, filePath, null, editorConfigOverrideMap);
 		assertEquals("class FailsNoSemicolons {\n\tval i = 0;\n}\n", formatted);
 	}
 
diff --git a/lib/src/testCompatKtLint1Dot0Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat1Dot0Dot0AdapterTest.java b/lib/src/testCompatKtLint1Dot0Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat1Dot0Dot0AdapterTest.java
@@ -38,7 +38,7 @@ public void testDefaults(@TempDir Path path) throws IOException {
 
 		Map<String, Object> editorConfigOverrideMap = new HashMap<>();
 
-		String formatted = KtLintCompat1Dot0Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
+		String formatted = KtLintCompat1Dot0Dot0Adapter.format(text, filePath, null, editorConfigOverrideMap);
 		assertEquals("class EmptyClassBody\n", formatted);
 	}
 
@@ -52,7 +52,7 @@ public void testEditorConfigCanDisable(@TempDir Path path) throws IOException {
 		editorConfigOverrideMap.put("indent_style", "tab");
 		editorConfigOverrideMap.put("ktlint_standard_no-semi", "disabled");
 
-		String formatted = KtLintCompat1Dot0Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);
+		String formatted = KtLintCompat1Dot0Dot0Adapter.format(text, filePath, null, editorConfigOverrideMap);
 		assertEquals("class FailsNoSemicolons {\n\tval i = 0;\n}\n", formatted);
 	}
 
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/BaseKotlinExtension.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/BaseKotlinExtension.java
@@ -186,7 +186,6 @@ private FormatterStep createStep() {
 			return KtLintStep.create(
 					version,
 					provisioner(),
-					isScript(),
 					editorConfigPath,
 					editorConfigOverride);
 		}
diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/kotlin/Ktlint.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/kotlin/Ktlint.java
@@ -47,6 +47,6 @@ public FormatterStep newFormatterStep(final FormatterStepConfig stepConfig) {
 			editorConfigOverride = new HashMap<>();
 		}
 
-		return KtLintStep.create(ktlintVersion, stepConfig.getProvisioner(), false, configPath, editorConfigOverride);
+		return KtLintStep.create(ktlintVersion, stepConfig.getProvisioner(), configPath, editorConfigOverride);
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,6 @@ public interface KtLintCompatAdapter {`
`23`	`23`	`String format(`
`24`	`24`	`String text,`
`25`	`25`	`Path path,`
`26`		`- boolean isScript,`
`27`	`26`	`Path editorConfigPath,`
`28`	`27`	`Map<String, Object> editorConfigOverrideMap);`
`29`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,12 +25,11 @@`
`25`	`25`
`26`	`26`	`public class KtlintFormatterFunc implements FormatterFunc.NeedsFile {`
`27`	`27`
`28`		`- private final boolean isScript;`
`29`	`28`	`private final KtLintCompatAdapter adapter;`
`30`	`29`	`private final FileSignature editorConfigPath;`
`31`	`30`	`private final Map<String, Object> editorConfigOverrideMap;`
`32`	`31`
`33`		`- public KtlintFormatterFunc(String version, boolean isScript, FileSignature editorConfigPath,`
	`32`	`+ public KtlintFormatterFunc(String version, FileSignature editorConfigPath,`
`34`	`33`	`Map<String, Object> editorConfigOverrideMap) {`
`35`	`34`	`String[] versions = version.split("\\.");`
`36`	`35`	`int majorVersion = Integer.parseInt(versions[0]);`
`@@ -57,7 +56,6 @@ public KtlintFormatterFunc(String version, boolean isScript, FileSignature edito`
`57`	`56`	`}`
`58`	`57`	`this.editorConfigPath = editorConfigPath;`
`59`	`58`	`this.editorConfigOverrideMap = editorConfigOverrideMap;`
`60`		`- this.isScript = isScript;`
`61`	`59`	`}`
`62`	`60`
`63`	`61`	`@Override`
`@@ -67,6 +65,6 @@ public String applyWithFile(String unix, File file) {`
`67`	`65`	`if (editorConfigPath != null) {`
`68`	`66`	`absoluteEditorConfigPath = editorConfigPath.getOnlyFile().toPath();`
`69`	`67`	`}`
`70`		`- return adapter.format(unix, file.toPath(), isScript, absoluteEditorConfigPath, editorConfigOverrideMap);`
	`68`	`+ return adapter.format(unix, file.toPath(), absoluteEditorConfigPath, editorConfigOverrideMap);`
`71`	`69`	`}`
`72`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public void testDefaults(@TempDir Path path) throws IOException {`
`38`	`38`
`39`	`39`	`Map<String, Object> editorConfigOverrideMap = new HashMap<>();`
`40`	`40`
`41`		`- String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);`
	`41`	`+ String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, null, editorConfigOverrideMap);`
`42`	`42`	`assertEquals("class empty_class_body\n", formatted);`
`43`	`43`	`}`
`44`	`44`
`@@ -54,7 +54,7 @@ public void testEditorConfigCanDisable(@TempDir Path path) throws IOException {`
`54`	`54`	`// ktlint_filename is an invalid rule in ktlint 0.48.0`
`55`	`55`	`editorConfigOverrideMap.put("ktlint_filename", "disabled");`
`56`	`56`
`57`		`- String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, false, null, editorConfigOverrideMap);`
	`57`	`+ String formatted = ktLintCompat0Dot48Dot0Adapter.format(text, filePath, null, editorConfigOverrideMap);`
`58`	`58`	`assertEquals("class fails_no_semicolons {\n\tval i = 0;\n}\n", formatted);`
`59`	`59`	`}`
`60`	`60`
Original file line number	Diff line number	Diff line change
`@@ -186,7 +186,6 @@ private FormatterStep createStep() {`
`186`	`186`	`return KtLintStep.create(`
`187`	`187`	`version,`
`188`	`188`	`provisioner(),`
`189`		`- isScript(),`
`190`	`189`	`editorConfigPath,`
`191`	`190`	`editorConfigOverride);`
`192`	`191`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,6 @@ public FormatterStep newFormatterStep(final FormatterStepConfig stepConfig) {`
`47`	`47`	`editorConfigOverride = new HashMap<>();`
`48`	`48`	`}`
`49`	`49`
`50`		`- return KtLintStep.create(ktlintVersion, stepConfig.getProvisioner(), false, configPath, editorConfigOverride);`
	`50`	`+ return KtLintStep.create(ktlintVersion, stepConfig.getProvisioner(), configPath, editorConfigOverride);`
`51`	`51`	`}`
`52`	`52`	`}`