JarHC Gradle Plugin

Gradle plugin to generate a JarHC - JAR Health Check report for your project's dependencies.

---

Installation

Using the plugins DSL for Kotlin:

plugins {
    id("org.jarhc") version "1.1.0"
}

Configuration

The plugin adds a jarhcReport task to your project:

./gradlew jarhcReport

Without a specific configuration, the task will generate an HTML and a text report for all runtime dependencies of your project. Both reports can be found in the build directory:

build/
└── reports/
    └── jarhc/
        ├── jarhc-report.html
        └── jarhc-report.txt

Example reports can be found here: JarHC example reports

You can control many aspects of the JarHC task and take influence on the analysis and the report(s):

tasks {

    jarhcReport {

        // Classpath with JAR files (dependencies) to be analyzed by JarHC.
        // Default: configurations.runtimeClasspath
        classpath.setFrom(configurations.runtimeClasspath)

        // There are also properties "provided" and "runtime" to set the classpath
        // for JAR files used as provided libraries and Java runtime libraries.
        // provided.setFrom(...)
        // runtime.setFrom(...)

        // Title of the JarHC report.
        // Default: "JarHC Report for ${project.name} ${project.version}"
        reportTitle.set("ASM 7.0")

        // Path to generated report files (*.html or *.txt).
        // Default: "${buildDir}/reports/jarhc/jarhc-report.html"
        //      and "${buildDir}/reports/jarhc/jarhc-report.txt"
        reportFiles.setFrom(
            file("${projectDir}/jarhc-report-asm-7.0.html"),
            file("${projectDir}/jarhc-report-asm-7.0.txt")
        )

        // Sections to include in the report.
        // See https://github.com/smarkwal/jarhc/wiki/Usage for more details.
        // Default: empty list = include all sections
        sections.addAll("jf", "m", "cv", "jd", "d", "p", "dc", "bc", "bl")

        // Exclude sections without any issues from the report.
        // Default: false
        skipEmpty.set(true)

        // Sort JAR files in reports by name.
        // Default: false
        sortRows.set(true)

        // Java release (8, 9, 10, ...) to use for analysis of multi-release JAR files.
        // Default: version of Java used to run Gradle build
        release.set(11)

        // Classloader strategy. Used only if provided and/or runtime classpath is set.
        // Default: "ParentLast"
        strategy.set("ParentFirst")

        // Remove version numbers from JAR file names in the report.
        // Default: false
        removeVersion.set(true)

        // Recreate JAR file names based on Maven coordinates if possible.
        // Default: false
        useArtifactName.set(true)

        // Ignore issues related to missing Java annotations.
        // Default: false
        ignoreMissingAnnotations.set(true)

        // Ignore duplicate classes or resources if they are identical copies.
        // Default: false
        ignoreExactCopy.set(true)

        // Path to the data directory used by JarHC to cache downloaded JAR and POM files.
        // Default: "${rootDir}/.jarhc"
        dataDir.set(file("${buildDir}/jarhc-data"))

    }

}

Most configuration properties are 1-to-1 equivalents of the command line options explained in the JarHC documentation.

Advanced examples

Add project artifact to classpath:

tasks {
    jarhcReport {
        dependsOn(jar)
        classpath.setFrom(
            jar.get().archiveFile,
            configurations.runtimeClasspath
        )
    }    
}

Add libraries to the "provided" classpath:

// create a custom configuration
val providedDependencies by configurations.creating

// add dependencies to the custom configuration
dependencies {
    providedDependencies("javax.servlet:javax.servlet-api:3.1.0")
}

// use the custom configuration in the task
tasks {
    jarhcReport {
        provided.setFrom(providedDependencies)
    }
}