Merge pull request #60 from anilkumarmyla/debug_logging

Add debug logging to demystify inner workings

Author: cb372

Diff for: README.md

@@ -115,6 +115,35 @@ unusedCompileDependenciesFilter -= moduleFilter("org.scalaz", "scalaz")
 Note: If you're filtering things out because you think the plugin is returning
 false-positive results, please open a GitHub issue.
 
+## Debugging
+
+You can pass `-debug` flag to sbt or set logLevel to debug to understand how the plugin computes compile depndencies
+
+```
+sbt:example> set logLevel := Level.Debug
+sbt:example> unusedCompileDependencies
+...
+[debug] Source to library relations:
+[debug]   sbt-explicit-dependencies/example/src/main/scala/foo/MyCaseClass.scala -> /Library/Caches/Coursier/v1/https/repo1.maven.org/maven2/org/typelevel/cats-effect_2.12/0.10.1/cats-effect_2.12-0.10.1.jar
+[debug]   sbt-explicit-dependencies/example/src/main/scala/foo/Example.scala -> /Library/Caches/Coursier/v1/https/repo1.maven.org/maven2/org/typelevel/cats-core_2.12/1.2.0/cats-core_2.12-1.2.0.jar
+...
+[debug] Library dependencies:
+[debug]   /Library/Caches/Coursier/v1/https/repo1.maven.org/maven2/org/typelevel/cats-effect_2.12/0.10.1/cats-effect_2.12-0.10.1.jar
+[debug]   /Library/Caches/Coursier/v1/https/repo1.maven.org/maven2/org/typelevel/cats-core_2.12/1.2.0/cats-core_2.12-1.2.0.jar
+...
+[debug] jarFile: cats-effect_2.12-0.10.1.jar -> "org.typelevel" %% "cats-effect" % "0.10.1"
+[debug] jarFile: cats-core_2.12-1.2.0.jar -> "org.typelevel" %% "cats-core" % "1.2.0"
+...
+[debug] Compile depends on:
+[debug]   "org.typelevel" %% "cats-effect" % "0.10.1"
+[debug]   "org.typelevel" %% "cats-core" % "1.2.0"
+...
+[debug] Declared dependencies:
+[debug]   "org.http4s" %% "http4s-blaze-server" % "0.18.16"
+[debug]   "org.http4s" %% "http4s-circe" % "0.18.16"
+...
+```
+
 ## Example project
 
 There is an example sbt project in the `example` folder so you can see the

Diff for: src/main/scala-sbt-0.13/explicitdeps/package.scala

@@ -6,8 +6,14 @@ package object explicitdeps {
 
   val defaultModuleFilter: ModuleFilter = sbt.DependencyFilter.moduleFilter()
 
-  def getAllLibraryDeps(analysis: Analysis): Set[java.io.File] =
-    analysis.relations.allBinaryDeps.toSet
+  def getAllLibraryDeps(analysis: Analysis, log: sbt.util.Logger): Set[java.io.File] = {
+    log.debug(
+      s"Source to library relations:\n${analysis.relations.binaryDep.all.map(r => s"  ${r._1} -> ${r._2}").mkString("\n")}"
+    )
+    val allLibraryDeps = analysis.relations.allBinaryDeps.toSet
+    log.debug(s"Library dependencies:\n${allLibraryDeps.mkString("  ", "\n  ", "")}")
+    allLibraryDeps
+  }
 
   implicit class NodeSeqOps(nodeSeq: scala.xml.NodeSeq) {
 

Diff for: src/main/scala-sbt-1.0/explicitdeps/package.scala

@@ -6,7 +6,13 @@ package object explicitdeps {
 
   val defaultModuleFilter: ModuleFilter = sbt.librarymanagement.DependencyFilter.moduleFilter()
 
-  def getAllLibraryDeps(analysis: Analysis): Set[java.io.File] =
-    analysis.relations.allLibraryDeps.toSet
+  def getAllLibraryDeps(analysis: Analysis, log: sbt.util.Logger): Set[java.io.File] = {
+    log.debug(
+      s"Source to library relations:\n${analysis.relations.libraryDep.all.map(r => s"  ${r._1} -> ${r._2}").mkString("\n")}"
+    )
+    val allLibraryDeps = analysis.relations.allLibraryDeps.toSet
+    log.debug(s"Library dependencies:\n${allLibraryDeps.mkString("  ", "\n  ", "")}")
+    allLibraryDeps
+  }
 
 }

Diff for: src/main/scala/explicitdeps/BoringStuff.scala

@@ -20,7 +20,9 @@ object BoringStuff {
     val dependencyFromIvyCache = findIvyFileInIvyCache(jarFile).flatMap(parseIvyFile(scalaBinaryVersion, log))
     val dependencyFromIvyLocal = findIvyFileInIvyLocal(jarFile).flatMap(parseIvyFile(scalaBinaryVersion, log))
 
-    dependencyFromPom.orElse(dependencyFromIvyCache).orElse(dependencyFromIvyLocal)
+    val dependencyOpt = dependencyFromPom.orElse(dependencyFromIvyCache).orElse(dependencyFromIvyLocal)
+    log.debug(s"jarFile: ${jarFile.getName} -> ${dependencyOpt.mkString}")
+    dependencyOpt
   }
 
   private def findPomFile(jarFile: File): Option[File] = {

Diff for: src/main/scala/explicitdeps/ExplicitDepsPlugin.scala

@@ -36,12 +36,12 @@ object ExplicitDepsPlugin extends AutoPlugin {
   )
 
   lazy val undeclaredCompileDependenciesTask = Def.task {
+    val log = streams.value.log
     val projectName = name.value
-    val allLibraryDeps = getAllLibraryDeps(compile.in(Compile).value.asInstanceOf[Analysis])
+    val allLibraryDeps = getAllLibraryDeps(compile.in(Compile).value.asInstanceOf[Analysis], log)
     val libraryDeps = libraryDependencies.value
     val scalaBinaryVer = scalaBinaryVersion.value
     val filter = undeclaredCompileDependenciesFilter.value
-    val log = streams.value.log
 
     Logic.getUndeclaredCompileDependencies(
       projectName,
@@ -60,12 +60,12 @@ object ExplicitDepsPlugin extends AutoPlugin {
   }
 
   lazy val unusedCompileDependenciesTask = Def.task {
+    val log = streams.value.log
     val projectName = name.value
-    val allLibraryDeps = getAllLibraryDeps(compile.in(Compile).value.asInstanceOf[Analysis])
+    val allLibraryDeps = getAllLibraryDeps(compile.in(Compile).value.asInstanceOf[Analysis], log)
     val libraryDeps = libraryDependencies.value
     val scalaBinaryVer = scalaBinaryVersion.value
     val filter = unusedCompileDependenciesFilter.value
-    val log = streams.value.log
 
     Logic.getUnusedCompileDependencies(
       projectName,

Diff for: src/main/scala/explicitdeps/Logic.scala

@@ -70,7 +70,7 @@ object Logic {
 
     val compileDependencies = compileDependencyJarFiles
       .flatMap(BoringStuff.jarFileToDependency(scalaBinaryVersion, log))
-    log.debug(s"Compile depends on:\n${compileDependencies.mkString("\n")}")
+    log.debug(s"Compile depends on:\n${compileDependencies.mkString("  ", "\n  ", "")}")
 
     compileDependencies
   }
@@ -82,7 +82,7 @@ object Logic {
 
     val declaredCompileDependencies = compileConfigLibraryDependencies
       .map(moduleId => Dependency(moduleId.organization, moduleId.name, moduleId.revision, moduleId.crossVersion.isInstanceOf[Binary]))
-    log.debug(s"Declared dependencies:\n${declaredCompileDependencies.mkString("\n")}")
+    log.debug(s"Declared dependencies:\n${declaredCompileDependencies.mkString("  ", "\n  ", "")}")
 
     declaredCompileDependencies.toSet
   }