diff --git a/README.md b/README.md index 696339a..714764b 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ buildscript { maven { url "https://plugins.gradle.org/m2/" } } dependencies { - classpath 'gradle.plugin.modules-graph-assert:plugin:0.1.1' + classpath 'gradle.plugin.modules-graph-assert:plugin:0.2.0' } } @@ -28,3 +28,13 @@ moduleGraphAssert { restrictInLayerDependencies = [":feature", ":lib"] } ``` + +### Helper Graphviz Graph Export +- Visualising graph could be useful to see the dependency problem, therefore helper `generateModulesGrapvizText` is included. +- By default it generates graph of all modules in a project. +- Longest path of the project is in red. +- Adding parameter `modules.graph.print.statistics` prints also information about the graph. +- You can set `modules.graph.of.module` parameter if you want only subgraph of total graph. +``` +./gradlew generateModulesGrapvizText -Pmodules.graph.print.statistics=true -Pmodules.graph.of.module=:feature-one +``` diff --git a/example/app/build.gradle b/example/app/build.gradle index 3ed54d1..f66f370 100644 --- a/example/app/build.gradle +++ b/example/app/build.gradle @@ -1,5 +1,5 @@ plugins { - id('com.jraska.module.graph.assertion') version "0.1.1" + id('com.jraska.module.graph.assertion') version "0.2.0" } apply plugin: 'java-library' diff --git a/plugin/build.gradle b/plugin/build.gradle index 017caea..9214374 100644 --- a/plugin/build.gradle +++ b/plugin/build.gradle @@ -34,7 +34,7 @@ gradlePlugin { plugins { modulesGraphAssert { id = 'com.jraska.module.graph.assertion' - version = '0.1.1' + version = '0.2.0' displayName = 'Modules Graph Assert' description = 'Gradle plugin to keep your modules graph healthy and lean.' implementationClass = 'com.jraska.module.graph.assertion.ModuleGraphAssertionsPlugin'