Meisterplan Detekt Rules

This repo contains Detekt Rules useful for developing Meisterplan.

How to use it

Look up the most recent release and add the dependency to your build.gradle.kts:

dependencies {
    // ...
    detektPlugins("com.meisterplan:detekt-rules:VERSION")
}

The dependency can either be fetched from jitpack.io:

repositories {
    // ...
    maven { url = uri("https://jitpack.io") }
}

or from GitHub Packages:

repositories {
    // ...
    maven {
        url = uri("https://maven.pkg.github.com/meisterplan/detekt-rules")
        credentials {
            username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")
            password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")
        }
    }
}

If you want to configure the rules individually look at the config.yml and set the same flags in your local detekt config.

For CopyOnDataClassWithNonPublicConstructor, it is required to run detekt with type resolution.