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

Don't exclude the naming rules by default for tests #4438

Merged
merged 3 commits into from Jan 3, 2022
Merged

Don't exclude the naming rules by default for tests #4438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
517500a
Improve code
BraisGabin Jan 2, 2022
eea935a
Allow camelCase in TopLevelPropertyNaming.constantPattern
BraisGabin Jan 2, 2022
89c63d4
In general all the naming conventions apply too for test code
BraisGabin Jan 2, 2022
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
2 changes: 2 additions & 0 deletions config/detekt/detekt.yml
View file
Open in desktop
Expand Up @@ -103,6 +103,8 @@ formatting:
active: true

naming:
TopLevelPropertyNaming:
constantPattern: '[a-z][_A-Za-z0-9]*|[A-Z][_A-Z0-9]*'
InvalidPackageDeclaration:
active: true
excludes: ['**/build-logic/**/*.kt', '**/*.kts']
Expand Down
16 changes: 0 additions & 16 deletions detekt-core/src/main/resources/default-detekt-config.yml
View file
Open in desktop
Expand Up @@ -414,34 +414,27 @@ naming:
active: true
BooleanPropertyNaming:
active: false
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
allowedPattern: '^(is|has|are)'
ClassNaming:
active: true
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
classPattern: '[A-Z][a-zA-Z0-9]*'
ConstructorParameterNaming:
active: true
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
parameterPattern: '[a-z][A-Za-z0-9]*'
privateParameterPattern: '[a-z][A-Za-z0-9]*'
excludeClassPattern: '$^'
ignoreOverridden: true
EnumNaming:
active: true
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
enumEntryPattern: '[A-Z][_a-zA-Z0-9]*'
ForbiddenClassName:
active: false
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
forbiddenName: []
FunctionMaxLength:
active: false
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
maximumFunctionNameLength: 30
FunctionMinLength:
active: false
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
minimumFunctionNameLength: 3
FunctionNaming:
active: true
Expand All @@ -451,7 +444,6 @@ naming:
ignoreOverridden: true
FunctionParameterNaming:
active: true
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
parameterPattern: '[a-z][A-Za-z0-9]*'
excludeClassPattern: '$^'
ignoreOverridden: true
Expand All @@ -460,7 +452,6 @@ naming:
rootPackage: ''
LambdaParameterNaming:
active: false
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
parameterPattern: '[a-z][A-Za-z0-9]*|_'
MatchingDeclarationName:
active: true
Expand All @@ -472,34 +463,27 @@ naming:
active: false
NonBooleanPropertyPrefixedWithIs:
active: false
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
ObjectPropertyNaming:
active: true
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
constantPattern: '[A-Za-z][_A-Za-z0-9]*'
propertyPattern: '[A-Za-z][_A-Za-z0-9]*'
privatePropertyPattern: '(_)?[A-Za-z][_A-Za-z0-9]*'
PackageNaming:
active: true
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
packagePattern: '[a-z]+(\.[a-z][A-Za-z0-9]*)*'
TopLevelPropertyNaming:
active: true
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
constantPattern: '[A-Z][_A-Z0-9]*'
propertyPattern: '[A-Za-z][_A-Za-z0-9]*'
privatePropertyPattern: '_?[A-Za-z][_A-Za-z0-9]*'
VariableMaxLength:
active: false
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
maximumVariableNameLength: 64
VariableMinLength:
active: false
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
minimumVariableNameLength: 1
VariableNaming:
active: true
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
variablePattern: '[a-z][A-Za-z0-9]*'
privateVariablePattern: '(_)?[a-z][A-Za-z0-9]*'
excludeClassPattern: '$^'
Expand Down
3 changes: 1 addition & 2 deletions .../src/main/kotlin/io/gitlab/arturbosch/detekt/generator/printer/defaultconfig/Exclusion.kt
View file
Open in desktop
Expand Up @@ -26,15 +26,14 @@ private object TestExclusions : Exclusions() {
"['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']"
override val ruleSets = emptySet<String>()
override val rules = setOf(
"NamingRules",
"FunctionNaming",
"WildcardImport",
"MagicNumber",
"LateinitUsage",
"StringLiteralDuplication",
"SpreadOperator",
"TooManyFunctions",
"ForEachOnRange",
"FunctionMaxLength",
"TooGenericExceptionCaught",
"InstanceOfCheckForException",
"ThrowingExceptionsWithoutMessageOrCause",
Expand Down
5 changes: 3 additions & 2 deletions ...s/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/exceptions/TooGenericExceptionSpec.kt
View file
Open in desktop
Expand Up @@ -24,7 +24,7 @@ class TooGenericExceptionSpec : Spek({
})

const val tooGenericExceptionCode = """
fun main() {
fun main() {
try {
throw Throwable()
} catch (e: ArrayIndexOutOfBoundsException) {
Expand All @@ -41,4 +41,5 @@ const val tooGenericExceptionCode = """
} catch (e: NullPointerException) {

}
}"""
}
"""
105 changes: 52 additions & 53 deletions ...ons/src/test/kotlin/io/gitlab/arturbosch/detekt/sample/extensions/TooManyFunctionsSpec.kt
View file
Open in desktop
Expand Up @@ -20,73 +20,72 @@ class TooManyFunctionsSpec : Spek({
}
})

const val code: String =
"""
class TooManyFunctions : Rule("TooManyFunctions") {
private const val code: String = """
class TooManyFunctions : Rule("TooManyFunctions") {

override fun visitUserType(type: KtUserType) {
super.visitUserType(type)
}
override fun visitUserType(type: KtUserType) {
super.visitUserType(type)
}

override fun visitReferenceExpression(expression: KtReferenceExpression) {
super.visitReferenceExpression(expression)
}
override fun visitReferenceExpression(expression: KtReferenceExpression) {
super.visitReferenceExpression(expression)
}

override fun visitCallExpression(expression: KtCallExpression) {
super.visitCallExpression(expression)
}
override fun visitCallExpression(expression: KtCallExpression) {
super.visitCallExpression(expression)
}

override fun visitBlockStringTemplateEntry(entry: KtBlockStringTemplateEntry) {
super.visitBlockStringTemplateEntry(entry)
}
override fun visitBlockStringTemplateEntry(entry: KtBlockStringTemplateEntry) {
super.visitBlockStringTemplateEntry(entry)
}

override fun visitUnaryExpression(expression: KtUnaryExpression) {
super.visitUnaryExpression(expression)
}
override fun visitUnaryExpression(expression: KtUnaryExpression) {
super.visitUnaryExpression(expression)
}

override fun visitDynamicType(type: KtDynamicType) {
super.visitDynamicType(type)
}
override fun visitDynamicType(type: KtDynamicType) {
super.visitDynamicType(type)
}

override fun visitDynamicType(type: KtDynamicType, data: Void?): Void {
return super.visitDynamicType(type, data)
}
override fun visitDynamicType(type: KtDynamicType, data: Void?): Void {
return super.visitDynamicType(type, data)
}

override fun visitSuperTypeCallEntry(call: KtSuperTypeCallEntry) {
super.visitSuperTypeCallEntry(call)
}
override fun visitSuperTypeCallEntry(call: KtSuperTypeCallEntry) {
super.visitSuperTypeCallEntry(call)
}

override fun visitParenthesizedExpression(expression: KtParenthesizedExpression) {
super.visitParenthesizedExpression(expression)
}
override fun visitParenthesizedExpression(expression: KtParenthesizedExpression) {
super.visitParenthesizedExpression(expression)
}

override fun visitFinallySection(finallySection: KtFinallySection) {
super.visitFinallySection(finallySection)
}
override fun visitFinallySection(finallySection: KtFinallySection) {
super.visitFinallySection(finallySection)
}

override fun visitStringTemplateExpression(expression: KtStringTemplateExpression) {
super.visitStringTemplateExpression(expression)
}
override fun visitStringTemplateExpression(expression: KtStringTemplateExpression) {
super.visitStringTemplateExpression(expression)
}

override fun visitDeclaration(dcl: KtDeclaration) {
super.visitDeclaration(dcl)
}
override fun visitDeclaration(dcl: KtDeclaration) {
super.visitDeclaration(dcl)
}

override fun visitLabeledExpression(expression: KtLabeledExpression) {
super.visitLabeledExpression(expression)
}
override fun visitLabeledExpression(expression: KtLabeledExpression) {
super.visitLabeledExpression(expression)
}

override fun visitEscapeStringTemplateEntry(entry: KtEscapeStringTemplateEntry) {
super.visitEscapeStringTemplateEntry(entry)
}
override fun visitEscapeStringTemplateEntry(entry: KtEscapeStringTemplateEntry) {
super.visitEscapeStringTemplateEntry(entry)
}

override fun visitScript(script: KtScript) {
super.visitScript(script)
}
override fun visitScript(script: KtScript) {
super.visitScript(script)
}

override fun visitTypeConstraintList(list: KtTypeConstraintList) {
super.visitTypeConstraintList(list)
}
override fun visitTypeConstraintList(list: KtTypeConstraintList) {
super.visitTypeConstraintList(list)
}

}
"""
}
"""
2 changes: 1 addition & 1 deletion ...in/io/gitlab/arturbosch/detekt/sample/extensions/processors/QualifiedNameProcessorSpec.kt
View file
Open in desktop
Expand Up @@ -54,7 +54,7 @@ private val result = object : Detektion {
}
}

const val code = """
private const val code = """
package io.gitlab.arturbosch.detekt.sample

class Foo {}
Expand Down