505 lines
12 KiB
YAML
505 lines
12 KiB
YAML
# https://github.com/arturbosch/detekt/blob/1.3.1/detekt-cli/src/main/resources/default-detekt-config.yml
|
|
|
|
comments:
|
|
active: false
|
|
|
|
complexity:
|
|
active: true
|
|
ComplexCondition:
|
|
active: true
|
|
threshold: 4
|
|
ComplexInterface:
|
|
active: true
|
|
threshold: 10
|
|
includeStaticDeclarations: false
|
|
ComplexMethod:
|
|
active: true
|
|
threshold: 15
|
|
ignoreSingleWhenExpression: false
|
|
ignoreSimpleWhenEntries: false
|
|
ignoreNestingFunctions: false
|
|
nestingFunctions: run,let,apply,with,also,use,forEach,isNotNull,ifNull
|
|
LabeledExpression:
|
|
active: false
|
|
ignoredLabels: ""
|
|
LargeClass:
|
|
active: true
|
|
threshold: 600
|
|
LongMethod:
|
|
active: true
|
|
threshold: 60
|
|
LongParameterList:
|
|
active: true
|
|
threshold: 6
|
|
ignoreDefaultParameters: true
|
|
MethodOverloading:
|
|
active: false
|
|
NestedBlockDepth:
|
|
active: true
|
|
threshold: 4
|
|
StringLiteralDuplication:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
threshold: 3
|
|
ignoreAnnotation: true
|
|
excludeStringsWithLessThan5Characters: true
|
|
ignoreStringsRegex: '$^'
|
|
TooManyFunctions:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
thresholdInFiles: 11
|
|
thresholdInClasses: 11
|
|
thresholdInInterfaces: 11
|
|
thresholdInObjects: 11
|
|
thresholdInEnums: 11
|
|
ignoreDeprecated: true
|
|
ignorePrivate: false
|
|
ignoreOverridden: true
|
|
|
|
empty-blocks:
|
|
active: true
|
|
EmptyCatchBlock:
|
|
active: true
|
|
allowedExceptionNameRegex: "^(_|(ignore|expected).*)"
|
|
EmptyClassBlock:
|
|
active: true
|
|
EmptyDefaultConstructor:
|
|
active: true
|
|
EmptyDoWhileBlock:
|
|
active: true
|
|
EmptyElseBlock:
|
|
active: true
|
|
EmptyFinallyBlock:
|
|
active: true
|
|
EmptyForBlock:
|
|
active: true
|
|
EmptyFunctionBlock:
|
|
active: true
|
|
ignoreOverriddenFunctions: true
|
|
EmptyIfBlock:
|
|
active: true
|
|
EmptyInitBlock:
|
|
active: true
|
|
EmptyKtFile:
|
|
active: true
|
|
EmptySecondaryConstructor:
|
|
active: true
|
|
EmptyWhenBlock:
|
|
active: true
|
|
EmptyWhileBlock:
|
|
active: true
|
|
|
|
exceptions:
|
|
active: true
|
|
ExceptionRaisedInUnexpectedLocation:
|
|
active: true
|
|
methodNames: 'toString,hashCode,equals,finalize'
|
|
InstanceOfCheckForException:
|
|
active: false
|
|
NotImplementedDeclaration:
|
|
active: true
|
|
PrintStackTrace:
|
|
active: false
|
|
RethrowCaughtException:
|
|
active: false
|
|
ReturnFromFinally:
|
|
active: true
|
|
ignoreLabeled: true
|
|
SwallowedException:
|
|
active: true
|
|
ignoredExceptionTypes: 'InterruptedException,NumberFormatException,ParseException,MalformedURLException'
|
|
allowedExceptionNameRegex: "^(_|(ignore|expected).*)"
|
|
ThrowingExceptionFromFinally:
|
|
active: false
|
|
ThrowingExceptionInMain:
|
|
active: true
|
|
ThrowingExceptionsWithoutMessageOrCause:
|
|
active: true
|
|
exceptions: 'IllegalArgumentException,IllegalStateException,IOException'
|
|
ThrowingNewInstanceOfSameException:
|
|
active: true
|
|
TooGenericExceptionCaught:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
exceptionNames:
|
|
- ArrayIndexOutOfBoundsException
|
|
- Error
|
|
- Exception
|
|
- IllegalMonitorStateException
|
|
- NullPointerException
|
|
- IndexOutOfBoundsException
|
|
- RuntimeException
|
|
- Throwable
|
|
allowedExceptionNameRegex: "^(_|(ignore|expected).*)"
|
|
TooGenericExceptionThrown:
|
|
active: true
|
|
exceptionNames:
|
|
- Error
|
|
- Exception
|
|
- Throwable
|
|
- RuntimeException
|
|
|
|
formatting:
|
|
active: true
|
|
android: true
|
|
autoCorrect: true
|
|
AnnotationOnSeparateLine:
|
|
active: true
|
|
autoCorrect: true
|
|
ChainWrapping:
|
|
active: true
|
|
autoCorrect: true
|
|
CommentSpacing:
|
|
active: false
|
|
Filename:
|
|
active: true
|
|
FinalNewline:
|
|
active: true
|
|
autoCorrect: true
|
|
ImportOrdering:
|
|
active: false
|
|
Indentation:
|
|
active: true
|
|
autoCorrect: true
|
|
indentSize: 4
|
|
continuationIndentSize: 4
|
|
MaximumLineLength:
|
|
active: false
|
|
ModifierOrdering:
|
|
active: true
|
|
autoCorrect: true
|
|
MultiLineIfElse:
|
|
active: true
|
|
autoCorrect: true
|
|
NoBlankLineBeforeRbrace:
|
|
active: true
|
|
autoCorrect: true
|
|
NoConsecutiveBlankLines:
|
|
active: true
|
|
autoCorrect: true
|
|
NoEmptyClassBody:
|
|
active: true
|
|
autoCorrect: true
|
|
NoLineBreakAfterElse:
|
|
active: true
|
|
autoCorrect: true
|
|
NoLineBreakBeforeAssignment:
|
|
active: true
|
|
autoCorrect: true
|
|
NoMultipleSpaces:
|
|
active: false
|
|
NoSemicolons:
|
|
active: true
|
|
autoCorrect: true
|
|
NoTrailingSpaces:
|
|
active: true
|
|
autoCorrect: true
|
|
NoUnitReturn:
|
|
active: true
|
|
autoCorrect: true
|
|
NoUnusedImports:
|
|
active: true
|
|
autoCorrect: true
|
|
NoWildcardImports:
|
|
active: false
|
|
PackageName:
|
|
active: true
|
|
autoCorrect: true
|
|
ParameterListWrapping:
|
|
active: false
|
|
SpacingAroundColon:
|
|
active: true
|
|
autoCorrect: true
|
|
SpacingAroundComma:
|
|
active: true
|
|
autoCorrect: true
|
|
SpacingAroundCurly:
|
|
active: true
|
|
autoCorrect: true
|
|
SpacingAroundDot:
|
|
active: true
|
|
autoCorrect: true
|
|
SpacingAroundKeyword:
|
|
active: true
|
|
autoCorrect: true
|
|
SpacingAroundOperators:
|
|
active: true
|
|
autoCorrect: true
|
|
SpacingAroundParens:
|
|
active: true
|
|
autoCorrect: true
|
|
SpacingAroundRangeOperator:
|
|
active: true
|
|
autoCorrect: true
|
|
StringTemplate:
|
|
active: true
|
|
autoCorrect: true
|
|
|
|
naming:
|
|
active: true
|
|
ClassNaming:
|
|
active: true
|
|
classPattern: '[A-Z$][a-zA-Z0-9$]*'
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
ConstructorParameterNaming:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
parameterPattern: '[a-z][A-Za-z0-9]*'
|
|
privateParameterPattern: '[a-z][A-Za-z0-9]*'
|
|
excludeClassPattern: '$^'
|
|
ignoreOverridden: true
|
|
EnumNaming:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
enumEntryPattern: '^[A-Z][_a-zA-Z0-9]*'
|
|
ForbiddenClassName:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
forbiddenName: ''
|
|
FunctionMaxLength:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
maximumFunctionNameLength: 30
|
|
FunctionMinLength:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
minimumFunctionNameLength: 3
|
|
FunctionNaming:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
functionPattern: '^([a-z$][a-zA-Z$0-9]*)|(`.*`)$'
|
|
excludeClassPattern: '$^'
|
|
ignoreOverridden: true
|
|
FunctionParameterNaming:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
parameterPattern: '[a-z][A-Za-z0-9]*'
|
|
excludeClassPattern: '$^'
|
|
ignoreOverriddenFunctions: true
|
|
InvalidPackageDeclaration:
|
|
active: true
|
|
rootPackage: ''
|
|
MatchingDeclarationName:
|
|
active: true
|
|
MemberNameEqualsClassName:
|
|
active: false
|
|
ObjectPropertyNaming:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
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/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
packagePattern: '^[a-z]+(\.[a-z][A-Za-z0-9]*)*$'
|
|
TopLevelPropertyNaming:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
constantPattern: '[A-Z][_A-Z0-9]*'
|
|
propertyPattern: '[A-Za-z][_A-Za-z0-9]*'
|
|
privatePropertyPattern: '_?[A-Za-z][_A-Za-z0-9]*'
|
|
VariableMaxLength:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
maximumVariableNameLength: 64
|
|
VariableMinLength:
|
|
active: false
|
|
VariableNaming:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
variablePattern: '[a-z][A-Za-z0-9]*'
|
|
privateVariablePattern: '(_)?[a-z][A-Za-z0-9]*'
|
|
excludeClassPattern: '$^'
|
|
ignoreOverridden: true
|
|
|
|
performance:
|
|
active: true
|
|
ArrayPrimitive:
|
|
active: true
|
|
ForEachOnRange:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
SpreadOperator:
|
|
active: true
|
|
excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
|
|
UnnecessaryTemporaryInstantiation:
|
|
active: true
|
|
|
|
potential-bugs:
|
|
active: true
|
|
Deprecation:
|
|
active: true
|
|
DuplicateCaseInWhenExpression:
|
|
active: true
|
|
EqualsAlwaysReturnsTrueOrFalse:
|
|
active: true
|
|
EqualsWithHashCodeExist:
|
|
active: true
|
|
ExplicitGarbageCollectionCall:
|
|
active: true
|
|
HasPlatformType:
|
|
active: true
|
|
ImplicitDefaultLocale:
|
|
active: true
|
|
InvalidRange:
|
|
active: true
|
|
IteratorHasNextCallsNextMethod:
|
|
active: true
|
|
IteratorNotThrowingNoSuchElementException:
|
|
active: true
|
|
LateinitUsage:
|
|
active: false
|
|
MapGetWithNotNullAssertionOperator:
|
|
active: true
|
|
MissingWhenCase:
|
|
active: false
|
|
RedundantElseInWhen:
|
|
active: true
|
|
UnconditionalJumpStatementInLoop:
|
|
active: true
|
|
UnreachableCode:
|
|
active: true
|
|
UnsafeCallOnNullableType:
|
|
active: true
|
|
UnsafeCast:
|
|
active: false
|
|
UselessPostfixExpression:
|
|
active: true
|
|
WrongEqualsTypeParameter:
|
|
active: true
|
|
|
|
style:
|
|
active: true
|
|
CollapsibleIfStatements:
|
|
active: true
|
|
DataClassContainsFunctions:
|
|
active: false
|
|
DataClassShouldBeImmutable:
|
|
active: false
|
|
EqualsNullCall:
|
|
active: true
|
|
EqualsOnSignatureLine:
|
|
active: true
|
|
ExplicitItLambdaParameter:
|
|
active: true
|
|
ExpressionBodySyntax:
|
|
active: true
|
|
includeLineWrapping: false
|
|
ForbiddenComment:
|
|
active: true
|
|
values: 'TODO:,FIXME:,STOPSHIP:'
|
|
allowedPatterns: ""
|
|
ForbiddenImport:
|
|
active: true
|
|
imports: ''
|
|
forbiddenPatterns: ""
|
|
ForbiddenMethodCall:
|
|
active: true
|
|
methods: ''
|
|
ForbiddenPublicDataClass:
|
|
active: true
|
|
ignorePackages: '*.internal,*.internal.*'
|
|
ForbiddenVoid:
|
|
active: true
|
|
ignoreOverridden: true
|
|
ignoreUsageInGenerics: false
|
|
FunctionOnlyReturningConstant:
|
|
active: true
|
|
ignoreOverridableFunction: true
|
|
excludedFunctions: 'describeContents'
|
|
excludeAnnotatedFunction: "dagger.Provides"
|
|
LibraryCodeMustSpecifyReturnType:
|
|
active: true
|
|
LoopWithTooManyJumpStatements:
|
|
active: true
|
|
maxJumpCount: 1
|
|
MagicNumber:
|
|
active: false
|
|
MandatoryBracesIfStatements:
|
|
active: false
|
|
MaxLineLength:
|
|
active: true
|
|
maxLineLength: 120
|
|
excludePackageStatements: true
|
|
excludeImportStatements: true
|
|
excludeCommentStatements: true
|
|
MayBeConst:
|
|
active: true
|
|
ModifierOrder:
|
|
active: true
|
|
NestedClassesVisibility:
|
|
active: true
|
|
NewLineAtEndOfFile:
|
|
active: true
|
|
NoTabs:
|
|
active: true
|
|
OptionalAbstractKeyword:
|
|
active: true
|
|
OptionalUnit:
|
|
active: true
|
|
OptionalWhenBraces:
|
|
active: false
|
|
PreferToOverPairSyntax:
|
|
active: false
|
|
ProtectedMemberInFinalClass:
|
|
active: true
|
|
RedundantExplicitType:
|
|
active: true
|
|
RedundantVisibilityModifierRule:
|
|
active: true
|
|
ReturnCount:
|
|
active: false
|
|
SafeCast:
|
|
active: true
|
|
SerialVersionUIDInSerializableClass:
|
|
active: true
|
|
SpacingBetweenPackageAndImports:
|
|
active: true
|
|
ThrowsCount:
|
|
active: true
|
|
max: 2
|
|
TrailingWhitespace:
|
|
active: true
|
|
UnderscoresInNumericLiterals:
|
|
active: false
|
|
UnnecessaryAbstractClass:
|
|
active: true
|
|
excludeAnnotatedClasses: "dagger.Module"
|
|
UnnecessaryAnnotationUseSiteTarget:
|
|
active: true
|
|
UnnecessaryApply:
|
|
active: true
|
|
UnnecessaryInheritance:
|
|
active: true
|
|
UnnecessaryLet:
|
|
active: true
|
|
UnnecessaryParentheses:
|
|
active: true
|
|
UntilInsteadOfRangeTo:
|
|
active: true
|
|
UnusedImports:
|
|
active: true
|
|
UnusedPrivateClass:
|
|
active: true
|
|
UnusedPrivateMember:
|
|
active: true
|
|
allowedNames: "(_|ignored|expected|serialVersionUID)"
|
|
UseArrayLiteralsInAnnotations:
|
|
active: true
|
|
UseCheckOrError:
|
|
active: true
|
|
UseDataClass:
|
|
active: false
|
|
UseIfInsteadOfWhen:
|
|
active: false
|
|
UseRequire:
|
|
active: true
|
|
UselessCallOnNotNull:
|
|
active: true
|
|
UtilityClassWithPublicConstructor:
|
|
active: true
|
|
VarCouldBeVal:
|
|
active: true
|
|
WildcardImport:
|
|
active: false
|