Additional rule set for detekt

Repository with additional rules for detekt static analysis tool. Visit the main detekt repository for details.

Setup in project

1. Download the pre-compiled library jar artifact
2. Move the artifact to a convenient place to use (for example, the project folder)
3. Add the rule set properties to detekt configuration file (yml)
4. Specify the artifact as detekt plugin

Detekt configuration file properties

AleksanderShRuleSet:
  SpecifyFunctionExplicitReturnType:
    active: true
  SpecifyPropertyExplicitReturnType:
    active: true
  AvoidFunctionTupleReturnType:
    active: true
  AvoidPropertyTupleReturnType:
    active: true

Specifying as detekt plugin

CLI

detekt-cli" --plugins "aleksandersh-detekt-ruleset-0.1.0.jar"

Gradle

TBD

CLI type resolution

detekt-cli" --jvm-target 11 --classpath "lib/kotlin-stdlib-1.5.21.jar"

Rules

SpecifyFunctionExplicitReturnType SpecifyPropertyExplicitReturnType

In most cases, functions or properties without an explicit type are harder to understand, and in some cases due to an implicit contract, it can lead to errors. Rule checks whether the type of function/property return value is explicitly specified.

Noncompliant Code

fun getProperties() = delegate.getProperties()

Compliant Code

fun getProperties(): Map<String, String> = delegate.getProperties()

Parameters

• checkPublic (default: true)
• checkInternal (default: true)
• checkProtected (default: false)
• checkPrivate (default: false)

Unit-tests

• Function
• Property

AvoidFunctionTupleReturnType AvoidPropertyTupleReturnType

Requires Type Resolution

It is more difficult to understand the return values if they are composed in a tuple, prefer to use custom classes instead.

Noncompliant Code

fun getUser(): Pair<String, String> = createUser()

Compliant Code

class User(val name: String, val email: String)
fun getUser(): User = createUser()

Parameters

• checkPublic (default: true)
• checkInternal (default: true)
• checkProtected (default: false)
• checkPrivate (default: false)

Unit-tests

• Function
• Property

Visibility parameters

• checkPublic - apply rule for public declarations
• checkInternal - apply rule for internal declarations
• checkProtected - apply rule for protected declarations
• checkPrivate - apply rule for private declarations

The visibility of a declaration is based on its modifier and the modifier of the class/object in which it is found. A common case is disabling the rule for private or protected declaration.

Unit-tests