Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fixed false positive MISSING_KDOC_ON_FUNCTION on local function (function inside another function) #1848

Merged
merged 6 commits into from
Dec 7, 2023
Merged

Fixed false positive MISSING_KDOC_ON_FUNCTION on local function (function inside another function) #1848

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eb060e9
WIP: custom setter fix
diphtongue Nov 22, 2023
c66a433
- fixed warning `CUSTOM_GETTERS_SETTERS` on properties with backing f…
diphtongue Nov 24, 2023
0717407
### What's done:
diphtongue Dec 7, 2023
f5b7f89
### What's done:
diphtongue Dec 7, 2023
30c59ae
### What's done:
diphtongue Dec 7, 2023
325134d
Closes #1773
diphtongue Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions ...t-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter1/IdentifierNaming.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import org.jetbrains.kotlin.KtNodeTypes.DESTRUCTURING_DECLARATION
import org.jetbrains.kotlin.KtNodeTypes.DESTRUCTURING_DECLARATION_ENTRY
import org.jetbrains.kotlin.KtNodeTypes.FUNCTION_TYPE
import org.jetbrains.kotlin.KtNodeTypes.OBJECT_DECLARATION
import org.jetbrains.kotlin.KtNodeTypes.PROPERTY
import org.jetbrains.kotlin.KtNodeTypes.REFERENCE_EXPRESSION
import org.jetbrains.kotlin.KtNodeTypes.TYPE_PARAMETER
import org.jetbrains.kotlin.KtNodeTypes.TYPE_REFERENCE
Expand Down
21 changes: 19 additions & 2 deletions ...t-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,22 @@ class KdocMethods(configRules: List<RulesConfig>) : DiktatRule(
}
}

@Suppress("UnsafeCallOnNullableType", "AVOID_NULL_CHECKS")
private fun hasFunParent(node: ASTNode): Boolean {
var parent = node.treeParent
while (parent != null) {
if (parent.elementType == FUN) {
return true
}
parent = parent.treeParent
}
return false
}

@Suppress(
"UnsafeCallOnNullableType",
"AVOID_NULL_CHECKS",
"CyclomaticComplexMethod"
)
private fun checkSignatureDescription(node: ASTNode) {
val kdoc = node.getFirstChildWithType(KDOC)
val kdocTags = kdoc?.kDocTags()
Expand All @@ -119,7 +134,9 @@ class KdocMethods(configRules: List<RulesConfig>) : DiktatRule(

val anyTagFailed = paramCheckFailed || returnCheckFailed || throwsCheckFailed
// if no tag failed, we have too little information to suggest KDoc - it would just be empty
if (kdoc == null && anyTagFailed) {
if (kdoc == null && hasFunParent(node)) {
return
} else if (kdoc == null && anyTagFailed) {
addKdocTemplate(node, name, missingParameters, explicitlyThrownExceptions, returnCheckFailed)
} else if (kdoc == null && !isReferenceExpressionWithSameName(node)) {
MISSING_KDOC_ON_FUNCTION.warn(configRules, emitWarn, name, node.startOffset, node)
Expand Down
99 changes: 99 additions & 0 deletions diktat-rules/src/test/kotlin/com/saveourtool/diktat/ruleset/chapter2/KdocMethodsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,4 +425,103 @@ class KdocMethodsTest : LintTestBase(::KdocMethods) {
DiktatError(2, 1, ruleId, "${MISSING_KDOC_ON_FUNCTION.warnText()} writeToConsoleEx", true),
)
}

@Test
@Tag(WarningNames.MISSING_KDOC_ON_FUNCTION)
fun `KDoc shouldn't trigger on local functions`() {
lintMethod(
"""
|fun printHelloAndBye() {
diphtongue marked this conversation as resolved.
Show resolved Hide resolved
| fun printHello() {
| print("Hello")
| }
| printHello()
| val ab = 5
| ab?.let {
| fun printBye() {
| print("Bye")
| }
| printBye()
| }
|}
""".trimMargin(),
DiktatError(1, 1, ruleId, "${MISSING_KDOC_ON_FUNCTION.warnText()} printHelloAndBye", false),
)
}

@Test
@Tag(WarningNames.MISSING_KDOC_ON_FUNCTION)
fun `KDoc shouldn't trigger on functions with KDoc`() {
lintMethod(
"""
|/**
| * prints "Hello" and "Bye"
| */
|fun printHelloAndBye() {
| fun printHello() {
| print("Hello")
| }
| printHello()
| val ab = 5
| ab?.let {
| fun printBye() {
| print("Bye")
| }
| printBye()
| }
|}
""".trimMargin(),
)
}

@Test
@Tag(WarningNames.MISSING_KDOC_ON_FUNCTION)
fun `KDoc shouldn't trigger on nested local functions`() {
lintMethod(
"""
|fun printHelloAndBye() {
| fun printHello() {
| print("Hello")
| fun printBye() {
| print("Bye")
| }
| fun printDots() {
| print("...")
| }
| printBye()
| printDots()
| }
| printHello()
|}
""".trimMargin(),
DiktatError(1, 1, ruleId, "${MISSING_KDOC_ON_FUNCTION.warnText()} printHelloAndBye", false),
)
}

@Test
@Tag(WarningNames.MISSING_KDOC_ON_FUNCTION)
fun `KDoc shouldn't trigger on local functions with KDoc`() {
lintMethod(
"""
|fun printHelloAndBye() {
| fun printHello() {
| print("Hello")
| }
| printHello()
| val ab = 5
| ab?.let {
| /**
| * prints "Bye"
| */
| fun printBye() {
| print("Bye")
| }
| printBye()
| }
|}
""".trimMargin(),
DiktatError(1, 1, ruleId, "${MISSING_KDOC_ON_FUNCTION.warnText()} printHelloAndBye", false),
)
}

}