generated from detekt/detekt-custom-rule-template
-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add NewLineAfterSuperCall
Rule
#25
Merged
+77
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
package com.doist.detekt | ||
|
||
import io.gitlab.arturbosch.detekt.api.CodeSmell | ||
import io.gitlab.arturbosch.detekt.api.Config | ||
import io.gitlab.arturbosch.detekt.api.Debt | ||
import io.gitlab.arturbosch.detekt.api.Entity | ||
import io.gitlab.arturbosch.detekt.api.Issue | ||
import io.gitlab.arturbosch.detekt.api.Rule | ||
import io.gitlab.arturbosch.detekt.api.Severity | ||
import org.jetbrains.kotlin.psi.KtNamedFunction | ||
|
||
class NewLineAfterSuperCall(config: Config = Config.empty) : Rule(config) { | ||
override val issue = Issue( | ||
javaClass.simpleName, | ||
Severity.Style, | ||
"Ensure there is a new line after every call to a super() method.", | ||
Debt.FIVE_MINS | ||
) | ||
|
||
override fun visitNamedFunction(function: KtNamedFunction) { | ||
super.visitNamedFunction(function) | ||
|
||
function.bodyBlockExpression?.statements?.forEachIndexed { index, statement -> | ||
if (statement.text?.startsWith("super.") == true) { | ||
if (statement.nextSibling.text.contains("\n\n")) return | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. there's likely a cleaner way to do this, but I am not super on top of detekt APIs so for now sticking with this as it works! |
||
report( | ||
CodeSmell( | ||
issue, | ||
Entity.from(statement), | ||
"There should be a new line after the call to super()." | ||
) | ||
) | ||
} | ||
} | ||
} | ||
} |
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 |
---|---|---|
|
@@ -12,3 +12,5 @@ DoistRuleSet: | |
TodoPattern: | ||
active: true | ||
pattern: '// TODO(.+): .*' | ||
NewLineAfterSuperCall: | ||
active: true |
39 changes: 39 additions & 0 deletions
39
src/test/kotlin/com/doist/detekt/NewLineAfterSuperCallTest.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,39 @@ | ||
package com.doist.detekt | ||
|
||
|
||
import io.gitlab.arturbosch.detekt.rules.KotlinCoreEnvironmentTest | ||
import io.gitlab.arturbosch.detekt.test.lint | ||
import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment | ||
import org.junit.jupiter.api.Assertions.assertEquals | ||
import org.junit.jupiter.api.Test | ||
|
||
@KotlinCoreEnvironmentTest | ||
internal class NewLineAfterSuperCallTest(private val env: KotlinCoreEnvironment) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👏 |
||
@Test | ||
fun `should report when there is no blank line after super() call`() { | ||
val code = """ | ||
override fun foo() { | ||
super.foo() | ||
bar.bazinga() | ||
} | ||
""" | ||
|
||
val findings = NewLineAfterSuperCall().lint(code) | ||
assertEquals(1, findings.size) | ||
assertEquals("There should be a new line after the call to super().", findings.first().message) | ||
} | ||
|
||
@Test | ||
fun `should not report when there is a blank line after super() call`() { | ||
val code = """ | ||
override fun foo() { | ||
super.foo() | ||
|
||
bar.bazinga() | ||
} | ||
""" | ||
|
||
val findings = NewLineAfterSuperCall().lint(code) | ||
assertEquals(0, findings.size) | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A bit ironic but ... Can we add an empty line here, please? 😇😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LOL