https://github.com/rickbusarow/ModuleCheck

Fast dependency graph validation for Gradle
https://github.com/rickbusarow/ModuleCheck

android android-library gradle kotlin multi-module

Last synced: 3 months ago
JSON representation

Fast dependency graph validation for Gradle

• Host: GitHub
• URL: https://github.com/rickbusarow/ModuleCheck
• Owner: rickbusarow
• License: apache-2.0
• Created: 2020-11-28T00:31:32.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-11-04T12:19:16.000Z (3 months ago)
• Last Synced: 2024-11-05T07:11:31.337Z (3 months ago)
• Topics: android, android-library, gradle, kotlin, multi-module
• Language: Kotlin
• Homepage: https://rickbusarow.github.io/ModuleCheck/
• Size: 27.9 MB
• Stars: 129
• Watchers: 5
• Forks: 7
• Open Issues: 86
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-list - rickbusarow/ModuleCheck - Fast dependency graph validation for Gradle (Kotlin)

README

        
[![Maven Central](https://img.shields.io/maven-central/v/com.rickbusarow.modulecheck/modulecheck-api?style=flat-square)](https://search.maven.org/search?q=com.rickbusarow.modulecheck)

[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/com.rickbusarow.module-check?style=flat-square)](https://plugins.gradle.org/plugin/com.rickbusarow.module-check)

[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/com.rickbusarow.modulecheck/modulecheck-api?label=snapshots&server=https%3A%2F%2Foss.sonatype.org&style=flat-square)](https://oss.sonatype.org/#nexus-search;quick~com.rickbusarow.modulecheck)

[![License](https://img.shields.io/badge/license-apache2.0-blue?style=flat-square.svg)](https://opensource.org/licenses/Apache-2.0)

### This is a work in progress, in a very early state, and there are bugs.

___

ModuleCheck identifies unused **internal** (sub-project) dependencies within a Gradle project.

It does this **without performing a build**, which makes the parsing extremely fast.

All inspection is done using Gradle build files, Java/Kotlin source, and `res` xml files for Kotlin.

Documentation is at [https://rbusarow.github.io/ModuleCheck](https://rbusarow.github.io/ModuleCheck/).

For snapshots, use the "next" version for documentation: https://rbusarow.github.io/ModuleCheck/docs/next/

![Diagram of flattening module structure](website/static/img/modulecheck_diagram.png)

### Config

```kotlin

// settings.gradle.kts

pluginManagement {

  repositories {

    gradlePluginPortal()

    // Add for SNAPSHOT builds

    maven("https://oss.sonatype.org/content/repositories/snapshots/")

  }

}

```

```kotlin

// top-level build.gradle.kts

plugins {

  id("com.rickbusarow.module-check") version "0.12.5"

}

```

### Tasks

all checks

```shell

./gradlew moduleCheck

```

all checks with auto-correct

```shell

./gradlew moduleCheckAuto

```

## License

``` text

Copyright (C) 2021-2023 Rick Busarow

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

     https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

```