-
Notifications
You must be signed in to change notification settings - Fork 455
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support ktlint
0.50.0 and drop support for 0.47.0
Closes #1741
- Loading branch information
1 parent
d245b60
commit 3bafa6a
Showing
14 changed files
with
299 additions
and
181 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 0 additions & 139 deletions
139
...ot47Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot47Dot0Adapter.java
This file was deleted.
Oops, something went wrong.
173 changes: 173 additions & 0 deletions
173
...ot50Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot50Dot0Adapter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| /* | ||
| * Copyright 2023 DiffPlug | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package com.diffplug.spotless.glue.ktlint.compat; | ||
|
|
||
| import java.nio.file.Files; | ||
| 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.Set; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import com.pinterest.ktlint.rule.engine.api.Code; | ||
| import com.pinterest.ktlint.rule.engine.api.EditorConfigDefaults; | ||
| import com.pinterest.ktlint.rule.engine.api.EditorConfigOverride; | ||
| import com.pinterest.ktlint.rule.engine.api.KtLintRuleEngine; | ||
| import com.pinterest.ktlint.rule.engine.api.LintError; | ||
| import com.pinterest.ktlint.rule.engine.core.api.Rule; | ||
| import com.pinterest.ktlint.rule.engine.core.api.RuleId; | ||
| import com.pinterest.ktlint.rule.engine.core.api.RuleProvider; | ||
| import com.pinterest.ktlint.rule.engine.core.api.RuleSetId; | ||
| import com.pinterest.ktlint.rule.engine.core.api.editorconfig.CodeStyleEditorConfigPropertyKt; | ||
| import com.pinterest.ktlint.rule.engine.core.api.editorconfig.EditorConfigProperty; | ||
| import com.pinterest.ktlint.rule.engine.core.api.editorconfig.EndOfLinePropertyKt; | ||
| import com.pinterest.ktlint.rule.engine.core.api.editorconfig.IndentSizeEditorConfigPropertyKt; | ||
| import com.pinterest.ktlint.rule.engine.core.api.editorconfig.IndentStyleEditorConfigPropertyKt; | ||
| import com.pinterest.ktlint.rule.engine.core.api.editorconfig.InsertFinalNewLineEditorConfigPropertyKt; | ||
| 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; | ||
| import kotlin.jvm.functions.Function2; | ||
|
|
||
| public class KtLintCompat0Dot50Dot0Adapter implements KtLintCompatAdapter { | ||
|
|
||
| private static final Logger logger = LoggerFactory.getLogger(KtLintCompat0Dot50Dot0Adapter.class); | ||
|
|
||
| private static final List<EditorConfigProperty<?>> DEFAULT_EDITOR_CONFIG_PROPERTIES; | ||
|
|
||
| static { | ||
| List<EditorConfigProperty<?>> list = new ArrayList<>(); | ||
| list.add(CodeStyleEditorConfigPropertyKt.getCODE_STYLE_PROPERTY()); | ||
| list.add(EndOfLinePropertyKt.getEND_OF_LINE_PROPERTY()); | ||
| list.add(IndentSizeEditorConfigPropertyKt.getINDENT_SIZE_PROPERTY()); | ||
| list.add(IndentStyleEditorConfigPropertyKt.getINDENT_STYLE_PROPERTY()); | ||
| list.add(InsertFinalNewLineEditorConfigPropertyKt.getINSERT_FINAL_NEWLINE_PROPERTY()); | ||
| list.add(MaxLineLengthEditorConfigPropertyKt.getMAX_LINE_LENGTH_PROPERTY()); | ||
| list.add(RuleExecutionEditorConfigPropertyKt.getEXPERIMENTAL_RULES_EXECUTION_PROPERTY()); | ||
| DEFAULT_EDITOR_CONFIG_PROPERTIES = Collections.unmodifiableList(list); | ||
| } | ||
|
|
||
| static class FormatterCallback implements Function2<LintError, Boolean, Unit> { | ||
|
|
||
| @Override | ||
| public Unit invoke(LintError lint, Boolean corrected) { | ||
| if (!corrected) { | ||
| KtLintCompatReporting.report(lint.getLine(), lint.getCol(), lint.getRuleId().getValue(), lint.getDetail()); | ||
| } | ||
| return Unit.INSTANCE; | ||
| } | ||
| } | ||
|
|
||
| @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"); | ||
| } | ||
| } | ||
|
|
||
| EditorConfigOverride editorConfigOverride; | ||
| if (editorConfigOverrideMap.isEmpty()) { | ||
| editorConfigOverride = EditorConfigOverride.Companion.getEMPTY_EDITOR_CONFIG_OVERRIDE(); | ||
| } else { | ||
| editorConfigOverride = createEditorConfigOverride(allRuleProviders.stream().map( | ||
| RuleProvider::createNewRuleInstance).collect(Collectors.toList()), | ||
| editorConfigOverrideMap); | ||
| } | ||
| EditorConfigDefaults editorConfig; | ||
| if (editorConfigPath == null || !Files.exists(editorConfigPath)) { | ||
| editorConfig = EditorConfigDefaults.Companion.getEMPTY_EDITOR_CONFIG_DEFAULTS(); | ||
| } else { | ||
| editorConfig = EditorConfigDefaults.Companion.load(editorConfigPath, Collections.emptySet()); | ||
| } | ||
|
|
||
| return new KtLintRuleEngine( | ||
| allRuleProviders, | ||
| editorConfig, | ||
| editorConfigOverride, | ||
| true, | ||
| false, | ||
| path.getFileSystem()) | ||
| .format(Code.Companion.fromPath(path), formatterCallback); | ||
| } | ||
|
|
||
| /** | ||
| * Create EditorConfigOverride from user provided parameters. | ||
| */ | ||
| private static EditorConfigOverride createEditorConfigOverride(final List<Rule> rules, Map<String, Object> editorConfigOverrideMap) { | ||
| // Get properties from rules in the rule sets | ||
| Stream<EditorConfigProperty<?>> ruleProperties = rules.stream() | ||
| .flatMap(rule -> rule.getUsesEditorConfigProperties().stream()); | ||
|
|
||
| // Create a mapping of properties to their names based on rule properties and default properties | ||
| Map<String, EditorConfigProperty<?>> supportedProperties = Stream | ||
| .concat(ruleProperties, DEFAULT_EDITOR_CONFIG_PROPERTIES.stream()) | ||
| .distinct() | ||
| .collect(Collectors.toMap(EditorConfigProperty::getName, property -> property)); | ||
|
|
||
| // Create config properties based on provided property names and values | ||
| @SuppressWarnings("unchecked") | ||
| 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_")) { | ||
| String[] parts = entry.getKey().substring(7).split("_", 2); | ||
| if (parts.length == 1) { | ||
| // convert ktlint_{ruleset} to RuleSetId | ||
| RuleSetId id = new RuleSetId(parts[0]); | ||
| property = RuleExecutionEditorConfigPropertyKt.createRuleSetExecutionEditorConfigProperty(id, RuleExecution.disabled); | ||
| } else { | ||
| // convert ktlint_{ruleset}_{rulename} to RuleId | ||
| RuleId id = new RuleId(parts[0] + ":" + parts[1]); | ||
| property = RuleExecutionEditorConfigPropertyKt.createRuleExecutionEditorConfigProperty(id, RuleExecution.disabled); | ||
| } | ||
| return new Pair<>(property, entry.getValue()); | ||
| } else { | ||
| return null; | ||
| } | ||
| }) | ||
| .filter(Objects::nonNull) | ||
| .toArray(Pair[]::new); | ||
|
|
||
| return EditorConfigOverride.Companion.from(properties); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.