Android detekt

print
Static code analysis for Kotlin https://arturbosch.github.io/detekt/

Add

plugins {
    id("io.gitlab.arturbosch.detekt").version("[version]")
}

detekt {
    toolVersion = "[version]"
    input = files("src/main/kotlin")
    filters = ".*/resources/.*,.*/build/.*"
    baseline = file("my-detekt-baseline.xml") // Just if you want to create a baseline file.
}

add to app

apply plugin: 'io.gitlab.arturbosch.detekt'

gradle ->Tasks-> verification -> detekt -> detektGenerateConfig

genetates a file config/detekt/detekt.yml


and then detekt -> detekt

you will get detekt reports like following

Metrics

  • number of kt files: 198
  • number of packages: 50
  • number of classes: 494
  • number of functions: 2752
  • number of properties: 3459

Findings

complexity

ComplexMethod Prefer splitting up complex methods into smaller, easier to understand methods.
NestedBlockDepth Excessive nesting leads to hidden complexity. Prefer extracting code to make it easier to understand.
TooManyFunctions Too many functions inside a/an file/class/object/interface always indicate a violation of the single responsibility principle. Maybe the file/class/object/interface wants to manage too many things at once. Extract functionality which clearly belongs together.
LongMethod One method should have one responsibility. Long methods tend to handle many things at once. Prefer smaller methods to make them easier to understand.
LargeClass One class should have one responsibility. Large classes tend to handle many things at once. Split up large classes into smaller classes that are easier to understand.
ComplexCondition Complex conditions should be simplified and extracted into well-named methods if necessary.
LongParameterList The more parameters a method has the more complex it is. Long parameter lists are often used to control complex algorithms and violate the Single Responsibility Principle. Prefer methods with short parameter lists.

empty-blocks

EmptyClassBlock Empty block of code detected. As they serve no purpose they should be removed.
EmptySecondaryConstructor Empty block of code detected. As they serve no purpose they should be removed.

EmptyCatchBlock Empty block of code detected. As they serve no purpose they should be removed.

EmptyIfBlock Empty block of code detected. As they serve no purpose they should be removed.

EmptyFunctionBlock Empty block of code detected. As they serve no purpose they should be rem


EmptyElseBlock Empty block of code detected. As they serve no purpose they should be removed.

TooGenericExceptionCaught Caught exception is too generic. Prefer catching specific exceptions to the case that is currently handled.

ConstructorParameterNaming Constructor parameter names should follow the naming convention set in the projects configuration.

EnumNaming Enum names should follow the naming convention set in the projects configuration.

VariableNaming Variable names should follow the naming convention set in the projects configuration.

MatchingDeclarationName If a source file contains only a single non-private top-level class or object, the file name should reflect the case-sensitive name plus the .kt extension.

FunctionNaming Function names should follow the naming convention set in the configuration.

FunctionParameterNaming Function parameter names should follow the naming convention set in the projects configuration.

potential-bugs

UnreachableCode Unreachable code detected. This code should be removed

style

NewLineAtEndOfFile Checks whether files end with a line separator.
MaxLineLength Line detected that is longer than the defined maximum line length in the code style.
WildcardImport Wildcard imports should be replaced with imports using fully qualified class names. Wildcard imports can lead to naming conflicts. A library update can introduce naming clashes with your classes which results in compilation errors.

ReturnCount Restrict the number of return statements in methods.

MagicNumber Report magic numbers. Magic number is a numeric literal that is not defined as a constant and hence it's unclear what the purpose of this number is. It's better to declare such numbers as constants and give them a proper name. By default, -1, 0, 1, and 2 are not considered to be magic numbers.

ForbiddenComment Flags a forbidden comment. Defaults values are TODO:, FIXME: or STOPSHIP:
"""
build:
  maxIssues: 10
  weights:
    # complexity: 2
    # LongParameterList: 1
    # style: 1
    # comments: 1

processors:
  active: true
  exclude:
  # - 'DetektProgressListener'
  # - 'FunctionCountProcessor'
  # - 'PropertyCountProcessor'
  # - 'ClassCountProcessor'
  # - 'PackageCountProcessor'
  # - 'KtFileCountProcessor'

console-reports:
  active: true
  exclude:
  #  - 'ProjectStatisticsReport'
  #  - 'ComplexityReport'
  #  - 'NotificationReport'
  #  - 'FindingsReport'
     - 'FileBasedFindingsReport'
  #  - 'BuildFailureReport'

comments:
  active: true
  excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
  CommentOverPrivateFunction:
    active: false
  CommentOverPrivateProperty:
    active: false
  EndOfSentenceFormat:
    active: false
    endOfSentenceFormat: ([.?!][ \t\n\r\f<])|([.?!:]$)
  UndocumentedPublicClass:
    active: false
    searchInNestedClass: true
    searchInInnerClass: true
    searchInInnerObject: true
    searchInInnerInterface: true
  UndocumentedPublicFunction:
    active: false
  UndocumentedPublicProperty:
    active: false

complexity:
  active: true
  ComplexCondition:
    active: true
    threshold: 4
  ComplexInterface:
    active: false
    threshold: 10
    includeStaticDeclarations: false
  ComplexMethod:
    active: true
    threshold: 10
    ignoreSingleWhenExpression: false
    ignoreSimpleWhenEntries: false
  LabeledExpression:
    active: false
    ignoredLabels: ""
  LargeClass:
    active: true
    threshold: 600
  LongMethod:
    active: true
    threshold: 60
  LongParameterList:
    active: true
    threshold: 6
    ignoreDefaultParameters: false
  MethodOverloading:
    active: false
    threshold: 6
  NestedBlockDepth:
    active: true
    threshold: 4
  StringLiteralDuplication:
    active: false
    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: false
    ignorePrivate: false
    ignoreOverridden: false

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: false
  EmptyIfBlock:
    active: true
  EmptyInitBlock:
    active: true
  EmptyKtFile:
    active: true
  EmptySecondaryConstructor:
    active: true
  EmptyWhenBlock:
    active: true
  EmptyWhileBlock:
    active: true

exceptions:
  active: true
  ExceptionRaisedInUnexpectedLocation:
    active: false
    methodNames: 'toString,hashCode,equals,finalize'
  InstanceOfCheckForException:
    active: false
    excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
  NotImplementedDeclaration:
    active: false
  PrintStackTrace:
    active: false
  RethrowCaughtException:
    active: false
  ReturnFromFinally:
    active: false
    ignoreLabeled: false
  SwallowedException:
    active: false
    ignoredExceptionTypes: 'InterruptedException,NumberFormatException,ParseException,MalformedURLException'
    allowedExceptionNameRegex: "^(_|(ignore|expected).*)"
  ThrowingExceptionFromFinally:
    active: false
  ThrowingExceptionInMain:
    active: false
  ThrowingExceptionsWithoutMessageOrCause:
    active: false
    exceptions: 'IllegalArgumentException,IllegalStateException,IOException'
  ThrowingNewInstanceOfSameException:
    active: false
  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: false
  autoCorrect: true
  AnnotationOnSeparateLine:
    active: false
    autoCorrect: true
  ChainWrapping:
    active: true
    autoCorrect: true
  CommentSpacing:
    active: true
    autoCorrect: true
  Filename:
    active: true
  FinalNewline:
    active: true
    autoCorrect: true
  ImportOrdering:
    active: false
    autoCorrect: true
  Indentation:
    active: false
    autoCorrect: true
    indentSize: 4
    continuationIndentSize: 4
  MaximumLineLength:
    active: true
    maxLineLength: 120
  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: true
    autoCorrect: true
  NoSemicolons:
    active: true
    autoCorrect: true
  NoTrailingSpaces:
    active: true
    autoCorrect: true
  NoUnitReturn:
    active: true
    autoCorrect: true
  NoUnusedImports:
    active: true
    autoCorrect: true
  NoWildcardImports:
    active: true
  PackageName:
    active: true
    autoCorrect: true
  ParameterListWrapping:
    active: true
    autoCorrect: true
    indentSize: 4
  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
    excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
    classPattern: '[A-Z$][a-zA-Z0-9$]*'
  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: '$^'
  EnumNaming:
    active: true
    excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
    enumEntryPattern: '^[A-Z][_a-zA-Z0-9]*'
  ForbiddenClassName:
    active: false
    excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
    forbiddenName: ''
  FunctionMaxLength:
    active: false
    excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"
    maximumFunctionNameLength: 30
  FunctionMinLength:
    active: false
    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: false

    rootPackage: ''

  MatchingDeclarationName:

    active: true

  MemberNameEqualsClassName:

    active: false

    ignoreOverriddenFunction: true

  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: false

    excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

    maximumVariableNameLength: 64

  VariableMinLength:

    active: false

    excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

    minimumVariableNameLength: 1

  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: false

  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: false

  DuplicateCaseInWhenExpression:

    active: true

  EqualsAlwaysReturnsTrueOrFalse:

    active: false

  EqualsWithHashCodeExist:

    active: true

  ExplicitGarbageCollectionCall:

    active: true

  HasPlatformType:

    active: false

  InvalidRange:

    active: false

  IteratorHasNextCallsNextMethod:

    active: false

  IteratorNotThrowingNoSuchElementException:

    active: false

  LateinitUsage:

    active: false

    excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

    excludeAnnotatedProperties: ""

    ignoreOnClassesPattern: ""

  MissingWhenCase:

    active: false

  RedundantElseInWhen:

    active: false

  UnconditionalJumpStatementInLoop:

    active: false

  UnreachableCode:

    active: true

  UnsafeCallOnNullableType:

    active: false

  UnsafeCast:

    active: false

  UselessPostfixExpression:

    active: false

  WrongEqualsTypeParameter:

    active: false


style:

  active: true

  CollapsibleIfStatements:

    active: false

  DataClassContainsFunctions:

    active: false

    conversionFunctionPrefix: 'to'

  DataClassShouldBeImmutable:

    active: false

  EqualsNullCall:

    active: false

  EqualsOnSignatureLine:

    active: false

  ExplicitItLambdaParameter:

    active: false

  ExpressionBodySyntax:

    active: false

    includeLineWrapping: false

  ForbiddenComment:

    active: true

    values: 'TODO:,FIXME:,STOPSHIP:'

    allowedPatterns: ""

  ForbiddenImport:

    active: false

    imports: ''

    forbiddenPatterns: ""

  ForbiddenVoid:

    active: false

    ignoreOverridden: false

    ignoreUsageInGenerics: false

  FunctionOnlyReturningConstant:

    active: false

    ignoreOverridableFunction: true

    excludedFunctions: 'describeContents'

    excludeAnnotatedFunction: "dagger.Provides"

  LibraryCodeMustSpecifyReturnType:

    active: false

  LoopWithTooManyJumpStatements:

    active: false

    maxJumpCount: 1

  MagicNumber:

    active: true

    excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

    ignoreNumbers: '-1,0,1,2'

    ignoreHashCodeFunction: true

    ignorePropertyDeclaration: false

    ignoreConstantDeclaration: true

    ignoreCompanionObjectPropertyDeclaration: true

    ignoreAnnotation: false

    ignoreNamedArgument: true

    ignoreEnums: false

    ignoreRanges: false

  MandatoryBracesIfStatements:

    active: false

  MaxLineLength:

    active: true

    maxLineLength: 120

    excludePackageStatements: true

    excludeImportStatements: true

    excludeCommentStatements: false

  MayBeConst:

    active: false

  ModifierOrder:

    active: true

  NestedClassesVisibility:

    active: false

  NewLineAtEndOfFile:

    active: true

  NoTabs:

    active: false

  OptionalAbstractKeyword:

    active: true

  OptionalUnit:

    active: false

  OptionalWhenBraces:

    active: false

  PreferToOverPairSyntax:

    active: false

  ProtectedMemberInFinalClass:

    active: false

  RedundantExplicitType:

    active: false

  RedundantVisibilityModifierRule:

    active: false

  ReturnCount:

    active: true

    max: 2

    excludedFunctions: "equals"

    excludeLabeled: false

    excludeReturnFromLambda: true

    excludeGuardClauses: false

  SafeCast:

    active: true

  SerialVersionUIDInSerializableClass:

    active: false

  SpacingBetweenPackageAndImports:

    active: false

  ThrowsCount:

    active: true

    max: 2

  TrailingWhitespace:

    active: false

  UnderscoresInNumericLiterals:

    active: false

    acceptableDecimalLength: 5

  UnnecessaryAbstractClass:

    active: false

    excludeAnnotatedClasses: "dagger.Module"

  UnnecessaryApply:

    active: false

  UnnecessaryInheritance:

    active: false

  UnnecessaryLet:

    active: false

  UnnecessaryParentheses:

    active: false

  UntilInsteadOfRangeTo:

    active: false

  UnusedImports:

    active: false

  UnusedPrivateClass:

    active: false

  UnusedPrivateMember:

    active: false

    allowedNames: "(_|ignored|expected|serialVersionUID)"

  UseArrayLiteralsInAnnotations:

    active: false

  UseCheckOrError:

    active: false

  UseDataClass:

    active: false

    excludeAnnotatedClasses: ""

    allowVars: false

  UseIfInsteadOfWhen:

    active: false

  UseRequire:

    active: false

  UselessCallOnNotNull:

    active: false

  UtilityClassWithPublicConstructor:

    active: false

  VarCouldBeVal:

    active: false

  WildcardImport:

    active: true

    excludes: "**/test/**,**/androidTest/**,**/*.Test.kt,**/*.Spec.kt,**/*.Spek.kt"

    excludeImports: 'java.util.*,kotlinx.android.synthetic.*'



					

	


	




			
	
			



	
	
	
		

		
Leave a Reply 
Your email address will not be published. Required fields are marked *
 
 



 


 


	

	
This site uses Akismet to reduce spam. Learn how your comment data is processed.