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.

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

Suppress property-naming rule via @Suppress("ConstPropertyName") #2442

Merged
merged 2 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/snapshot/docs/rules/standard.md
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ Enforce naming of property.
}
```

This rule can also be suppressed with the IntelliJ IDEA inspection suppression `PropertyName`.
This rule can also be suppressed with the IntelliJ IDEA inspection suppression `PropertyName` or `ConstPropertyName`.

Rule id: `property-naming` (`standard` rule set)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ internal object SuppressionLocatorBuilder {
"FunctionName" to "standard:function-naming",
"PackageName" to "standard:package-name",
"PropertyName" to "standard:property-naming",
"ConstPropertyName" to "standard:property-naming",
"UnusedImport" to "standard:no-unused-imports",
)
private val SUPPRESS_ANNOTATIONS = setOf("Suppress", "SuppressWarnings")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -416,4 +416,30 @@ class PropertyNamingRuleTest {
LintViolation(12, 9, "Backing property name not allowed when 'private' modifier is missing", canBeAutoCorrected = false),
)
}

@Test
fun `Given a property name suppressed via 'PropertyName' then also suppress the ktlint violation`() {
val code =
"""
class Foo {
@Suppress("PropertyName")
var FOO = "foo"
}
""".trimIndent()
propertyNamingRuleAssertThat(code).hasNoLintViolations()
}

@Test
fun `Issue 2441 - Given a property name suppressed via 'ConstPropertyName' then also suppress the ktlint violation`() {
val code =
"""
interface Bar {
companion object {
@Suppress("ConstPropertyName")
const val bar: String = ""
}
}
""".trimIndent()
propertyNamingRuleAssertThat(code).hasNoLintViolations()
}
}