Support ktlint 0.50.0 and drop support for 0.47.0 (#1748 resolves #…

…1741)
diffplug · Jul 14, 2023 · dcfd57c · dcfd57c
2 parents b27632e + c0bee92
commit dcfd57c
Show file tree

Hide file tree

Showing 25 changed files with 356 additions and 281 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -10,6 +10,10 @@ This document is intended for Spotless developers.
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+### Added
+* Bump default `ktlint` version to latest `0.49.1` -> `0.50.0`.([#1741](https://github.com/diffplug/spotless/issues/1741))
+  * Dropped support for `ktlint 0.47.x` following our policy of supporting two breaking changes at a time.
+  * Dropped support for deprecated `useExperimental` parameter in favor of the `ktlint_experimental` property.
 ### Changes
 * Bump default `cleanthat` version to latest `2.13` -> `2.16`. ([#1725](https://github.com/diffplug/spotless/pull/1725))
 ### Fixed

diff --git a/lib/build.gradle b/lib/build.gradle
@@ -44,9 +44,9 @@ versionCompatibility {
 			// we will support no more than 2 breaking changes at a time = 3 incompatible versions
 			// we will try to drop down to only one version if a stable API can be maintained for a full year
 			versions = [
-				'0.47.0',
 				'0.48.0',
 				'0.49.0',
+				'0.50.0',
 			]
 			targetSourceSetName = 'ktlint'
 		}
@@ -95,16 +95,18 @@ dependencies {
 			strictly '1.7' // for JDK 8 compatibility
 		}
 	}
-	// ktlint
-	compatKtLint0Dot47Dot0CompileOnly 'com.pinterest.ktlint:ktlint-core:0.47.0'
-	compatKtLint0Dot47Dot0CompileOnly 'com.pinterest.ktlint:ktlint-ruleset-experimental:0.47.0'
-	compatKtLint0Dot47Dot0CompileOnly 'com.pinterest.ktlint:ktlint-ruleset-standard:0.47.0'
+	// ktlint oldest supported version
 	compatKtLint0Dot48Dot0CompileAndTestOnly 'com.pinterest.ktlint:ktlint-core:0.48.0'
 	compatKtLint0Dot48Dot0CompileAndTestOnly 'com.pinterest.ktlint:ktlint-ruleset-experimental:0.48.0'
 	compatKtLint0Dot48Dot0CompileAndTestOnly 'com.pinterest.ktlint:ktlint-ruleset-standard:0.48.0'
+	// ktlint previous supported version
 	compatKtLint0Dot49Dot0CompileAndTestOnly 'com.pinterest.ktlint:ktlint-rule-engine:0.49.0'
 	compatKtLint0Dot49Dot0CompileAndTestOnly 'com.pinterest.ktlint:ktlint-ruleset-standard:0.49.0'
 	compatKtLint0Dot49Dot0CompileAndTestOnly 'org.slf4j:slf4j-api:2.0.0'
+	// ktlint latest supported version
+	compatKtLint0Dot50Dot0CompileAndTestOnly 'com.pinterest.ktlint:ktlint-rule-engine:0.50.0'
+	compatKtLint0Dot50Dot0CompileAndTestOnly 'com.pinterest.ktlint:ktlint-ruleset-standard:0.50.0'
+	compatKtLint0Dot50Dot0CompileAndTestOnly 'org.slf4j:slf4j-api:2.0.0'
 	// palantirJavaFormat
 	palantirJavaFormatCompileOnly 'com.palantir.javaformat:palantir-java-format:1.1.0' 	// this version needs to stay compilable against Java 8 for CI Job testNpm
 	// scalafmt

diff --git a/...ot47Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot47Dot0Adapter.java b/...ot47Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot47Dot0Adapter.java
diff --git a/...ot48Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot48Dot0Adapter.java b/...ot48Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot48Dot0Adapter.java
@@ -19,10 +19,10 @@
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Collections;
-import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.ServiceLoader;
 import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -31,6 +31,7 @@
 import com.pinterest.ktlint.core.LintError;
 import com.pinterest.ktlint.core.Rule;
 import com.pinterest.ktlint.core.RuleProvider;
+import com.pinterest.ktlint.core.RuleSetProviderV2;
 import com.pinterest.ktlint.core.api.EditorConfigDefaults;
 import com.pinterest.ktlint.core.api.EditorConfigOverride;
 import com.pinterest.ktlint.core.api.UsesEditorConfigProperties;
@@ -42,8 +43,6 @@
 import com.pinterest.ktlint.core.api.editorconfig.InsertFinalNewLineEditorConfigPropertyKt;
 import com.pinterest.ktlint.core.api.editorconfig.MaxLineLengthEditorConfigPropertyKt;
 import com.pinterest.ktlint.core.api.editorconfig.RuleExecutionEditorConfigPropertyKt;
-import com.pinterest.ktlint.ruleset.experimental.ExperimentalRuleSetProvider;
-import com.pinterest.ktlint.ruleset.standard.StandardRuleSetProvider;
 
 import kotlin.Pair;
 import kotlin.Unit;
@@ -79,16 +78,14 @@ public Unit invoke(LintError lint, Boolean corrected) {
 
 	@Override
 	public String format(final String text, Path path, final boolean isScript,
-			final boolean useExperimental,
 			Path editorConfigPath, final Map<String, String> userData,
 			final Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
 
-		Set<RuleProvider> allRuleProviders = new LinkedHashSet<>(
-				new StandardRuleSetProvider().getRuleProviders());
-		if (useExperimental) {
-			allRuleProviders.addAll(new ExperimentalRuleSetProvider().getRuleProviders());
-		}
+		Set<RuleProvider> allRuleProviders = ServiceLoader.load(RuleSetProviderV2.class, RuleSetProviderV2.class.getClassLoader())
+				.stream()
+				.flatMap(loader -> loader.get().getRuleProviders().stream())
+				.collect(Collectors.toUnmodifiableSet());
 
 		EditorConfigOverride editorConfigOverride;
 		if (editorConfigOverrideMap.isEmpty()) {
@@ -111,7 +108,7 @@ public String format(final String text, Path path, final boolean isScript,
 				editorConfig,
 				editorConfigOverride,
 				false)
-						.format(path, formatterCallback);
+				.format(path, formatterCallback);
 	}
 
 	/**
@@ -134,9 +131,8 @@ private static EditorConfigOverride createEditorConfigOverride(final List<Rule>
 		Pair<EditorConfigProperty<?>, ?>[] properties = editorConfigOverrideMap.entrySet().stream()
 				.map(entry -> {
 					EditorConfigProperty<?> property = supportedProperties.get(entry.getKey());
-					if (property != null) {
-						return new Pair<>(property, entry.getValue());
-					} else if (entry.getKey().startsWith("ktlint_")) {
+
+					if (property == null && entry.getKey().startsWith("ktlint_")) {
 						String[] parts = entry.getKey().substring(7).split("_", 2);
 						if (parts.length == 1) {
 							// convert ktlint_{ruleset} to {ruleset}
@@ -147,9 +143,12 @@ private static EditorConfigOverride createEditorConfigOverride(final List<Rule>
 							String qualifiedRuleId = parts[0] + ":" + parts[1];
 							property = RuleExecutionEditorConfigPropertyKt.createRuleExecutionEditorConfigProperty(qualifiedRuleId);
 						}
-						return new Pair<>(property, entry.getValue());
-					} else {
+					}
+
+					if (property == null) {
 						return null;
+					} else {
+						return new Pair<>(property, entry.getValue());
 					}
 				})
 				.filter(Objects::nonNull)

diff --git a/...ot49Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot49Dot0Adapter.java b/...ot49Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot49Dot0Adapter.java
@@ -21,17 +21,18 @@
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Collections;
-import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.ServiceLoader;
 import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.pinterest.ktlint.cli.ruleset.core.api.RuleSetProviderV3;
 import com.pinterest.ktlint.rule.engine.api.Code;
 import com.pinterest.ktlint.rule.engine.api.EditorConfigDefaults;
 import com.pinterest.ktlint.rule.engine.api.EditorConfigOverride;
@@ -48,7 +49,6 @@
 import com.pinterest.ktlint.rule.engine.core.api.editorconfig.MaxLineLengthEditorConfigPropertyKt;
 import com.pinterest.ktlint.rule.engine.core.api.editorconfig.RuleExecution;
 import com.pinterest.ktlint.rule.engine.core.api.editorconfig.RuleExecutionEditorConfigPropertyKt;
-import com.pinterest.ktlint.ruleset.standard.StandardRuleSetProvider;
 
 import kotlin.Pair;
 import kotlin.Unit;
@@ -123,23 +123,14 @@ public Unit invoke(LintError lint, Boolean corrected) {
 
 	@Override
 	public String format(final String text, Path path, final boolean isScript,
-			final boolean useExperimental,
 			Path editorConfigPath, final Map<String, String> userData,
 			final Map<String, Object> editorConfigOverrideMap) {
 		final FormatterCallback formatterCallback = new FormatterCallback();
 
-		Set<RuleProvider> allRuleProviders = new LinkedHashSet<>(
-				new StandardRuleSetProvider().getRuleProviders());
-
-		// TODO: Should we keep `useExperimental` now that ktlint uses an EditorConfig property for this purpose?
-		if (useExperimental) {
-			String experimentalRulesPropertyName = RuleExecutionEditorConfigPropertyKt.getEXPERIMENTAL_RULES_EXECUTION_PROPERTY().getName();
-			Object experimentalOverride = editorConfigOverrideMap.get(experimentalRulesPropertyName);
-			if (experimentalOverride != null) {
-				logger.warn("`useExperimental` parameter is `true` and `ktlint_experimental` property is set, `useExperimental` will take priority!");
-				editorConfigOverrideMap.put(experimentalRulesPropertyName, "enabled");
-			}
-		}
+		Set<RuleProvider> allRuleProviders = ServiceLoader.load(RuleSetProviderV3.class, RuleSetProviderV3.class.getClassLoader())
+				.stream()
+				.flatMap(loader -> loader.get().getRuleProviders().stream())
+				.collect(Collectors.toUnmodifiableSet());
 
 		EditorConfigOverride editorConfigOverride;
 		if (editorConfigOverrideMap.isEmpty()) {
@@ -184,22 +175,24 @@ private static EditorConfigOverride createEditorConfigOverride(final List<Rule>
 		Pair<EditorConfigProperty<?>, ?>[] properties = editorConfigOverrideMap.entrySet().stream()
 				.map(entry -> {
 					EditorConfigProperty<?> property = supportedProperties.get(entry.getKey());
-					if (property != null) {
-						return new Pair<>(property, entry.getValue());
-					} else if (entry.getKey().startsWith("ktlint_")) {
+
+					if (property == null && entry.getKey().startsWith("ktlint_")) {
 						String[] parts = entry.getKey().substring(7).split("_", 2);
 						if (parts.length == 1) {
 							// convert ktlint_{ruleset} to {ruleset}
-							String qualifiedRuleId = parts[0] + ":";
-							property = createRuleSetExecution(qualifiedRuleId, RuleExecution.disabled);
+							String id = parts[0];
+							property = createRuleSetExecution(id, RuleExecution.enabled);
 						} else {
 							// convert ktlint_{ruleset}_{rulename} to {ruleset}:{rulename}
-							String qualifiedRuleId = parts[0] + ":" + parts[1];
-							property = createRuleExecution(qualifiedRuleId, RuleExecution.disabled);
+							String id = parts[0] + ":" + parts[1];
+							property = createRuleExecution(id, RuleExecution.enabled);
 						}
-						return new Pair<>(property, entry.getValue());
-					} else {
+					}
+
+					if (property == null) {
 						return null;
+					} else {
+						return new Pair<>(property, entry.getValue());
 					}
 				})
 				.filter(Objects::nonNull)