Don't allow the usage of ` in function names (#4439)

detekt · Jan 3, 2022 · ff7824d · ff7824d
1 parent 8cb63b7
commit ff7824d
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/detekt-core/src/main/resources/default-detekt-config.yml b/detekt-core/src/main/resources/default-detekt-config.yml
@@ -446,7 +446,7 @@ naming:
   FunctionNaming:
     active: true
     excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
-    functionPattern: '([a-z][a-zA-Z0-9]*)|(`.*`)'
+    functionPattern: '[a-z][a-zA-Z0-9]*'
     excludeClassPattern: '$^'
     ignoreOverridden: true
   FunctionParameterNaming:

diff --git a/...t-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/FunctionNaming.kt b/...t-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/FunctionNaming.kt
@@ -32,7 +32,7 @@ class FunctionNaming(config: Config = Config.empty) : Rule(config) {
     )
 
     @Configuration("naming pattern")
-    private val functionPattern: Regex by config("([a-z][a-zA-Z0-9]*)|(`.*`)", String::toRegex)
+    private val functionPattern: Regex by config("[a-z][a-zA-Z0-9]*", String::toRegex)
 
     @Configuration("ignores functions in classes which match this regex")
     private val excludeClassPattern: Regex by config("$^", String::toRegex)

diff --git a/...les-naming/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/naming/FunctionNamingSpec.kt b/...les-naming/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/naming/FunctionNamingSpec.kt
@@ -97,11 +97,11 @@ class FunctionNamingSpec : Spek({
             )
         }
 
-        it("allow functions with backtick") {
+        it("doesn't allow functions with backtick") {
             val code = """
                 fun `7his is a function name _`() = Unit
             """
-            assertThat(FunctionNaming().compileAndLint(code)).isEmpty()
+            assertThat(FunctionNaming().compileAndLint(code)).hasSourceLocations(SourceLocation(1, 5))
         }
     }
 })
diff --git a/...ng/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/naming/NamingConventionLengthSpec.kt b/...ng/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/naming/NamingConventionLengthSpec.kt
@@ -85,10 +85,10 @@ class NamingConventionLengthSpec : Spek({
             assertThat(subject.findings).isEmpty()
         }
 
-        it("should not report a function name that begins with a backtick, capitals, and spaces") {
+        it("should report a function name that begins with a backtick, capitals, and spaces") {
             val code = "fun `Hi bye`() = 3"
             subject.compileAndLint(code)
-            assertThat(subject.findings).isEmpty()
+            assertThat(subject.findings).hasSize(1)
         }
     }
 })