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,7 +16,8 @@
 
 package net.virtualvoid.sbt.graph
 
-import java.nio.file.{ Files, Path, Paths }
+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 }
@@ -48,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
@@ -83,13 +84,15 @@ object DependencyGraphSettings {
       filterRulesParser.parsed: _*
     ),
     dependencyTree := {
+      val tree = asciiTree.evaluated
       dependencyTreeOutputPathParser.parsed match {
         case Some(path) ⇒
-          val os = Files.newOutputStream(path)
-          os.write(asciiTree.evaluated.getBytes)
+          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(asciiTree.evaluated)
+          streams.value.log.info(tree)
       }
 
     },
@@ -196,23 +199,19 @@ object DependencyGraphSettings {
   val dependencyTreeOutputPathParser: State ⇒ Parser[Option[Path]] = { (state: State) ⇒
     (
       Space ~
-        (token("--out") | token("-o")) ~>
-        StringBasic
+      (token("--out") | token("-o")) ~ Space ~>
+      StringBasic
     )
-    .map(Paths.get(_))
-    .?
-  }
-
-  val filterRulesParser_ = {
-    (Space ~> token(StringBasic, "filter")).*.map {
-      _.map(FilterRule(_))
-    }
+      .map(Paths.get(_))
+      .?
   }
 
   val filterRulesParser: Def.Initialize[State ⇒ Parser[Seq[FilterRule]]] =
     resolvedScoped { ctx ⇒
       (state: State) ⇒
-      filterRulesParser_
+        (Space ~> token(StringBasic, "filter")).*.map {
+          _.map(FilterRule(_))
+        }
     }
 
   val artifactIdParser: Def.Initialize[State ⇒ Parser[ModuleId]] =

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"))