-
Notifications
You must be signed in to change notification settings - Fork 512
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add new experimental rule ParameterListSpacingRule (#1411)
* Add new experimental rule ParameterListSpacingRule This rule is required for implementing the rewrite function signature rule #1341
- Loading branch information
1 parent
835558f
commit 07e1828
Showing
5 changed files
with
657 additions
and
18 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
242 changes: 242 additions & 0 deletions
242
...tal/src/main/kotlin/com/pinterest/ktlint/ruleset/experimental/ParameterListSpacingRule.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,242 @@ | ||
| package com.pinterest.ktlint.ruleset.experimental | ||
|
|
||
| import com.pinterest.ktlint.core.Rule | ||
| import com.pinterest.ktlint.core.ast.ElementType.ANNOTATION_ENTRY | ||
| import com.pinterest.ktlint.core.ast.ElementType.COLON | ||
| import com.pinterest.ktlint.core.ast.ElementType.COMMA | ||
| import com.pinterest.ktlint.core.ast.ElementType.MODIFIER_LIST | ||
| import com.pinterest.ktlint.core.ast.ElementType.VALUE_PARAMETER | ||
| import com.pinterest.ktlint.core.ast.ElementType.VALUE_PARAMETER_LIST | ||
| import com.pinterest.ktlint.core.ast.ElementType.WHITE_SPACE | ||
| import com.pinterest.ktlint.core.ast.children | ||
| import com.pinterest.ktlint.core.ast.nextCodeSibling | ||
| import com.pinterest.ktlint.core.ast.nextLeaf | ||
| import com.pinterest.ktlint.core.ast.nextSibling | ||
| import com.pinterest.ktlint.core.ast.prevCodeSibling | ||
| import com.pinterest.ktlint.core.ast.prevLeaf | ||
| import com.pinterest.ktlint.core.ast.upsertWhitespaceAfterMe | ||
| import org.jetbrains.kotlin.com.intellij.lang.ASTNode | ||
| import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafElement | ||
| import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafPsiElement | ||
|
|
||
| /** | ||
| * Ensures consistent spacing inside the parameter list. This rule partly overlaps with other rules like spacing around | ||
| * comma's and colons. However, it does have a more complete view on the higher concept of the parameter-list without | ||
| * interfering of the parameter-list-wrapping rule. | ||
| */ | ||
| public class ParameterListSpacingRule : Rule("parameter-list-spacing") { | ||
| override fun visit( | ||
| node: ASTNode, | ||
| autoCorrect: Boolean, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit | ||
| ) { | ||
| if (node.elementType == VALUE_PARAMETER_LIST) { | ||
| visitValueParameterList(node, emit, autoCorrect) | ||
| } | ||
| } | ||
|
|
||
| private fun visitValueParameterList( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| require(node.elementType == VALUE_PARAMETER_LIST) | ||
| val countValueParameters = | ||
| node | ||
| .children() | ||
| .count { it.elementType == VALUE_PARAMETER } | ||
| var valueParameterCount = 0 | ||
| val iterator = | ||
| node | ||
| .children() | ||
| // Store elements in list before changing them as otherwise only one element is being changed | ||
| .toList() | ||
| .iterator() | ||
| while (iterator.hasNext()) { | ||
| val el = iterator.next() | ||
| when (el.elementType) { | ||
| WHITE_SPACE -> { | ||
| if (countValueParameters == 0) { | ||
| removeUnexpectedWhiteSpace(el, emit, autoCorrect) | ||
| } else if (valueParameterCount == 0 && el.isNotIndent()) { | ||
| // whitespace before first parameter | ||
| removeUnexpectedWhiteSpace(el, emit, autoCorrect) | ||
| } else if (valueParameterCount == countValueParameters && el.isNotIndent()) { | ||
| // whitespace after the last parameter | ||
| removeUnexpectedWhiteSpace(el, emit, autoCorrect) | ||
| } else if (el.nextCodeSibling()?.elementType == COMMA) { | ||
| // No whitespace between parameter name and comma allowed | ||
| removeUnexpectedWhiteSpace(el, emit, autoCorrect) | ||
| } else if (el.elementType == WHITE_SPACE && el.isNotIndent() && el.isNotSingleSpace()) { | ||
| require(el.prevCodeSibling()?.elementType == COMMA) | ||
| replaceWithSingleSpace(el, emit, autoCorrect) | ||
| } | ||
| } | ||
| COMMA -> { | ||
| // Comma must be followed by whitespace | ||
| val nextSibling = | ||
| el | ||
| .nextSibling { true } | ||
| ?.elementType | ||
| if (nextSibling != WHITE_SPACE) { | ||
| addMissingWhiteSpaceAfterMe(el, emit, autoCorrect) | ||
| } | ||
| } | ||
| VALUE_PARAMETER -> { | ||
| valueParameterCount += 1 | ||
| visitValueParameter(el, emit, autoCorrect) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun visitValueParameter( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| visitModifierList(node, emit, autoCorrect) | ||
| removeWhiteSpaceBetweenParameterIdentifierAndColon(node, emit, autoCorrect) | ||
| fixWhiteSpaceAfterColonInParameter(node, emit, autoCorrect) | ||
| } | ||
|
|
||
| private fun visitModifierList( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| val modifierList = node.findChildByType(MODIFIER_LIST) ?: return | ||
| removeWhiteSpaceBetweenModifiersInList(modifierList, emit, autoCorrect) | ||
| removeWhiteSpaceBetweenModifierListAndParameterIdentifier(modifierList, emit, autoCorrect) | ||
| } | ||
|
|
||
| private fun removeWhiteSpaceBetweenModifiersInList( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| require(node.elementType == MODIFIER_LIST) | ||
| node | ||
| .children() | ||
| .filter { it.elementType == WHITE_SPACE } | ||
| // Store elements in list before changing them as otherwise only the first whitespace is being changed | ||
| .toList() | ||
| .forEach { visitWhiteSpaceAfterModifier(it, emit, autoCorrect) } | ||
| } | ||
|
|
||
| private fun visitWhiteSpaceAfterModifier( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| node | ||
| .takeUnless { | ||
| // Ignore when the modifier is an annotation which is placed on a separate line | ||
| it.isIndent() && it.getPrecedingModifier()?.elementType == ANNOTATION_ENTRY | ||
| } | ||
| ?.takeIf { it.isNotSingleSpace() } | ||
| ?.let { replaceWithSingleSpace(it, emit, autoCorrect) } | ||
| } | ||
|
|
||
| private fun removeWhiteSpaceBetweenModifierListAndParameterIdentifier( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| require(node.elementType == MODIFIER_LIST) | ||
| node | ||
| .nextSibling { true } | ||
| ?.takeIf { it.elementType == WHITE_SPACE } | ||
| ?.let { visitWhiteSpaceAfterModifier(it, emit, autoCorrect) } | ||
| } | ||
|
|
||
| private fun removeWhiteSpaceBetweenParameterIdentifierAndColon( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| node | ||
| .findChildByType(COLON) | ||
| ?.prevLeaf() | ||
| ?.takeIf { it.elementType == WHITE_SPACE } | ||
| ?.let { whiteSpaceBeforeColon -> | ||
| removeUnexpectedWhiteSpace(whiteSpaceBeforeColon, emit, autoCorrect) | ||
| } | ||
| } | ||
|
|
||
| private fun fixWhiteSpaceAfterColonInParameter( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| val colonNode = node.findChildByType(COLON) ?: return | ||
| colonNode | ||
| .nextLeaf() | ||
| ?.takeIf { it.elementType == WHITE_SPACE } | ||
| .let { whiteSpaceAfterColon -> | ||
| if (whiteSpaceAfterColon == null) { | ||
| addMissingWhiteSpaceAfterMe(colonNode, emit, autoCorrect) | ||
| } else if (whiteSpaceAfterColon.isIndent() || whiteSpaceAfterColon.isNotSingleSpace()) { | ||
| replaceWithSingleSpace(whiteSpaceAfterColon, emit, autoCorrect) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun addMissingWhiteSpaceAfterMe( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| require(node.elementType == COLON || node.elementType == COMMA) | ||
| emit(node.startOffset, "Whitespace after '${node.text}' is missing", true) | ||
| if (autoCorrect) { | ||
| (node as LeafElement).upsertWhitespaceAfterMe(" ") | ||
| } | ||
| } | ||
|
|
||
| private fun ASTNode.isNotIndent(): Boolean = !isIndent() | ||
|
|
||
| private fun ASTNode.isIndent(): Boolean { | ||
| require(elementType == WHITE_SPACE) | ||
| return text.startsWith("\n") | ||
| } | ||
|
|
||
| private fun ASTNode.isNotSingleSpace(): Boolean { | ||
| require(elementType == WHITE_SPACE) | ||
| return text != " " | ||
| } | ||
|
|
||
| private fun removeUnexpectedWhiteSpace( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| emit(node.startOffset, "Unexpected whitespace", true) | ||
| if (autoCorrect) { | ||
| (node as LeafElement).rawRemove() | ||
| } | ||
| } | ||
|
|
||
| private fun replaceWithSingleSpace( | ||
| node: ASTNode, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| autoCorrect: Boolean | ||
| ) { | ||
| emit(node.startOffset, "Expected a single space", true) | ||
| if (autoCorrect) { | ||
| (node as LeafPsiElement).replaceWithText(" ") | ||
| } | ||
| } | ||
|
|
||
| private fun ASTNode.getPrecedingModifier(): ASTNode? { | ||
| return prevCodeSibling() | ||
| ?.let { prevCodeSibling -> | ||
| if (prevCodeSibling.elementType == MODIFIER_LIST) { | ||
| prevCodeSibling.lastChildNode | ||
| } else { | ||
| require(prevCodeSibling.treeParent.elementType == MODIFIER_LIST) | ||
| prevCodeSibling | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.