add file-output option to dependencyTree

Author: ryan-williams

README.md

@@ -77,6 +77,21 @@ dependencyTree foo bar -baz  // include only deps that contain "foo" or "bar" an
 
 In all cases, the full paths to dependencies that match the query are displayed (which can mean that dependencies are displayed even though they would have been excluded in their own right, because they form part of a chain to a dependency that was not excluded). 
 
+#### Writing output to file
+
+`dependencyTree` can have its output written to a file:
+
+```
+$ sbt
+> dependencyTree -o foo
+```
+
+or, directly from the shell:
+
+```bash
+sbt 'dependency-tree -o foo'
+```
+
 ## Configuration settings
 
  * `filterScalaLibrary`: Defines if the scala library should be excluded from the output of the dependency-* functions.

src/main/scala/net/virtualvoid/sbt/graph/DependencyGraphSettings.scala

@@ -16,6 +16,9 @@
 
 package net.virtualvoid.sbt.graph
 
+import java.nio.file.Files.newOutputStream
+import java.nio.file.{ Path, Paths }
+
 import net.virtualvoid.sbt.graph.GraphTransformations.reverseGraphStartingAt
 import net.virtualvoid.sbt.graph.backend.{ IvyReport, SbtUpdateReport }
 import net.virtualvoid.sbt.graph.model.{ FilterRule, ModuleGraph, ModuleId }
@@ -46,7 +49,7 @@ object DependencyGraphSettings {
     Seq(Compile, Test, IntegrationTest, Runtime, Provided, Optional).flatMap(ivyReportForConfig)
 
   def ivyReportForConfig(config: Configuration) = inConfig(config)(Seq(
-    ivyReport := { Def.task { ivyReportFunction.value.apply(config.toString) } dependsOn (ignoreMissingUpdate) }.value,
+    ivyReport := { Def.task { ivyReportFunction.value.apply(config.toString) } dependsOn ignoreMissingUpdate }.value,
     crossProjectId := sbt.CrossVersion(scalaVersion.value, scalaBinaryVersion.value)(projectID.value),
     moduleGraphSbt :=
       ignoreMissingUpdate
@@ -80,7 +83,19 @@ object DependencyGraphSettings {
       moduleGraph.value,
       filterRulesParser.parsed: _*
     ),
-    dependencyTree := streams.value.log.info(asciiTree.evaluated),
+    dependencyTree := {
+      val tree = asciiTree.evaluated
+      dependencyTreeOutputPathParser.parsed match {
+        case Some(path) ⇒
+          streams.value.log.info(s"Writing dependency-tree to path: $path")
+          val os = newOutputStream(path)
+          os.write(tree.getBytes)
+          os.close()
+        case _ ⇒
+          streams.value.log.info(tree)
+      }
+
+    },
     dependencyGraphMLFile := { target.value / "dependencies-%s.graphml".format(config.toString) },
     dependencyGraphML := dependencyGraphMLTask.value,
     dependencyDotFile := { target.value / "dependencies-%s.dot".format(config.toString) },
@@ -174,16 +189,26 @@ object DependencyGraphSettings {
       }.mkString("\n\n")
     streams.log.info(output)
   }
-  val shouldForceParser: State ⇒ Parser[Boolean] = { (state: State) ⇒
-    import sbt.complete.DefaultParsers._
 
+  import sbt.complete.DefaultParsers._
+
+  val shouldForceParser: State ⇒ Parser[Boolean] = { (state: State) ⇒
     (Space ~> token("--force")).?.map(_.isDefined)
   }
 
+  val dependencyTreeOutputPathParser: State ⇒ Parser[Option[Path]] = { (state: State) ⇒
+    (
+      Space ~
+      (token("--out") | token("-o")) ~ Space ~>
+      StringBasic
+    )
+      .map(Paths.get(_))
+      .?
+  }
+
   val filterRulesParser: Def.Initialize[State ⇒ Parser[Seq[FilterRule]]] =
     resolvedScoped { ctx ⇒
       (state: State) ⇒
-        import sbt.complete.DefaultParsers._
         (Space ~> token(StringBasic, "filter")).*.map {
           _.map(FilterRule(_))
         }
@@ -194,7 +219,6 @@ object DependencyGraphSettings {
       (state: State) ⇒
         val graph = loadFromContext(moduleGraphStore, ctx, state) getOrElse ModuleGraph(Nil, Nil)
 
-        import sbt.complete.DefaultParsers._
         graph
           .nodes
           .map(_.id)

src/sbt-test/sbt-dependency-graph/dependencyTreeFile/build.sbt

@@ -0,0 +1,30 @@
+import java.nio.file.{ Files, Paths }
+
+import scala.io.Source
+
+scalaVersion := "2.9.1"
+
+resolvers += "typesafe maven" at "https://repo.typesafe.com/typesafe/maven-releases/"
+
+libraryDependencies ++= Seq(
+  "com.codahale" % "jerkson_2.9.1" % "0.5.0"
+)
+
+InputKey[Unit]("check") := {
+  val is = Files.newInputStream(Paths.get("foo"))
+  val tree = Source.fromInputStream(is).mkString
+  is.close()
+
+  require(
+    tree ==
+    """default:dependencytreefile_2.9.1:0.1-SNAPSHOT [S]
+      |  +-com.codahale:jerkson_2.9.1:0.5.0 [S]
+      |    +-org.codehaus.jackson:jackson-core-asl:1.9.11
+      |    +-org.codehaus.jackson:jackson-mapper-asl:1.9.11
+      |      +-org.codehaus.jackson:jackson-core-asl:1.9.11
+      |      """
+      .stripMargin,
+    s"Tree didn't match expected:\n$tree"
+  )
+  ()
+}

src/sbt-test/sbt-dependency-graph/dependencyTreeFile/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("org.hammerlab" % "sbt-dependency-graph" % sys.props("project.version"))

src/sbt-test/sbt-dependency-graph/dependencyTreeFile/test

@@ -0,0 +1,2 @@
+> dependencyTree -o foo
+> check

src/sbt-test/sbt-dependency-graph/plugins.sbt

@@ -1 +1 @@
-addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % sys.props("project.version"))
+addSbtPlugin("org.hammerlab" % "sbt-dependency-graph" % sys.props("project.version"))