Quick Start

Dependencies

Kotlin

// settings.gradle.kts

pluginManagement {
  repositories {
    gradlePluginPortal()
    // Add for SNAPSHOT builds
    maven("https://oss.sonatype.org/content/repositories/snapshots/")
  }
}

// top-level build.gradle.kts

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

Groovy

// settings.gradle

pluginManagement {
  repositories {
    gradlePluginPortal()
    // Add for SNAPSHOT builds
    maven {
      url "https://oss.sonatype.org/content/repositories/snapshots"
    }
  }
}

// top-level build.gradle

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

Tasks

all checks

./gradlew moduleCheck

all checks with auto-correct

./gradlew moduleCheckAuto

check sorting

./gradlew moduleCheckSortPlugins moduleCheckSortDependencies

apply sorting

./gradlew moduleCheckSortPluginsAuto moduleCheckSortDependenciesAuto

report depths of each module

./gradlew moduleCheckDepths

generate (module-only) dependency graphs

./gradlew moduleCheckGraphs

Configuration

See configuration for a full list of options.

Kotlin

root/build.gradle.kts

configure<com.rickbusarow.modulecheck.ModuleCheckExtension> {

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

  checks {
    redundant.set(false)
  }
}

--or--

root/build.gradle.kts

moduleCheck {

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

  checks {
    redundant.set(false)
  }
}

Groovy

root/build.gradle

moduleCheck {

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

  checks {
    redundant.set(false)
  }
}