mod 命令提供了一系列工具，可帮助用户了解其外部依赖关系图。借助该工具，您可以直观呈现依赖关系图，了解某个模块或某个模块版本为何出现在图中，查看支持模块的 repo 定义，检查模块扩展和它们生成的 repo 的使用情况，以及执行其他功能。
语法
bazel mod <subcommand> [<options>] [<arg> [<arg>...]]
可用的子命令及其各自的必需实参如下：
graph：显示项目的完整依赖关系图，从根模块开始。如果在--from中指定了一个或多个模块，这些模块将直接显示在根目录下，并且仅从这些模块开始展开图（请参阅示例）。deps <arg>...：显示每个指定模块的已解析直接依赖项，与graph类似。all_paths <arg>...：显示从 --from 模块到目标模块的所有依赖项路径。为简化输出，当多个路径共享同一后缀时，系统仅显示第一个最短路径。例如，系统会显示 A -> B -> X，但会省略较长的 A -> C -> B -> X。换句话说，对于直接依赖于目标模块 X 的每个模块 Y，输出仅包含通过 Y 到达 X 的最短路径。path <arg>...：与all_paths具有相同的语义，但仅显示从一个--from模块到某个实参模块的单个路径。explain <arg>...：显示指定模块在依赖关系图中的所有位置，以及直接依赖于这些模块的模块。explain命令的输出基本上是all_paths命令的精简版本，包含 1) 根模块；2) 指向实参模块的根模块的直接依赖项；3) 实参模块的直接被依赖项；以及 4) 实参模块本身（请参阅示例）。show_repo <arg>...：显示指定代码库的定义（请参阅示例）。show_extension <extension>...：显示有关每个指定扩展程序的信息：生成的代码库的列表以及使用use_repo导入这些代码库的模块；以及每个使用该扩展程序的模块中该扩展程序的用法列表，其中包含指定的标记和use_repo调用（请参阅示例）。
<arg> 指的是一个或多个模块或代码库。可以是以下值之一：
字面值字符串
<root>：表示当前项目的根模块。<name>@<version>：版本为<version>的模块<name>。对于具有非注册表替换项的模块，请使用下划线 (_) 作为<version>。<name>：模块<name>的所有当前版本。@<repo_name>：在--base_module的上下文中具有指定 apparentName 的代码库。@@<repo_name>：具有指定规范名称的代码库。
在需要指定模块的上下文中，也可以使用引用与模块对应的代码库（而非扩展程序生成的代码库）的 <arg>。反之，在需要指定代码库的上下文中，引用模块的 <arg> 可以代替相应的代码库。
<extension> 必须采用 <arg><label_to_bzl_file>%<extension_name> 形式。<label_to_bzl_file> 部分必须是相对于代码库的标签（例如 //pkg/path:file.bzl）。
以下选项仅影响用于打印图表的子命令（graph、deps、all_paths、path 和 explain）：
--from <arg>[,<arg>[,...]]默认值：<root>：在graph、all_paths、path和explain中扩展图的模块。如需了解详情，请查看子命令的说明。--verbose默认值：“false”：在输出图表中包含有关每个模块的版本解析的额外信息。如果模块版本在解析期间发生变化，则显示替换它的版本或原始版本、替换原因，以及如果原因是 Minimal Version Selection，则显示请求新版本的模块。--include_unuseddefault: "false"：在输出图表中包含最初存在于依赖关系图表中，但在模块解析后变为未使用的模块。--extension_info <mode>：在输出图表中包含有关模块扩展程序使用情况的信息（请参阅示例）。<mode>可以是以下值之一：hidden（默认）：不显示有关扩展程序的任何内容。usages：在每个使用扩展程序的模块下显示扩展程序。它们以$<extension>的形式打印。repos：除了usages之外，还会在每项扩展程序使用情况下显示使用use_repo导入的代码库。all：除了usages和repos之外，还显示未被任何模块导入的扩展程序生成的代码库。这些额外的代码库会显示在输出中生成它们的扩展程序的首次出现位置下方，并以虚线边连接。
--extension_filter <extension>[,<extension>[,...]]：如果指定，输出图将仅包含使用指定扩展程序的模块以及通向这些模块的路径。指定空扩展列表（如--extension_filter=中所示）相当于指定依赖关系图中任何模块使用的所有扩展。--depth <N>：输出图的深度。深度为 1 时，仅显示根及其直接依赖项。对于explain，默认值为 1；对于deps，默认值为 2；对于其他，默认值为无限。--cyclesdefault: "false"：在输出图表中包含环路边。--include_builtin默认值：“false”：在输出图表中包含内置模块（例如@bazel_tools）。此标志默认处于停用状态，因为每个其他模块都隐式依赖于内置模块，这会使输出非常杂乱。--charset <charset>default: utf8：指定用于文本输出的字符集。有效值为"utf8"和"ascii"。唯一显著的区别在于用于以"text"输出格式绘制图表的特殊字符，这些字符在"ascii"字符集中不存在。因此，"ascii"字符集也存在，以便支持无法使用 Unicode 的旧版平台。--output <mode>：在输出图表中包含有关模块扩展程序使用情况的信息。<mode> 可以是以下值之一：text（默认）：输出图（扁平化为树）的直观易懂的表示形式。json：以 JSON 对象（扁平化为树）的形式输出图表。graph：以 Graphviz dot 表示法输出图。
bazel mod graph --output graph | dot -Tsvg > /tmp/graph.svg
其他选项包括：
--base_module <arg>default:<root>：指定一个模块，用于解释实参中的表观代码库名称。请注意，此实参本身可以是@<repo_name>的形式；这始终是相对于根模块进行解释的。--extension_usages <arg>[,<arg>[,...]]：过滤show_extension以仅显示指定模块的扩展程序使用情况。
示例
下面展示了在真实的 Bazel 项目中使用 mod 命令的一些可能用法，以便您大致了解如何使用该命令来检查项目的外部依赖项。
MODULE.bazel 文件：
module(
name = "my_project",
version = "1.0",
)
bazel_dep(name = "bazel_skylib", version = "1.1.1", repo_name = "skylib1")
bazel_dep(name = "bazel_skylib", version = "1.2.0", repo_name = "skylib2")
multiple_version_override(module_name = "bazel_skylib", versions = ["1.1.1", "1.2.0"])
bazel_dep(name = "stardoc", version = "0.5.0")
bazel_dep(name = "rules_java", version = "5.0.0")
toolchains = use_extension("@rules_java//java:extensions.bzl", "toolchains")
use_repo(toolchains, my_jdk="remotejdk17_linux")
|
|
显示项目的整个依赖关系图。
bazel mod graph<root> (my_project@1.0) ├───bazel_skylib@1.1.1 │ └───platforms@0.0.4 ├───bazel_skylib@1.2.0 │ └───platforms@0.0.4 ... ├───rules_java@5.0.0 │ ├───platforms@0.0.4 ... │ ├───rules_cc@0.0.1 │ │ ├───bazel_skylib@1.1.1 ... │ │ └───platforms@0.0.4 ... │ └───rules_proto@4.0.0 │ ├───bazel_skylib@1.1.1 ... │ └───rules_cc@0.0.1 ... └───stardoc@0.5.0 ├───bazel_skylib@1.1.1 ... └───rules_java@5.0.0 ...显示整个依赖关系图（包括未使用的模块，以及有关版本解析的额外信息）。
bazel mod graph --include_unused --verbose<root> (my_project@1.0) ├───bazel_skylib@1.1.1 │ └───platforms@0.0.4 ├───bazel_skylib@1.2.0 │ └───platforms@0.0.4 ... ├───rules_java@5.0.0 │ ├───platforms@0.0.4 ... │ ├───rules_cc@0.0.1 │ │ ├───bazel_skylib@1.0.3 ... (to 1.1.1, cause multiple_version_override) │ │ ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) │ │ └───platforms@0.0.4 ... │ └───rules_proto@4.0.0 │ ├───bazel_skylib@1.0.3 ... (to 1.1.1, cause multiple_version_override) │ ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) │ └───rules_cc@0.0.1 ... └───stardoc@0.5.0 ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) ├───rules_java@5.0.0 ... (was 4.0.0, cause <root>, bazel_tools@_) ├───bazel_skylib@1.0.3 (to 1.1.1, cause multiple_version_override) │ └───platforms@0.0.4 ... └───rules_java@4.0.0 (to 5.0.0, cause <root>, bazel_tools@_) ├───bazel_skylib@1.0.3 ... (to 1.1.1, cause multiple_version_override) └───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override)显示从某些特定模块展开的依赖关系图。
bazel mod graph --from rules_java --include_unused<root> (my_project@1.0) ├───rules_java@5.0.0 │ ├───platforms@0.0.4 │ ├───rules_cc@0.0.1 │ │ ├───bazel_skylib@1.0.3 ... (unused) │ │ ├───bazel_skylib@1.1.1 ... │ │ └───platforms@0.0.4 ... │ └───rules_proto@4.0.0 │ ├───bazel_skylib@1.0.3 ... (unused) │ ├───bazel_skylib@1.1.1 ... │ └───rules_cc@0.0.1 ... └╌╌rules_java@4.0.0 (unused) ├───bazel_skylib@1.0.3 (unused) │ └───platforms@0.0.4 ... └───bazel_skylib@1.1.1 └───platforms@0.0.4 ...显示两个模块之间的所有路径。
bazel mod all_paths bazel_skylib@1.1.1 --from rules_proto<root> (my_project@1.0) └╌╌rules_proto@4.0.0 ├───bazel_skylib@1.1.1 └───rules_cc@0.0.1 └───bazel_skylib@1.1.1 ...了解项目依赖于某些模块的原因和方式。
bazel mod explain @skylib1 --verbose --include_unused<root> (my_project@1.0) ├───bazel_skylib@1.1.1 ├───rules_java@5.0.0 │ ├───rules_cc@0.0.1 │ │ └───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) │ └───rules_proto@4.0.0 │ ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) │ └───rules_cc@0.0.1 ... └───stardoc@0.5.0 ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) ├╌╌rules_cc@0.0.1 │ └───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) └╌╌rules_proto@4.0.0 ├───bazel_skylib@1.1.1 ... (was 1.0.3, cause multiple_version_override) └───rules_cc@0.0.1 ...查看部分模块代码库的底层规则。
bazel mod show_repo rules_cc stardoc## rules_cc@0.0.1: # <builtin> http_archive( name = "rules_cc+", urls = ["https://bcr.bazel.build/test-mirror/github.com/bazelbuild/rules_cc/releases/download/0.0.1/rules_cc-0.0.1.tar.gz", "https://github.com/bazelbuild/rules_cc/releases/download/0.0.1/rules_cc-0.0.1.tar.gz"], integrity = "sha256-Tcy/0iwN7xZMj0dFi9UODHFI89kgAs20WcKpamhJgkE=", strip_prefix = "", remote_patches = {"https://bcr.bazel.build/modules/rules_cc/0.0.1/patches/add_module_extension.patch": "sha256-g3+zmGs0YT2HKOVevZpN0Jet89Ylw90Cp9XsIAY8QqU="}, remote_patch_strip = 1, ) # Rule http_archive defined at (most recent call last): # /home/user/.cache/bazel/_bazel_user/6e893e0f5a92cc4cf5909a6e4b2770f9/external/bazel_tools/tools/build_defs/repo/http.bzl:355:31 in <toplevel> ## stardoc: # <builtin> http_archive( name = "stardoc+", urls = ["https://bcr.bazel.build/test-mirror/github.com/bazelbuild/stardoc/releases/download/0.5.0/stardoc-0.5.0.tar.gz", "https://github.com/bazelbuild/stardoc/releases/download/0.5.0/stardoc-0.5.0.tar.gz"], integrity = "sha256-yXlNzIAmow/2fPfPkeviRcopSyCwcYRdEsGSr+JDrXI=", strip_prefix = "", remote_patches = {}, remote_patch_strip = 0, ) # Rule http_archive defined at (most recent call last): # /home/user/.cache/bazel/_bazel_user/6e893e0f5a92cc4cf5909a6e4b2770f9/external/bazel_tools/tools/build_defs/repo/http.bzl:355:31 in <toplevel>查看依赖关系图中使用了哪些模块扩展程序。
bazel mod graph --extension_info=usages --extension_filter=all<root> (my_project@1.0) ├───$@@rules_java.5.0.0//java:extensions.bzl%toolchains ├───rules_java@5.0.0 # │ ├───$@@rules_java.5.0.0//java:extensions.bzl%toolchains │ ├───rules_cc@0.0.1 # │ │ └───$@@rules_cc.0.0.1//bzlmod:extensions.bzl%cc_configure │ └───rules_proto@4.0.0 │ └───rules_cc@0.0.1 ... └───stardoc@0.5.0 └───rules_java@5.0.0 ...查看作为依赖关系图的一部分，从某个特定扩展程序生成和导入了哪些代码库。
bazel mod show_extension @@rules_java+5.0.0//java:extensions.bzl%toolchains<root> (my_project@1.0) ├───$@@rules_java.5.0.0//java:extensions.bzl%toolchains │ ├───remotejdk17_linux │ ├╌╌remotejdk11_linux │ ├╌╌remotejdk11_linux_aarch64 │ ├╌╌remotejdk11_linux_ppc64le │ ├╌╌remotejdk11_linux_s390x ...(some lines omitted)... ├───rules_java@5.0.0 # │ └───$@@rules_java.5.0.0//java:extensions.bzl%toolchains ... │ ├───local_jdk │ ├───remote_java_tools │ ├───remote_java_tools_darwin │ ├───remote_java_tools_linux │ ├───remote_java_tools_windows │ ├───remotejdk11_linux_aarch64_toolchain_config_repo │ ├───remotejdk11_linux_ppc64le_toolchain_config_repo ...(some lines omitted)... └───stardoc@0.5.0 └───rules_java@5.0.0 ...查看扩展程序生成的代码库列表，以及该扩展程序在每个模块中的使用方式。
bazel mod graph --extension_info=all --extension_filter=@rules_java//java:extensions.bzl%toolchains## @@rules_java.5.0.0//java:extensions.bzl%toolchains: Fetched repositories: - local_jdk (imported by bazel_tools@_, rules_java@5.0.0) - remote_java_tools (imported by bazel_tools@_, rules_java@5.0.0) - remote_java_tools_darwin (imported by bazel_tools@_, rules_java@5.0.0) - remote_java_tools_linux (imported by bazel_tools@_, rules_java@5.0.0) - remote_java_tools_windows (imported by bazel_tools@_, rules_java@5.0.0) - remotejdk11_linux_aarch64_toolchain_config_repo (imported by rules_java@5.0.0) - remotejdk11_linux_ppc64le_toolchain_config_repo (imported by rules_java@5.0.0) ...(some lines omitted)... - remotejdk17_linux (imported by <root>) - remotejdk11_linux - remotejdk11_linux_aarch64 - remotejdk11_linux_ppc64le - remotejdk11_linux_s390x - remotejdk11_macos ...(some lines omitted)... # Usage in <root> at <root>/MODULE.bazel:14:27 with the specified attributes: use_repo( toolchains, my_jdk="remotejdk17_linux", ) # Usage in bazel_tools@_ at bazel_tools@_/MODULE.bazel:23:32 with the specified attributes: use_repo( toolchains, "local_jdk", "remote_java_tools", "remote_java_tools_linux", "remote_java_tools_windows", "remote_java_tools_darwin", ) # Usage in rules_java@5.0.0 at rules_java@5.0.0/MODULE.bazel:30:27 with the specified attributes: use_repo( toolchains, "remote_java_tools", "remote_java_tools_linux", "remote_java_tools_windows", "remote_java_tools_darwin", "local_jdk", "remotejdk11_linux_toolchain_config_repo", "remotejdk11_macos_toolchain_config_repo", "remotejdk11_macos_aarch64_toolchain_config_repo", ...(some lines omitted)... )查看某些扩展程序生成的代码库的底层规则。
bazel mod show_repo --base_module=rules_java @remote_java_tools## @remote_java_tools: # <builtin> http_archive( name = "rules_java++toolchains+remote_java_tools", urls = ["https://mirror.bazel.build/bazel_java_tools/releases/java/v11.5/java_tools-v11.5.zip", "https://github.com/bazelbuild/java_tools/releases/download/java_v11.5/java_tools-v11.5.zip"], sha256 = "b763ee80e5754e593fd6d5be6d7343f905bc8b73d661d36d842b024ca11b6793", ) # Rule http_archive defined at (most recent call last): # /home/user/.cache/bazel/_bazel_user/6e893e0f5a92cc4cf5909a6e4b2770f9/external/bazel_tools/tools/build_defs/repo/http.bzl:355:31 in <toplevel>