Advanced.md

Advanced usage

Global configuration

Additional default configuration can be applied by adding to the root project's build.gradle. All submodules will use this config as default

plugins {
  id("com.starter.config") version("x.y.z")
}
 
commonConfig {
    javaVersion JavaVersion.VERSION_11
    javaFilesAllowed = true
    androidPlugin {
        compileSdkVersion 31
        minSdkVersion 26
        targetSdkVersion 31
    }
    qualityPlugin {
        formatOnCompile = false
    }
}

• javaVersion - defines which java version source code is compatible with
• javaFilesAllowed - defines if the project can contain java files, fails the build otherwise.
• androidPlugin:
  • contains values passed to Android Gradle Plugin
• qualityPlugin:
  • formatOnCompile - defines if ktlint should format source code on every compilation
• versioningPlugin:
  • enabled - enables/disables Versioning Plugin

Generating baselines

It is possible to generate baseline for every quality tool available in the project.

• Android Lint
  Type rm **/lint-*.xml ; ./gradlew projectLint -PrefreshBaseline --continue into console
• Detekt
  Create baseline using provided configuration
• ktlint
  Unfortunately it is not possible to generate ktlint baseline. Proper code style may be achieved by using ./gradlew formatKotlin task.