sbt-dependency-graph 技术文档

本文档将详细介绍如何安装、使用以及操作 sbt-dependency-graph 项目。以下内容将涵盖安装指南、使用说明以及项目 API 使用文档。

1. 安装指南

sbt-dependency-graph 是一个用于可视化项目依赖关系的工具。为了全局安装此插件，您需要在对应的 sbt 配置文件中添加依赖项。

• 对于 sbt 1.4 及以上版本，使用以下命令：

  addDependencyTreePlugin
  

• 对于 sbt 1.3 以下版本，使用以下命令：

  addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.10.0-RC1")
  

若您只想将插件添加到单个项目中，请将上述命令放入项目目录下的 project/plugins.sbt 文件中。

该插件支持 sbt 版本 >= 0.13.10 和 sbt 1.0.x。若需支持更早版本的 sbt，请查看 0.8.2 版本的兼容性说明。

2. 项目的使用说明

sbt-dependency-graph 提供了多种任务以帮助您查看和管理项目的依赖关系：

• dependencyTree: 显示项目依赖关系的 ASCII 树形结构。
• dependencyBrowseGraph: 在浏览器中打开一个窗口，以可视化依赖关系图（使用 graphlib-dot + dagre-d3）。
• dependencyBrowseTree: 在浏览器中打开一个窗口，以可视化依赖关系树（使用 jstree）。
• dependencyList: 在 sbt 控制台上显示所有传递依赖的列表（按组织机构和名称排序）。
• whatDependsOn <organization> <module> <revision>?: 查找依赖于指定构件的项目。显示选定模块的反向依赖树。<revision> 参数是可选的。
• dependencyLicenseInfo: 显示按声明的许可证分组的依赖项。
• dependencyStats: 显示每个模块的行，包括（传递）jar 大小和依赖项数量。
• dependencyGraphMl: 生成 .graphml 文件，包含项目的依赖关系，保存在 target/dependencies-<config>.graphml。
• dependencyDot: 生成 .dot 文件，包含项目的依赖关系，保存在 target/dependencies-<config>.dot。
• dependencyGraph: 在 sbt 控制台上显示项目依赖关系的 ASCII 图（仅支持 sbt 0.13）。
• ivyReport: 使用 ivy 为您的项目生成解析报告。

以下任务还支持 toFile 子任务，以便将内容保存到文件：

• dependencyTree
• dependencyList
• dependencyStats
• dependencyLicenseInfo

toFile 子任务的语法如下：

<config>:<task>::toFile <filename> [-f|--force]

使用 -f 参数强制覆盖现有文件。

例如，test:dependencyStats::toFile target/depstats.txt 将把 dependencyStats 的输出写入 test 配置的文件 target/depstats.txt，但不会覆盖现有文件。

所有任务都可以设置配置范围，以获取特定配置的报告。例如，test:dependencyGraph 会打印 test 配置的依赖关系。如果不指定任何配置，默认使用 compile。

请注意，如果您想从 sbt shell 外部运行带有参数的任务，请确保将整个任务调用放入引号中，例如 sbt "whatDependsOn <org> <module> <version>"。

3. 项目 API 使用文档

以下是一些可以在 build.sbt 中设置的配置选项：

• filterScalaLibrary: 定义是否从 dependency-* 函数的输出中排除 Scala 库。如果为 true，则在工件名称后附加 [S]。如果希望输出中包含 Scala 库依赖项，请将其设置为 false（默认：true）。
• dependencyGraphMLFile: 允许配置 dependency-graph-ml 的输出路径。
• dependencyDotFile: 允许配置 dependency-dot 的输出路径。
• dependencyDotHeader: 允许自定义 dot 文件的头部（例如设置节点形状）。
• dependencyDotNodeLabel: 定义节点标签的格式（默认设置为 [organisation]<BR/><B>[name]</B><BR/>[version]）。

例如，在 build.sbt 中可以像这样更改配置设置：

filterScalaLibrary := false // 在输出中包含 Scala 库

dependencyDotFile := file("dependencies.dot") // 将 dot 文件渲染到 `./dependencies.dot`

4. 项目安装方式

请按照上述“安装指南”部分中的步骤进行安装。

以上就是 sbt-dependency-graph 的技术文档，希望对您有所帮助。