-
Notifications
You must be signed in to change notification settings - Fork 504
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add rule FunctionTypeReferenceSpacingRule (#1342)
This rule is required to create a rule which can rewrite the function signature automatically as is described in #1341
- Loading branch information
1 parent
ea8a05f
commit 8e1c5a3
Showing
5 changed files
with
177 additions
and
4 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
73 changes: 73 additions & 0 deletions
73
...main/kotlin/com/pinterest/ktlint/ruleset/experimental/FunctionTypeReferenceSpacingRule.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,73 @@ | ||
| package com.pinterest.ktlint.ruleset.experimental | ||
|
|
||
| import com.pinterest.ktlint.core.Rule | ||
| import com.pinterest.ktlint.core.ast.ElementType.FUN | ||
| import com.pinterest.ktlint.core.ast.ElementType.IDENTIFIER | ||
| import com.pinterest.ktlint.core.ast.ElementType.NULLABLE_TYPE | ||
| import com.pinterest.ktlint.core.ast.ElementType.TYPE_REFERENCE | ||
| import com.pinterest.ktlint.core.ast.ElementType.WHITE_SPACE | ||
| import com.pinterest.ktlint.core.ast.nextSibling | ||
| import org.jetbrains.kotlin.com.intellij.lang.ASTNode | ||
|
|
||
| public class FunctionTypeReferenceSpacingRule : Rule("function-type-reference-spacing") { | ||
| override fun visit( | ||
| node: ASTNode, | ||
| autoCorrect: Boolean, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit | ||
| ) { | ||
| if (node.elementType == FUN) { | ||
| node | ||
| .findTypeReferenceBeforeFunctionIdentifier() | ||
| ?.let { typeReference -> | ||
| typeReference | ||
| .firstChildNode | ||
| .takeIf { it.elementType == NULLABLE_TYPE } | ||
| ?.let { nullableTypeElement -> | ||
| visitNodesUntilIdentifier(nullableTypeElement.firstChildNode, emit, autoCorrect) | ||
| } | ||
|
|
||
| if (typeReference.elementType != NULLABLE_TYPE) { | ||
| visitNodesUntilIdentifier(typeReference, emit, autoCorrect) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun ASTNode.findTypeReferenceBeforeFunctionIdentifier(): ASTNode? { | ||
| require(elementType == FUN) | ||
| var currentNode: ASTNode? = firstChildNode | ||
| while (currentNode != null && currentNode.elementType != IDENTIFIER) { | ||
| if (currentNode.elementType == TYPE_REFERENCE) { | ||
| return currentNode | ||
| } | ||
| currentNode = currentNode.nextSibling { true } | ||
| } | ||
| return null | ||
| } | ||
|
|
||
| private fun visitNodesUntilIdentifier( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| var currentNode: ASTNode? = node | ||
| while (currentNode != null && currentNode.elementType != IDENTIFIER) { | ||
| val nextNode = currentNode.nextSibling { true } | ||
| removeIfNonEmptyWhiteSpace(currentNode, emit, autoCorrect) | ||
| currentNode = nextNode | ||
| } | ||
| } | ||
|
|
||
| private fun removeIfNonEmptyWhiteSpace( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| if (node.elementType == WHITE_SPACE && node.text.isNotEmpty()) { | ||
| emit(node.startOffset, "Unexpected whitespace", true) | ||
| if (autoCorrect) { | ||
| node.treeParent.removeChild(node) | ||
| } | ||
| } | ||
| } | ||
| } |
95 changes: 95 additions & 0 deletions
95
...t/kotlin/com/pinterest/ktlint/ruleset/experimental/NoSpacingAfterTypeReferenceRuleTest.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,95 @@ | ||
| package com.pinterest.ktlint.ruleset.experimental | ||
|
|
||
| import com.pinterest.ktlint.core.LintError | ||
| import com.pinterest.ktlint.test.format | ||
| import com.pinterest.ktlint.test.lint | ||
| import org.assertj.core.api.Assertions | ||
| import org.junit.jupiter.api.Test | ||
|
|
||
| class NoSpacingAfterTypeReferenceRuleTest { | ||
| @Test | ||
| fun `Given a function signature with whitespace after a non nullable type reference of an extension function then remove this whitespace`() { | ||
| val code = | ||
| """ | ||
| fun String .foo1() = "some-result" | ||
| fun String | ||
| .foo2() = "some-result" | ||
| """.trimIndent() | ||
| val formattedCode = | ||
| """ | ||
| fun String.foo1() = "some-result" | ||
| fun String.foo2() = "some-result" | ||
| """.trimIndent() | ||
| Assertions.assertThat( | ||
| FunctionTypeReferenceSpacingRule().lint(code) | ||
| ).containsExactly( | ||
| LintError(1, 11, "function-type-reference-spacing", "Unexpected whitespace"), | ||
| LintError(2, 11, "function-type-reference-spacing", "Unexpected whitespace") | ||
| ) | ||
| Assertions.assertThat( | ||
| FunctionTypeReferenceSpacingRule().format(code) | ||
| ).isEqualTo(formattedCode) | ||
| } | ||
|
|
||
| @Test | ||
| fun `Given a function signature with whitespace in a nullable type reference of an extension function`() { | ||
| val code = | ||
| """ | ||
| fun String ?.foo1() = "some-result" | ||
| fun String | ||
| ?.foo2() = "some-result" | ||
| """.trimIndent() | ||
| val formattedCode = | ||
| """ | ||
| fun String?.foo1() = "some-result" | ||
| fun String?.foo2() = "some-result" | ||
| """.trimIndent() | ||
| Assertions.assertThat( | ||
| FunctionTypeReferenceSpacingRule().lint(code) | ||
| ).containsExactly( | ||
| LintError(1, 11, "function-type-reference-spacing", "Unexpected whitespace"), | ||
| LintError(2, 11, "function-type-reference-spacing", "Unexpected whitespace") | ||
| ) | ||
| Assertions.assertThat( | ||
| FunctionTypeReferenceSpacingRule().format(code) | ||
| ).isEqualTo(formattedCode) | ||
| } | ||
|
|
||
| @Test | ||
| fun `Given a function signature with whitespace after a nullable type reference of an extension function`() { | ||
| val code = | ||
| """ | ||
| fun String? .foo1() = "some-result" | ||
| fun String? | ||
| .foo2() = "some-result" | ||
| """.trimIndent() | ||
| val formattedCode = | ||
| """ | ||
| fun String?.foo1() = "some-result" | ||
| fun String?.foo2() = "some-result" | ||
| """.trimIndent() | ||
| Assertions.assertThat( | ||
| FunctionTypeReferenceSpacingRule().lint(code) | ||
| ).containsExactly( | ||
| LintError(1, 12, "function-type-reference-spacing", "Unexpected whitespace"), | ||
| LintError(2, 12, "function-type-reference-spacing", "Unexpected whitespace") | ||
| ) | ||
| Assertions.assertThat( | ||
| FunctionTypeReferenceSpacingRule().format(code) | ||
| ).isEqualTo(formattedCode) | ||
| } | ||
|
|
||
| @Test | ||
| fun `Given a function signature without a type reference before the function name then do not change the signature`() { | ||
| val code = | ||
| """ | ||
| fun foo1() = "some-result" | ||
| """.trimIndent() | ||
| Assertions.assertThat( | ||
| FunctionTypeReferenceSpacingRule().lint(code) | ||
| ).isEmpty() | ||
| Assertions.assertThat( | ||
| FunctionTypeReferenceSpacingRule().format(code) | ||
| ).isEqualTo(code) | ||
| } | ||
| } |