Version 2.0

- support gradle 6.8 and drop support for earlier versions - Change default beheavior to *not* repeat the same sub-tree more than once. Replace option --no-repeat with --repeat. - change --task-depth to --depth
dorongold · Jun 30, 2021 · fb19b84 · fb19b84
1 parent 874e0a5
commit fb19b84
Show file tree

Hide file tree

Showing 15 changed files with 373 additions and 399 deletions.
diff --git a/.travis.yml b/.travis.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,13 @@ Changelog
 This changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+Version 2.0 (2021-07-01)
+----------------------------
+* Support Gradle 6.8 and make it the minimum supported Gradle version
+* Add options `--with-inputs` and `--with-outputs` to print task inputs and outputs
+* Change option `--task-depth` to `--depth`
+* Change default behavior to _not_ repeat an already printed sub-tree. Option `--no-repeat` replaced with `--repeat`.
+
 Version 1.5 (2020-01-01)
 ----------------------------
 * Compatibility with gradle 6

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Gradle Task Tree
 
-[![version](https://img.shields.io/badge/version-1.5-orange.svg)](./CHANGELOG.md)
+[![version](https://img.shields.io/badge/version-2.0-orange.svg)](./CHANGELOG.md)
 
 Gradle plugin that adds a `taskTree` task that prints task dependency tree report to the console.
 
@@ -58,7 +58,7 @@ rootProject {
 
 `gradle <task 1>...<task N> taskTree`
 
-When one of the tasks given to the gradle command is `taskTree`, execution of all the other tasks on that line is skipped. Instead, their task dependency tree is printed.
+When one of the tasks given to the gradle command is `taskTree`, executions of all the other tasks given on that command are skipped. Instead, their task dependency tree is printed.
 
 ### Examples
 
@@ -123,33 +123,30 @@ No task dependencies
 ```
 
 ### Configuration
-When running the `taskTree` task from command-line, you can add the flag: `--no-repeat`. 
-This prevents sections of the tree from being printed more than once. 
-For a large task-tree it has the effect of reducing the size of output without loosing information. 
-To limit the depth of the printed tree add the command-line option: `--task-depth <number>`.
-
-You may add a configuration block for `taskTree` in your `build.gradle` (or, in case you take the [Init Script approach](#init-script-snippet), your `init.gradle`).
-In the configuration block you can set:
-- `noRepeat = true` has the same effect as passing `--no-repeat` to `taskTree` at command-line.
-- `impliesSubProjects = true` in a multi-project, `taskTree` will print the task-tree of the current project only (the default is to print the task-tree of current *and* child projects). This can reduce the size of output.
-- `taskDepth = <number>` e.g: `taskDepth = 3` limits the depth of the printed tree.
+To limit the depth of the printed tree, add the command-line option: `--depth <number>` 
+To print task inputs for each task in the tree, add the command-line option: `--with-inputs` 
+To print task outputs for each task in the tree, add the command-line option: `--with-outputs` 
+To allow a sub-tree of the same task to be repeated more than once, add the command-line option: `--repeat`
 
+For a more static custom configuration, you can put the following in `build.gradle` (or, in case you take the [init script approach](#init-script-snippet), in `init.gradle`).
 ```groovy
-//optional configuration
-taskTree{
- noRepeat = true //do not print a sub-tree in the task-tree more than once
- impliesSubProjects = true //do not print task-tree for child projects in a multi-project
- taskDepth = 3 // limit tree depth to 3. Equivalent to running with the --task-depth option.
+//optional configuration (per project)
+taskTree {
+ depth = 3 // limit tree depth to 3. Equivalent to the --depth CLI task option.
+ withInputs = true // prints task inputs in red just below the task in the tree. Equivalent to the --with-inputs CLI task option.
+ withOutputs = true // prints task inputs in red just below the task in the tree. Equivalent to the --with-outputs CLI task option.
+ repeat = true // allows printing a sub-tree in the task-tree more than once. Equivalent to the --repeat CLI task option
+ impliesSubProjects = true // disables printing task-tree for child projects in a multi-project
 }
 ```
 #### Note:
 In a multi-project, it is recommended to apply the plugin on the root project only. The `taskTree` task will automatically be added to child projects. 
 I.e. it is unnecessary to apply this plugin under `allprojects` or `subprojects`.
 
 ## Version Compatibility
-Gradle 2.3+ 
-Java 1.7+
+Gradle 6.8+ 
+Java 1.8+
 
-## Acknowledgements
+## Older Version Compatibility
+Version 1.5 of this plugin is compatible with Gradle 2.3+
 
-Some functionality is based on [gradle-visteg plugin](https://github.com/mmalohlava/gradle-visteg) - a plugin that creates an image with a DAG representation of the task tree.
diff --git a/build.gradle b/build.gradle
@@ -1,26 +1,33 @@
 apply plugin: 'groovy'
-apply plugin: 'maven'
-apply plugin: "com.gradle.plugin-publish"
-
-sourceCompatibility = 1.7
+apply plugin: 'java-gradle-plugin'
+apply plugin: 'maven-publish'
+apply plugin: 'com.gradle.plugin-publish'
 
 buildscript {
  repositories {
  maven {
- url "https://plugins.gradle.org/m2/"
+ url 'https://plugins.gradle.org/m2/'
  }
  }
  dependencies {
- classpath "com.gradle.publish:plugin-publish-plugin:0.10.0"
+ classpath 'com.gradle.publish:plugin-publish-plugin:0.15.0'
  }
 }
 
 repositories {
- jcenter()
+ mavenCentral()
+}
+
+java {
+ toolchain {
+ languageVersion = JavaLanguageVersion.of(8)
+ }
 }
 
+
+
 group = 'com.dorongold.plugins'
-version = '1.5'
+version = '2.0'
 description = "Gradle plugin that adds a 'taskTree' task that prints task dependency tree"
 
 //Building a text file that contains the classpath of the plugin code. needed for testing on gradle versions prior to 2.5
@@ -41,17 +48,18 @@ dependencies {
  compile gradleApi()
  compile 'org.apache.commons:commons-lang3:3.4'
 
- testCompile gradleTestKit()
  testCompile('org.spockframework:spock-core:1.0-groovy-2.4') {
  exclude module: 'groovy-all'
  }
  testCompile 'com.netflix.nebula:nebula-test:5.0.1'
+ testCompile 'commons-io:commons-io:2.5'
  testRuntime files(createClasspathManifest)
 }
 
 pluginBundle {
  website = 'https://github.com/dorongold/gradle-task-tree'
  vcsUrl = 'https://github.com/dorongold/gradle-task-tree.git'
+ vcsUrl = 'https://github.com/dorongold/gradle-task-tree.git'
  description = "Gradle plugin that adds a 'taskTree' task that prints task dependency tree"
  tags = ['task', 'tree', 'dependencies', 'dependency']
 

diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\:https://services.gradle.org/distributions/gradle-4.10.2-bin.zip
+distributionUrl=https\:https://services.gradle.org/distributions/gradle-6.8-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/gradlew b/gradlew
@@ -1,5 +1,21 @@
 #!/usr/bin/env sh
 
+#
+# Copyright 2015 the original author or authors.
+#
+# 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.
+#
+
 ##############################################################################
 ##
 ## Gradle start up script for UN*X
@@ -28,7 +44,7 @@ APP_NAME="Gradle"
 APP_BASE_NAME=`basename "$0"`
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD="maximum"
@@ -66,6 +82,7 @@ esac
 
 CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
 
+
 # Determine the Java command to use to start the JVM.
 if [ -n "$JAVA_HOME" ] ; then
  if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
@@ -109,10 +126,11 @@ if $darwin; then
  GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
 fi
 
-# For Cygwin, switch paths to Windows format before running java
-if $cygwin ; then
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
  APP_HOME=`cygpath --path --mixed "$APP_HOME"`
  CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+
  JAVACMD=`cygpath --unix "$JAVACMD"`
 
  # We build the pattern for arguments to be converted via cygpath
@@ -138,19 +156,19 @@ if $cygwin ; then
  else
  eval `echo args$i`="\"$arg\""
  fi
- i=$((i+1))
+ i=`expr $i + 1`
  done
  case $i in
- (0) set -- ;;
- (1) set -- "$args0" ;;
- (2) set -- "$args0" "$args1" ;;
- (3) set -- "$args0" "$args1" "$args2" ;;
- (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
- (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
- (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
- (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
- (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
- (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+ 0) set -- ;;
+ 1) set -- "$args0" ;;
+ 2) set -- "$args0" "$args1" ;;
+ 3) set -- "$args0" "$args1" "$args2" ;;
+ 4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+ 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+ 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+ 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+ 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+ 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
  esac
 fi
 
@@ -159,14 +177,9 @@ save () {
  for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
  echo " "
 }
-APP_ARGS=$(save "$@")
+APP_ARGS=`save "$@"`
 
 # Collect all arguments for the java command, following the shell quoting and substitution rules
 eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
 
-# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
-if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
- cd "$(dirname "$0")"
-fi
-
 exec "$JAVACMD" "$@"
diff --git a/gradlew.bat b/gradlew.bat
@@ -1,3 +1,19 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
 @if "%DEBUG%" == "" @echo off
 @rem ##########################################################################
 @rem
@@ -13,15 +29,18 @@ if "%DIRNAME%" == "" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
 
 @rem Find java.exe
 if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto init
+if "%ERRORLEVEL%" == "0" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -35,7 +54,7 @@ goto fail
 set JAVA_HOME=%JAVA_HOME:"=%
 set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
-if exist "%JAVA_EXE%" goto init
+if exist "%JAVA_EXE%" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
@@ -45,28 +64,14 @@ echo location of your Java installation.
 
 goto fail
 
-:init
-@rem Get command-line arguments, handling Windows variants
-
-if not "%OS%" == "Windows_NT" goto win9xME_args
-
-:win9xME_args
-@rem Slurp the command line arguments.
-set CMD_LINE_ARGS=
-set _SKIP=2
-
-:win9xME_args_slurp
-if "x%~1" == "x" goto execute
-
-set CMD_LINE_ARGS=%*
-
 :execute
 @rem Setup the command line
 
 set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
+
 @rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
 
 :end
 @rem End local scope for the variables with windows NT shell