luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6693 from kijuky/apply-asciigraphwidth-to-dependencytree 

Enable the asciiGraphWidth setting to the dependencyTree tasks. #5962
This commit is contained in:
eugene yokota 2021-10-22 00:11:31 -04:00 committed by GitHub
parent 9e71209cdd 890ecdc556
commit bc95ab25a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 82 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
main/src/main/scala/sbt/internal/SettingGraph.scala
View File

@ -12,7 +12,6 @@ import sbt.util.Show
import java.io.File
import Def.{ ScopedKey, compiled, flattenLocals }
import sbt.internal.util.Terminal
import Predef.{ any2stringadd => _, _ }
import sbt.io.IO
@ -123,10 +122,4 @@ object Graph {
toAsciiLines(top, 0, Set.empty).mkString("\n")
}
def defaultColumnSize: Int = {
val termWidth = Terminal.console.getWidth
if (termWidth > 20) termWidth - 8
else 80 // ignore termWidth
}
}

4
main/src/main/scala/sbt/internal/graph/rendering/AsciiTree.scala
View File

@ -13,7 +13,7 @@ package rendering
import sbt.internal.util.Terminal.red
object AsciiTree {
def asciiTree(graph: ModuleGraph): String = {
def asciiTree(graph: ModuleGraph, graphWidth: Int): String = {
val deps = graph.dependencyMap
// there should only be one root node (the project itself)
@ -25,7 +25,7 @@ object AsciiTree {
root,
node => deps.getOrElse(node.id, Seq.empty[Module]),
displayModule,
Graph.defaultColumnSize
graphWidth
)
}
.mkString("\n")

19
main/src/main/scala/sbt/plugins/DependencyTreeSettings.scala
View File

@ -80,7 +80,13 @@ object DependencyTreeSettings {
else GraphTransformations.ignoreScalaLibrary(sv, g)
},
dependencyTreeModuleGraphStore := (dependencyTreeModuleGraph0 storeAs dependencyTreeModuleGraphStore triggeredBy dependencyTreeModuleGraph0).value,
) ++ renderingTaskSettings(dependencyTree, rendering.AsciiTree.asciiTree _)
) ++ {
renderingTaskSettings(dependencyTree) :+ {
dependencyTree / asString := {
rendering.AsciiTree.asciiTree(dependencyTreeModuleGraph0.value, asciiGraphWidth.value)
}
}
}
/**
* This is the maximum strength settings for DependencyTreePlugin.
@ -130,11 +136,12 @@ object DependencyTreeSettings {
case None =>
graph.nodes.filter(m => m.id.organization == org && m.id.name == name).map(_.id)
}
val graphWidth = asciiGraphWidth.value
val output =
modules
.map { module =>
rendering.AsciiTree
.asciiTree(GraphTransformations.reverseGraphStartingAt(graph, module))
.asciiTree(GraphTransformations.reverseGraphStartingAt(graph, module), graphWidth)
}
.mkString("\n")
@ -142,7 +149,7 @@ object DependencyTreeSettings {
output
},
) ++
renderingAlternatives.flatMap((renderingTaskSettings _).tupled)
renderingAlternatives.flatMap { case (key, renderer) => renderingTaskSettings(key, renderer) }
def renderingAlternatives: Seq[(TaskKey[Unit], ModuleGraph => String)] =
Seq(
@ -152,13 +159,17 @@ object DependencyTreeSettings {
)
def renderingTaskSettings(key: TaskKey[Unit], renderer: ModuleGraph => String): Seq[Setting[_]] =
renderingTaskSettings(key) :+ {
key / asString := renderer(dependencyTreeModuleGraph0.value)
}
def renderingTaskSettings(key: TaskKey[Unit]): Seq[Setting[_]] =
Seq(
key := {
val s = streams.value
val str = (key / asString).value
s.log.info(str)
},
key / asString := renderer(dependencyTreeModuleGraph0.value),
key / toFile := {
val (targetFile, force) = targetFileAndForceParser.parsed
writeToFile(key.key.label, (key / asString).value, targetFile, force, streams.value)

13
notes/1.6.0/enable-asciiGraphWidth-in-dependencyTree.md Normal file
View File

@ -0,0 +1,13 @@
[@kijuky]: https://github.com/kijuky
[5962]: https://github.com/sbt/sbt/issues/5962
### Fixes with compatibility implications
- The output of the dependencyTree will not be truncated at the console width.
### Improvements
- Enable the asciiGraphWidth setting in the dependencyTree tasks.
### Bug fixes

24
sbt-app/src/sbt-test/dependency-graph/asciiGraphWidth/build.sbt Normal file
View File

@ -0,0 +1,24 @@
ThisBuild / version := "0.1.0-SNAPSHOT"
ThisBuild / scalaVersion := "2.13.5"
name := "asciiGraphWidthSpecs"
lazy val whenIsDefault = (project in file("when-is-default"))
.settings(
libraryDependencies += "org.typelevel" %% "cats-effect" % "3.1.0",
check := checkTask.value
)
lazy val whenIs20 = (project in file("when-is-20"))
.settings(
asciiGraphWidth := 20,
libraryDependencies += "org.typelevel" %% "cats-effect" % "3.1.0",
check := checkTask.value
)
lazy val check = taskKey[Unit]("check")
lazy val checkTask = Def.task {
val context = thisProject.value
val expected = IO.read(file(s"${context.base}/expected.txt"))
val actual = (Compile / dependencyTree / asString).value
require(actual == expected, s"${context.id} is failed.")
}

1
sbt-app/src/sbt-test/dependency-graph/asciiGraphWidth/project/plugins.sbt Normal file
View File

@ -0,0 +1 @@
addDependencyTreePlugin

1
sbt-app/src/sbt-test/dependency-graph/asciiGraphWidth/test Normal file
View File

@ -0,0 +1 @@
> check

13
sbt-app/src/sbt-test/dependency-graph/asciiGraphWidth/when-is-20/expected.txt Normal file
View File

@ -0,0 +1,13 @@
whenis20:whenis20_..
+-org.typelevel:..
+-org.typeleve..
| +-org.typele..
| +-org.type..
| +-org.type..
|
+-org.typeleve..
+-org.typele..
+-org.type..
+-org.ty..
+-org.ty..

13
sbt-app/src/sbt-test/dependency-graph/asciiGraphWidth/when-is-default/expected.txt Normal file
View File

@ -0,0 +1,13 @@
whenisdefault:whenisdefault_2.13:0.1.0-SNAPSHOT [S]
+-org.typelevel:cats-effect_2.13:3.1.0 [S]
+-org.typelevel:cats-effect-kernel_2.13:3.1.0 [S]
| +-org.typelevel:cats-core_2.13:2.6.0 [S]
| +-org.typelevel:cats-kernel_2.13:2.6.0 [S]
| +-org.typelevel:simulacrum-scalafix-annotations_2.13:0.5.4 [S]
|
+-org.typelevel:cats-effect-std_2.13:3.1.0 [S]
+-org.typelevel:cats-effect-kernel_2.13:3.1.0 [S]
+-org.typelevel:cats-core_2.13:2.6.0 [S]
+-org.typelevel:cats-kernel_2.13:2.6.0 [S]
+-org.typelevel:simulacrum-scalafix-annotations_2.13:0.5.4 [S]