Add editor config file option to maven and gradle

eirnym · eirnym · commit 9df255ed3c1a · 2023-01-03T00:06:41.000+01:00
diff --git a/lib/src/compatKtLint0Dot31Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot31Dot0Adapter.java b/lib/src/compatKtLint0Dot31Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot31Dot0Adapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -43,7 +43,7 @@ public Unit invoke(LintError lint, Boolean corrected) {
 	@Override
 	public String format(final String text, final String name, final boolean isScript,
 			final boolean useExperimental,
-			final Map<String, String> userData,
+			String editorConfigPath, final Map<String, String> userData,
 			final Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
 
diff --git a/lib/src/compatKtLint0Dot32Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot32Dot0Adapter.java b/lib/src/compatKtLint0Dot32Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot32Dot0Adapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -43,7 +43,7 @@ public Unit invoke(LintError lint, Boolean corrected) {
 	@Override
 	public String format(final String text, final String name, final boolean isScript,
 			final boolean useExperimental,
-			final Map<String, String> userData,
+			String editorConfigPath, final Map<String, String> userData,
 			final Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
 
diff --git a/lib/src/compatKtLint0Dot34Dot2/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot34Dot2Adapter.java b/lib/src/compatKtLint0Dot34Dot2/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot34Dot2Adapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -43,7 +43,7 @@ public Unit invoke(LintError lint, Boolean corrected) {
 	@Override
 	public String format(final String text, final String name, final boolean isScript,
 			final boolean useExperimental,
-			final Map<String, String> userData,
+			String editorConfigPath, final Map<String, String> userData,
 			final Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
 
@@ -61,7 +61,7 @@ public String format(final String text, final String name, final boolean isScrip
 				userData,
 				formatterCallback,
 				isScript,
-				null,
+				editorConfigPath,
 				false));
 	}
 }
diff --git a/lib/src/compatKtLint0Dot45Dot2/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot45Dot2Adapter.java b/lib/src/compatKtLint0Dot45Dot2/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot45Dot2Adapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -51,7 +51,7 @@ public Unit invoke(LintError lint, Boolean corrected) {
 	@Override
 	public String format(final String text, final String name, final boolean isScript,
 			final boolean useExperimental,
-			final Map<String, String> userData,
+			String editorConfigPath, final Map<String, String> userData,
 			final Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
 
@@ -76,7 +76,7 @@ public String format(final String text, final String name, final boolean isScrip
 				userData,
 				formatterCallback,
 				isScript,
-				null,
+				editorConfigPath,
 				false,
 				editorConfigOverride,
 				false));
diff --git a/lib/src/compatKtLint0Dot46Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot46Dot0Adapter.java b/lib/src/compatKtLint0Dot46Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot46Dot0Adapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -51,7 +51,7 @@ public Unit invoke(LintError lint, Boolean corrected) {
 	@Override
 	public String format(final String text, final String name, final boolean isScript,
 			final boolean useExperimental,
-			final Map<String, String> userData,
+			String editorConfigPath, final Map<String, String> userData,
 			final Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
 
@@ -76,7 +76,7 @@ public String format(final String text, final String name, final boolean isScrip
 				userData,
 				formatterCallback,
 				isScript,
-				null,
+				editorConfigPath,
 				false,
 				editorConfigOverride,
 				false));
diff --git a/lib/src/compatKtLint0Dot47Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot47Dot0Adapter.java b/lib/src/compatKtLint0Dot47Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot47Dot0Adapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,8 @@
 
 import static java.util.Collections.emptySet;
 
+import java.io.File;
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.LinkedHashSet;
 import java.util.List;
@@ -56,7 +58,7 @@ public Unit invoke(LintError lint, Boolean corrected) {
 	@Override
 	public String format(final String text, final String name, final boolean isScript,
 			final boolean useExperimental,
-			final Map<String, String> userData,
+			String editorConfigPath, final Map<String, String> userData,
 			final Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
 
@@ -68,14 +70,19 @@ public String format(final String text, final String name, final boolean isScrip
 
 		EditorConfigOverride editorConfigOverride;
 		if (editorConfigOverrideMap.isEmpty()) {
-			editorConfigOverride = EditorConfigOverride.Companion.getEmptyEditorConfigOverride();
+			editorConfigOverride = new EditorConfigOverride();
 		} else {
 			editorConfigOverride = createEditorConfigOverride(allRuleProviders.stream().map(
 					RuleProvider::createNewRuleInstance).collect(
 							Collectors.toList()),
 					editorConfigOverrideMap);
 		}
-
+		Path editorConfigFilePath;
+		if (editorConfigPath == null) {
+			editorConfigFilePath = null;
+		} else {
+			editorConfigFilePath = new File(editorConfigPath).toPath();
+		}
 		return KtLint.INSTANCE.format(new KtLint.ExperimentalParams(
 				name,
 				text,
@@ -86,7 +93,7 @@ public String format(final String text, final String name, final boolean isScrip
 				isScript,
 				null,
 				false,
-				EditorConfigDefaults.Companion.getEmptyEditorConfigDefaults(),
+				EditorConfigDefaults.Companion.load(editorConfigFilePath),
 				editorConfigOverride,
 				false));
 	}
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
@@ -15,6 +15,8 @@
  */
 package com.diffplug.spotless.glue.ktlint.compat;
 
+import java.io.File;
+import java.nio.file.Path;
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
@@ -54,7 +56,7 @@ public Unit invoke(LintError lint, Boolean corrected) {
 	@Override
 	public String format(final String text, final String name, final boolean isScript,
 			final boolean useExperimental,
-			final Map<String, String> userData,
+			String editorConfigPath, final Map<String, String> userData,
 			final Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
 
@@ -66,14 +68,19 @@ public String format(final String text, final String name, final boolean isScrip
 
 		EditorConfigOverride editorConfigOverride;
 		if (editorConfigOverrideMap.isEmpty()) {
-			editorConfigOverride = EditorConfigOverride.Companion.getEmptyEditorConfigOverride();
+			editorConfigOverride = new EditorConfigOverride();
 		} else {
 			editorConfigOverride = createEditorConfigOverride(allRuleProviders.stream().map(
 					RuleProvider::createNewRuleInstance).collect(
 							Collectors.toList()),
 					editorConfigOverrideMap);
 		}
-
+		Path editorConfigFilePath;
+		if (editorConfigPath == null) {
+			editorConfigFilePath = null;
+		} else {
+			editorConfigFilePath = new File(editorConfigPath).toPath();
+		}
 		return KtLint.INSTANCE.format(new KtLint.ExperimentalParams(
 				name,
 				text,
@@ -82,7 +89,7 @@ public String format(final String text, final String name, final boolean isScrip
 				formatterCallback,
 				isScript,
 				false,
-				EditorConfigDefaults.Companion.getEmptyEditorConfigDefaults(),
+				EditorConfigDefaults.Companion.load(editorConfigFilePath),
 				editorConfigOverride,
 				false));
 	}
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
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2023 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,6 @@
 
 public interface KtLintCompatAdapter {
 
-	String format(String text, String name, boolean isScript, boolean useExperimental, Map<String, String> userData,
+	String format(String text, String name, boolean isScript, boolean useExperimental, String editorConfigPath, Map<String, String> userData,
 			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
@@ -37,9 +37,10 @@ public class KtlintFormatterFunc implements FormatterFunc.NeedsFile {
 	@NotNull
 	private final KtLintCompatAdapter adapter;
 	private final boolean useExperimental;
+	private final String editorConfigPath;
 	private final Map<String, Object> editorConfigOverrideMap;
 
-	public KtlintFormatterFunc(String version, boolean isScript, boolean useExperimental, Map<String, String> userData,
+	public KtlintFormatterFunc(String version, boolean isScript, boolean useExperimental, String editorConfigPath, Map<String, String> userData,
 			Map<String, Object> editorConfigOverrideMap) {
 		int minorVersion = Integer.parseInt(version.split("\\.")[1]);
 		if (minorVersion >= 48) {
@@ -64,6 +65,7 @@ public KtlintFormatterFunc(String version, boolean isScript, boolean useExperime
 			// the OG
 			this.adapter = new KtLintCompat0Dot31Dot0Adapter();
 		}
+		this.editorConfigPath = editorConfigPath;
 		this.useExperimental = useExperimental;
 		this.editorConfigOverrideMap = editorConfigOverrideMap;
 		this.userData = userData;
@@ -72,6 +74,6 @@ public KtlintFormatterFunc(String version, boolean isScript, boolean useExperime
 
 	@Override
 	public String applyWithFile(String unix, File file) throws Exception {
-		return adapter.format(unix, file.getName(), isScript, useExperimental, userData, editorConfigOverrideMap);
+		return adapter.format(unix, file.getName(), isScript, useExperimental, editorConfigPath, userData, 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
@@ -64,10 +64,15 @@ public static FormatterStep createForScript(String version, Provisioner provisio
 
 	private static FormatterStep create(String version, Provisioner provisioner, boolean isScript, boolean useExperimental,
 			Map<String, String> userData, Map<String, Object> editorConfigOverride) {
+		return create(version, provisioner, useExperimental, userData, editorConfigOverride);
+	}
+
+	public static FormatterStep create(String version, Provisioner provisioner, boolean isScript, boolean useExperimental,
+			String editorConfig, Map<String, String> userData, Map<String, Object> editorConfigOverride) {
 		Objects.requireNonNull(version, "version");
 		Objects.requireNonNull(provisioner, "provisioner");
 		return FormatterStep.createLazy(NAME,
-				() -> new State(version, provisioner, isScript, useExperimental, userData, editorConfigOverride),
+				() -> new State(version, provisioner, isScript, useExperimental, editorConfig, userData, editorConfigOverride),
 				State::createFormat);
 	}
 
@@ -86,9 +91,10 @@ static final class State implements Serializable {
 		private final TreeMap<String, String> userData;
 		private final TreeMap<String, Object> editorConfigOverride;
 		private final String version;
+		private final String editorConfigPath;
 
 		State(String version, Provisioner provisioner, boolean isScript, boolean useExperimental,
-				Map<String, String> userData, Map<String, Object> editorConfigOverride) throws IOException {
+				String editorConfigPath, Map<String, String> userData, Map<String, Object> editorConfigOverride) throws IOException {
 			this.version = version;
 
 			String coordinate;
@@ -104,15 +110,16 @@ static final class State implements Serializable {
 			this.userData = new TreeMap<>(userData);
 			this.editorConfigOverride = new TreeMap<>(editorConfigOverride);
 			this.jarState = JarState.from(coordinate + 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, boolean.class, Map.class, Map.class);
-			return (FormatterFunc.NeedsFile) constructor.newInstance(version, isScript, useExperimental, userData, editorConfigOverride);
+					String.class, boolean.class, boolean.class, String.class, Map.class, Map.class);
+			return (FormatterFunc.NeedsFile) constructor.newInstance(version, isScript, useExperimental, editorConfigPath, userData, editorConfigOverride);
 		}
 	}
 }
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-2022 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -60,7 +60,7 @@ public LicenseHeaderConfig licenseHeaderFile(Object licenseHeaderFile) {
 	/** Adds the specified version of <a href="https://github.com/pinterest/ktlint">ktlint</a>. */
 	public KotlinFormatExtension ktlint(String version) {
 		Objects.requireNonNull(version);
-		return new KotlinFormatExtension(version, false, Collections.emptyMap(), Collections.emptyMap());
+		return new KotlinFormatExtension(version, false, null, Collections.emptyMap(), Collections.emptyMap());
 	}
 
 	public KotlinFormatExtension ktlint() {
@@ -71,13 +71,15 @@ public class KotlinFormatExtension {
 
 		private final String version;
 		private boolean useExperimental;
+		private String editorConfigPath;
 		private Map<String, String> userData;
 		private Map<String, Object> editorConfigOverride;
 
-		KotlinFormatExtension(String version, boolean useExperimental, Map<String, String> config,
+		KotlinFormatExtension(String version, boolean useExperimental, String editorConfigPath, Map<String, String> config,
 				Map<String, Object> editorConfigOverride) {
 			this.version = version;
 			this.useExperimental = useExperimental;
+			this.editorConfigPath = editorConfigPath;
 			this.userData = config;
 			this.editorConfigOverride = editorConfigOverride;
 			addStep(createStep());
@@ -106,7 +108,7 @@ public KotlinFormatExtension editorConfigOverride(Map<String, Object> editorConf
 		}
 
 		private FormatterStep createStep() {
-			return KtLintStep.create(version, provisioner(), useExperimental, userData, editorConfigOverride);
+			return KtLintStep.create(version, provisioner(), useExperimental, false, editorConfigPath, userData, editorConfigOverride);
 		}
 	}
 
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/KotlinGradleExtension.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/KotlinGradleExtension.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2022 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -45,7 +45,7 @@ public KotlinGradleExtension(SpotlessExtension spotless) {
 	/** Adds the specified version of <a href="https://github.com/pinterest/ktlint">ktlint</a>. */
 	public KotlinFormatExtension ktlint(String version) {
 		Objects.requireNonNull(version, "version");
-		return new KotlinFormatExtension(version, false, Collections.emptyMap(), Collections.emptyMap());
+		return new KotlinFormatExtension(version, false, null, Collections.emptyMap(), Collections.emptyMap());
 	}
 
 	public KotlinFormatExtension ktlint() {
@@ -56,18 +56,26 @@ public class KotlinFormatExtension {
 
 		private final String version;
 		private boolean useExperimental;
+		private String editorConfigPath;
 		private Map<String, String> userData;
 		private Map<String, Object> editorConfigOverride;
 
-		KotlinFormatExtension(String version, boolean useExperimental, Map<String, String> config,
+		KotlinFormatExtension(String version, boolean useExperimental, String editorConfigPath, Map<String, String> config,
 				Map<String, Object> editorConfigOverride) {
 			this.version = version;
 			this.useExperimental = useExperimental;
+			this.editorConfigPath = editorConfigPath;
 			this.userData = config;
 			this.editorConfigOverride = editorConfigOverride;
 			addStep(createStep());
 		}
 
+		public KotlinFormatExtension setEditorConfigPath(String editorConfigPath) {
+			this.editorConfigPath = editorConfigPath;
+			replaceStep(createStep());
+			return this;
+		}
+
 		public KotlinFormatExtension setUseExperimental(boolean useExperimental) {
 			this.useExperimental = useExperimental;
 			replaceStep(createStep());
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

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2022 DiffPlug`
	`2`	`+ * Copyright 2022-2023 DiffPlug`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -19,6 +19,6 @@`
`19`	`19`
`20`	`20`	`public interface KtLintCompatAdapter {`
`21`	`21`
`22`		`- String format(String text, String name, boolean isScript, boolean useExperimental, Map<String, String> userData,`
	`22`	`+ String format(String text, String name, boolean isScript, boolean useExperimental, String editorConfigPath, Map<String, String> userData,`
`23`	`23`	`Map<String, Object> editorConfigOverrideMap);`
`24`	`24`	`}`