Quick Start

note

ModuleCheck leverages Gradle for parsing all build logic, so validation works regardless of whether that logic is expressed in Groovy or Kotlin.

Dependencies

Kotlin

// settings.gradle.kts

pluginManagement {
  repositories {
    gradlePluginPortal()
  }
}

// top-level build.gradle.kts

plugins {
  id("com.rickbusarow.module-check") version "0.11.0"
}

Groovy

// settings.gradle

pluginManagement {
  repositories {
    gradlePluginPortal()
  }
}

// top-level build.gradle

plugins {
  id 'com.rickbusarow.module-check' version '0.11.0'
}

Tasks

all checks

./gradlew moduleCheck

kapt checks

./gradlew moduleCheckKapt

sorts

./gradlew moduleCheckSortPlugins moduleCheckSortDependencies

unused

./gardlew moduleCheckUnused

redundant

./gradlew moduleCheckRedundant

overshot

./gradlew moduleCheckOvershot

Configuration

See configuration for a full list of options.

Kotlin

// top-level build.gradle.kts

configure<com.rickbusarow.modulecheck.ModuleCheckExtension> {

  alwaysIgnore.set(setOf(":app"))

  checks {
    redundant.set(false)
  }
}

--or--

// top-level build.gradle.kts

moduleCheck {

  alwaysIgnore.set(setOf(":app"))

  checks {
    redundant.set(false)
  }
}

Groovy

// top-level build.gradle

moduleCheck {

  alwaysIgnore.set(setOf(":app"))

  checks {
    redundant.set(false)
  }
}