-
Notifications
You must be signed in to change notification settings - Fork 509
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for API Consumers to add suppressions (#2428)
* Extract KtlintSuppression from KtlintSuppressionRule KtlintSuppression is able to insert or modify a 'Suppress' annotation for a given node. It has no knowledge of the legacy ktlint-directives. The KtlintSuppressionRule handles the legacy ktlint-directives and delegates insertion/modification of the 'Suppress' annotation to the KtlintSuppression helper. KtlintSuppressionRule: * Fix offsets in some violations * Allow annotation to be placed on a value argument, value parameter, type projection or type parameter
- Loading branch information
1 parent
8b51fb9
commit ad879b8
Showing
10 changed files
with
1,616 additions
and
423 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
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
94 changes: 94 additions & 0 deletions
94
...ngine/src/main/kotlin/com/pinterest/ktlint/rule/engine/api/KtlintRuleEngineSuppression.kt
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,94 @@ | ||
| package com.pinterest.ktlint.rule.engine.api | ||
|
|
||
| import com.pinterest.ktlint.rule.engine.core.api.RuleId | ||
| import com.pinterest.ktlint.rule.engine.internal.RuleExecutionContext | ||
| import com.pinterest.ktlint.rule.engine.internal.insertKtlintRuleSuppression | ||
| import org.jetbrains.kotlin.com.intellij.lang.ASTNode | ||
|
|
||
| /** | ||
| * A [Suppress] annotation can only be inserted at specific locations. This function is intended for API Consumers. It updates given [code] | ||
| * by inserting a [Suppress] annotation for the given [suppression]. | ||
| * | ||
| * Throws [KtlintSuppressionOutOfBoundsException] when the position of the [suppression] can not be found in the [code]. Throws | ||
| * [KtlintSuppressionNoElementFoundException] when no element can be found at the given offset. | ||
| * | ||
| * Returns the code with the inserted/modified suppression. Note that the returned code may not (yet) comply with formatting of all rules. | ||
| * This is intentional as adding a suppression for the [suppression] does not mean that other lint errors which can be autocorrected should | ||
| * be autocorrected. | ||
| */ | ||
| public fun KtLintRuleEngine.insertSuppression( | ||
| code: Code, | ||
| suppression: KtlintSuppression, | ||
| ): String { | ||
| val rootNode = | ||
| RuleExecutionContext | ||
| .createRuleExecutionContext(this, code) | ||
| .rootNode | ||
|
|
||
| rootNode | ||
| .findLeafElementAt(suppression) | ||
| .insertKtlintRuleSuppression(setOf(suppression.ruleId.value)) | ||
|
|
||
| return rootNode.text | ||
| } | ||
|
|
||
| private fun ASTNode.findLeafElementAt(suppression: KtlintSuppression): ASTNode = | ||
| when (suppression) { | ||
| is KtlintSuppressionForFile -> this | ||
|
|
||
| is KtlintSuppressionAtOffset -> | ||
| findLeafElementAt(suppression.offsetFromStartOf(text)) | ||
| ?: throw KtlintSuppressionNoElementFoundException(suppression) | ||
| } | ||
|
|
||
| private fun KtlintSuppressionAtOffset.offsetFromStartOf(code: String): Int { | ||
| if (line < 1 || col < 1) { | ||
| throw KtlintSuppressionOutOfBoundsException(this) | ||
| } | ||
|
|
||
| val lines = code.split("\n") | ||
|
|
||
| if (line > lines.size) { | ||
| throw KtlintSuppressionOutOfBoundsException(this) | ||
| } | ||
| val startOffsetOfLineContainingLintError = | ||
| lines | ||
| .take((line - 1).coerceAtLeast(0)) | ||
| .sumOf { text -> | ||
| // Fix length for newlines which were removed while splitting the original code | ||
| text.length + 1 | ||
| } | ||
|
|
||
| val codeLine = lines[line - 1] | ||
| if (col > codeLine.length) { | ||
| throw KtlintSuppressionOutOfBoundsException(this) | ||
| } | ||
|
|
||
| return startOffsetOfLineContainingLintError + (col - 1) | ||
| } | ||
|
|
||
| public sealed class KtlintSuppressionException( | ||
| message: String, | ||
| ) : RuntimeException(message) | ||
|
|
||
| public class KtlintSuppressionOutOfBoundsException( | ||
| offsetSuppression: KtlintSuppressionAtOffset, | ||
| ) : KtlintSuppressionException("Offset (${offsetSuppression.line},${offsetSuppression.col}) is invalid") | ||
|
|
||
| public class KtlintSuppressionNoElementFoundException( | ||
| offsetSuppression: KtlintSuppressionAtOffset, | ||
| ) : KtlintSuppressionException("No ASTNode found at offset (${offsetSuppression.line},${offsetSuppression.col})") | ||
|
|
||
| public sealed class KtlintSuppression( | ||
| public val ruleId: RuleId, | ||
| ) | ||
|
|
||
| public class KtlintSuppressionForFile( | ||
| ruleId: RuleId, | ||
| ) : KtlintSuppression(ruleId) | ||
|
|
||
| public class KtlintSuppressionAtOffset( | ||
| public val line: Int, | ||
| public val col: Int, | ||
| ruleId: RuleId, | ||
| ) : KtlintSuppression(ruleId) |
Oops, something went wrong.