-
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.
Extract rule
no-single-line-block-comment from comment-wrapping r…
- Loading branch information
1 parent
9256b8e
commit 930d263
Showing
8 changed files
with
291 additions
and
164 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
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
81 changes: 81 additions & 0 deletions
81
...c/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/NoSingleLineBlockCommentRule.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,81 @@ | ||
| package com.pinterest.ktlint.ruleset.standard.rules | ||
|
|
||
| import com.pinterest.ktlint.rule.engine.core.api.ElementType.BLOCK_COMMENT | ||
| import com.pinterest.ktlint.rule.engine.core.api.ElementType.EOL_COMMENT | ||
| import com.pinterest.ktlint.rule.engine.core.api.Rule | ||
| import com.pinterest.ktlint.rule.engine.core.api.Rule.VisitorModifier.RunAfterRule | ||
| import com.pinterest.ktlint.rule.engine.core.api.Rule.VisitorModifier.RunAfterRule.Mode.REGARDLESS_WHETHER_RUN_AFTER_RULE_IS_LOADED_OR_DISABLED | ||
| import com.pinterest.ktlint.rule.engine.core.api.RuleId | ||
| 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.isWhiteSpace | ||
| import com.pinterest.ktlint.rule.engine.core.api.isWhiteSpaceWithNewline | ||
| import com.pinterest.ktlint.rule.engine.core.api.lastChildLeafOrSelf | ||
| import com.pinterest.ktlint.rule.engine.core.api.nextLeaf | ||
| 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.PsiCommentImpl | ||
| import org.jetbrains.kotlin.psi.psiUtil.leaves | ||
|
|
||
| /** | ||
| * A block comment following another element on the same line is replaced with an EOL comment, if possible. | ||
| */ | ||
| public class NoSingleLineBlockCommentRule : | ||
| StandardRule( | ||
| id = "no-single-line-block-comment", | ||
| usesEditorConfigProperties = | ||
| setOf( | ||
| INDENT_SIZE_PROPERTY, | ||
| INDENT_STYLE_PROPERTY, | ||
| ), | ||
| visitorModifiers = setOf(RunAfterRule(COMMENT_WRAPPING_RULE_ID, REGARDLESS_WHETHER_RUN_AFTER_RULE_IS_LOADED_OR_DISABLED)), | ||
| ), | ||
| Rule.Experimental, | ||
| Rule.OfficialCodeStyle { | ||
| override fun beforeVisitChildNodes( | ||
| node: ASTNode, | ||
| autoCorrect: Boolean, | ||
| emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit, | ||
| ) { | ||
| if (node.elementType == BLOCK_COMMENT) { | ||
| val afterBlockComment = | ||
| node | ||
| .leaves() | ||
| .takeWhile { it.isWhiteSpace() && !it.textContains('\n') } | ||
| .firstOrNull() | ||
| ?: node.lastChildLeafOrSelf() | ||
|
|
||
| if (!node.textContains('\n') && | ||
| !node.isKtlintSuppressionDirective() && | ||
| afterBlockComment.nextLeaf().isWhitespaceWithNewlineOrNull() | ||
| ) { | ||
| emit(node.startOffset, "Replace the block comment with an EOL comment", true) | ||
| if (autoCorrect) { | ||
| node.replaceWithEndOfLineComment() | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun ASTNode.replaceWithEndOfLineComment() { | ||
| val content = text.removeSurrounding("/*", "*/").trim() | ||
| val eolComment = PsiCommentImpl(EOL_COMMENT, "// $content") | ||
| (this as LeafPsiElement).rawInsertBeforeMe(eolComment) | ||
| rawRemove() | ||
| } | ||
|
|
||
| private fun ASTNode?.isWhitespaceWithNewlineOrNull() = this == null || this.isWhiteSpaceWithNewline() | ||
|
|
||
| // TODO: Remove when ktlint suppression directive in comments are no longer supported | ||
| private fun ASTNode?.isKtlintSuppressionDirective() = | ||
| this | ||
| ?.text | ||
| ?.removePrefix("/*") | ||
| ?.removeSuffix("*/") | ||
| ?.trim() | ||
| ?.let { it.startsWith("ktlint-enable") || it.startsWith("ktlint-disable") } | ||
| ?: false | ||
| } | ||
|
|
||
| public val NO_SINGLE_LINE_BLOCK_COMMENT_RULE_ID: RuleId = NoSingleLineBlockCommentRule().ruleId |
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.