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

Suppress backing-property-naming on @Suppress("PropertyName") #2741

Merged
merged 1 commit into from
Jul 16, 2024
Merged

Suppress backing-property-naming on @Suppress("PropertyName") #2741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 17 additions & 17 deletions ...le-engine/src/main/kotlin/com/pinterest/ktlint/rule/engine/internal/SuppressionLocator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import org.jetbrains.kotlin.psi.psiUtil.endOffset
import org.jetbrains.kotlin.psi.psiUtil.startOffset

internal class SuppressionLocator(
private val editorConfig: EditorConfig,
editorConfig: EditorConfig,
) {
private val formatterTags = FormatterTags.from(editorConfig)

Expand Down Expand Up @@ -181,7 +181,7 @@ internal class SuppressionLocator(
?.constructorReferenceExpression
?.getReferencedName() in SUPPRESS_ANNOTATIONS
}.flatMap(KtAnnotationEntry::getValueArguments)
.mapNotNull { it.toRuleId(SUPPRESS_ANNOTATION_RULE_MAP) }
.flatMap { it.findRuleSuppressionIds() }
.let { suppressedRuleIds ->
when {
suppressedRuleIds.isEmpty() -> null
Expand All @@ -200,15 +200,15 @@ internal class SuppressionLocator(
}
}

private fun ValueArgument.toRuleId(annotationValueToRuleMapping: Map<String, String>): String? =
private fun ValueArgument.findRuleSuppressionIds(): List<String> =
getArgumentExpression()
?.text
?.removeSurrounding("\"")
?.let { argumentExpressionText ->
when {
argumentExpressionText == "ktlint" -> {
// Disable all rules
ALL_KTLINT_RULES_SUPPRESSION_ID
listOf(ALL_KTLINT_RULES_SUPPRESSION_ID)
}

argumentExpressionText.startsWith("ktlint:") -> {
Expand All @@ -217,15 +217,15 @@ internal class SuppressionLocator(
// code bases in which the rule and suppression id's have not yet been fixed.
argumentExpressionText
.removePrefix("ktlint:")
.let { RuleId.prefixWithStandardRuleSetIdWhenMissing(it) }
.let { listOf(RuleId.prefixWithStandardRuleSetIdWhenMissing(it)) }
}

else -> {
// Disable specific rule if the annotation value is mapped to a specific rule
annotationValueToRuleMapping[argumentExpressionText]
SUPPRESS_ANNOTATION_RULE_MAP[argumentExpressionText]
}
}
}
}.orEmpty()

/**
* @param range zero-based range of lines where lint errors should be suppressed
Expand Down Expand Up @@ -257,16 +257,16 @@ internal class SuppressionLocator(
mapOf(
// It would have been nice if the official rule id's as defined in the Rules themselves could have been used here. But that
// would introduce a circular dependency between the ktlint-rule-engine and the ktlint-ruleset-standard modules.
"EnumEntryName" to "standard:enum-entry-name-case",
"RemoveCurlyBracesFromTemplate" to "standard:string-template",
"ClassName" to "standard:class-naming",
"FunctionName" to "standard:function-naming",
"PackageName" to "standard:package-name",
"PropertyName" to "standard:property-naming",
"ConstPropertyName" to "standard:property-naming",
"ObjectPropertyName" to "standard:property-naming",
"PrivatePropertyName" to "standard:property-naming",
"UnusedImport" to "standard:no-unused-imports",
"EnumEntryName" to listOf("standard:enum-entry-name-case"),
"RemoveCurlyBracesFromTemplate" to listOf("standard:string-template"),
"ClassName" to listOf("standard:class-naming"),
"FunctionName" to listOf("standard:function-naming"),
"PackageName" to listOf("standard:package-name"),
"PropertyName" to listOf("standard:property-naming", "standard:backing-property-naming"),
"ConstPropertyName" to listOf("standard:property-naming"),
"ObjectPropertyName" to listOf("standard:property-naming"),
"PrivatePropertyName" to listOf("standard:property-naming"),
"UnusedImport" to listOf("standard:no-unused-imports"),
)
val SUPPRESS_ANNOTATIONS = setOf("Suppress", "SuppressWarnings")
const val ALL_KTLINT_RULES_SUPPRESSION_ID = "ktlint:suppress-all-rules"
Expand Down
4 changes: 2 additions & 2 deletions .../test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/BackingPropertyNamingRuleTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,11 +279,11 @@ class BackingPropertyNamingRuleTest {
"PropertyName", // IntelliJ IDEA suppression
],
)
fun `Given class with a disallowed name which is suppressed`(suppressionName: String) {
fun `Given a property with a disallowed name which is suppressed`(suppressionName: String) {
val code =
"""
@Suppress("$suppressionName")
val foo = Foo()
val _foo = Foo()
""".trimIndent()
backingPropertyNamingRuleAssertThat(code).hasNoLintViolations()
}
Expand Down
2 changes: 1 addition & 1 deletion ...ard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/PropertyNamingRuleTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ class PropertyNamingRuleTest {
"PropertyName", // IntelliJ IDEA suppression
],
)
fun `Given a function with a disallowed name which is suppressed`(suppressionName: String) {
fun `Given a property with a disallowed name which is suppressed`(suppressionName: String) {
val code =
"""
@Suppress("$suppressionName")
Expand Down