-
Notifications
You must be signed in to change notification settings - Fork 506
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add multiline-loop to complement multiline-if-else (#2298)
* Add multiline-loop to complement multiline-if-else
- Loading branch information
Showing
6 changed files
with
379 additions
and
1 deletion.
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
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
116 changes: 116 additions & 0 deletions
116
...standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/MultilineLoopRule.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,116 @@ | ||
| package com.pinterest.ktlint.ruleset.standard.rules | ||
|
|
||
| import com.pinterest.ktlint.rule.engine.core.api.ElementType.BLOCK | ||
| import com.pinterest.ktlint.rule.engine.core.api.ElementType.BODY | ||
| import com.pinterest.ktlint.rule.engine.core.api.ElementType.DO_KEYWORD | ||
| import com.pinterest.ktlint.rule.engine.core.api.ElementType.LBRACE | ||
| import com.pinterest.ktlint.rule.engine.core.api.ElementType.RBRACE | ||
| import com.pinterest.ktlint.rule.engine.core.api.ElementType.RPAR | ||
| import com.pinterest.ktlint.rule.engine.core.api.IndentConfig | ||
| 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.SinceKtlint | ||
| import com.pinterest.ktlint.rule.engine.core.api.SinceKtlint.Status.EXPERIMENTAL | ||
| import com.pinterest.ktlint.rule.engine.core.api.editorconfig.EditorConfig | ||
| import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_SIZE_PROPERTY | ||
| import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_STYLE_PROPERTY | ||
| import com.pinterest.ktlint.rule.engine.core.api.indent | ||
| import com.pinterest.ktlint.rule.engine.core.api.isPartOfComment | ||
| import com.pinterest.ktlint.rule.engine.core.api.isWhiteSpace | ||
| import com.pinterest.ktlint.rule.engine.core.api.isWhiteSpaceWithoutNewline | ||
| import com.pinterest.ktlint.rule.engine.core.api.nextSibling | ||
| import com.pinterest.ktlint.rule.engine.core.api.upsertWhitespaceBeforeMe | ||
| import com.pinterest.ktlint.ruleset.standard.StandardRule | ||
| import org.jetbrains.kotlin.com.intellij.lang.ASTNode | ||
| import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafPsiElement | ||
| import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.PsiWhiteSpaceImpl | ||
| import org.jetbrains.kotlin.psi.KtBlockExpression | ||
| import org.jetbrains.kotlin.psi.psiUtil.leaves | ||
|
|
||
| /** | ||
| * https://developer.android.com/kotlin/style-guide#braces | ||
| */ | ||
| @SinceKtlint("1.0", EXPERIMENTAL) | ||
| public class MultilineLoopRule : | ||
| StandardRule( | ||
| id = "multiline-loop", | ||
| usesEditorConfigProperties = | ||
| setOf( | ||
| INDENT_SIZE_PROPERTY, | ||
| INDENT_STYLE_PROPERTY, | ||
| ), | ||
| ), | ||
| Rule.Experimental { | ||
| private var indentConfig = IndentConfig.DEFAULT_INDENT_CONFIG | ||
|
|
||
| override fun beforeFirstNode(editorConfig: EditorConfig) { | ||
| indentConfig = | ||
| IndentConfig( | ||
| indentStyle = editorConfig[INDENT_STYLE_PROPERTY], | ||
| tabWidth = editorConfig[INDENT_SIZE_PROPERTY], | ||
| ) | ||
| } | ||
|
|
||
| override fun beforeVisitChildNodes( | ||
| node: ASTNode, | ||
| autoCorrect: Boolean, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| ) { | ||
| node | ||
| .takeIf { it.elementType == BODY } | ||
| ?.takeUnless { it.firstChildNode.elementType == BLOCK } | ||
| ?.takeUnless { | ||
| // Allow single line loop statements as long as they are really simple (e.g. do not contain newlines) | ||
| // for (...) <statement> | ||
| // while (...) <statement> | ||
| // do <statement> while (...) | ||
| !it.treeParent.textContains('\n') | ||
| } ?: return | ||
| emit(node.firstChildNode.startOffset, "Missing { ... }", true) | ||
|
|
||
| if (autoCorrect) { | ||
| autocorrect(node) | ||
| } | ||
| } | ||
|
|
||
| private fun autocorrect(node: ASTNode) { | ||
| val prevLeaves = | ||
| node | ||
| .leaves(forward = false) | ||
| .takeWhile { it.elementType !in listOf(RPAR, DO_KEYWORD) } | ||
| .toList() | ||
| .reversed() | ||
| val nextLeaves = | ||
| node | ||
| .leaves(forward = true) | ||
| .takeWhile { it.isWhiteSpaceWithoutNewline() || it.isPartOfComment() } | ||
| .toList() | ||
| .dropLastWhile { it.isWhiteSpaceWithoutNewline() } | ||
|
|
||
| prevLeaves | ||
| .firstOrNull() | ||
| .takeIf { it.isWhiteSpace() } | ||
| ?.let { | ||
| (it as LeafPsiElement).rawReplaceWithText(" ") | ||
| } | ||
| KtBlockExpression(null).apply { | ||
| val previousChild = node.firstChildNode | ||
| node.replaceChild(node.firstChildNode, this) | ||
| addChild(LeafPsiElement(LBRACE, "{")) | ||
| addChild(PsiWhiteSpaceImpl(indentConfig.childIndentOf(node))) | ||
| prevLeaves | ||
| .dropWhile { it.isWhiteSpace() } | ||
| .forEach(::addChild) | ||
| addChild(previousChild) | ||
| nextLeaves.forEach(::addChild) | ||
| addChild(PsiWhiteSpaceImpl(node.indent())) | ||
| addChild(LeafPsiElement(RBRACE, "}")) | ||
| } | ||
|
|
||
| node | ||
| .nextSibling { !it.isPartOfComment() } | ||
| ?.upsertWhitespaceBeforeMe(" ") | ||
| } | ||
| } | ||
|
|
||
| public val MULTILINE_LOOP_RULE_ID: RuleId = MultilineLoopRule().ruleId |
Oops, something went wrong.