Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 1.61 KB

README.md

File metadata and controls

54 lines (40 loc) · 1.61 KB

gradle-eval-plugin

A tiny plugin for Gradle projects debugging via command line

Build Status

Usage

This plugin allows inspecting a Gradle build directly from the command line, without editing the build scripts when that is not really necessary. For example:

./gradlew eval --command='sourceSets.each { println it.name }'
> Task :eval
main
test
SourceSet container

The plugin can be applied normally to a single project as follows:

plugins {
    id 'com.github.h0tk3y.gradle.eval' version '0.0.4'
}

However, it may be more practical to apply it with a system-wide Gradle init script to get these tasks in every project you build:

initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2/" }
    }
    dependencies {
        classpath 'com.github.h0tk3y.gradle.eval:gradle-eval:0.0.4'
    }
}

allprojects {
    apply plugin: com.github.h0tk3y.gradle.eval.GradleEvalPlugin
}

Tasks: eval and projectRepl

The plugin adds two tasks:

  • eval for running a single command with no state saved

    • the command is passed via the command line option --command='...'
  • projectRepl for running a REPL in the context of the project

    • Note: Gradle's rich console features disrupt the jline functionality. It is recommended to run projectRepl with the --console=plain --quiet command line flags to minimize harm from the rich console.