Bazel 6.3.0 で導入された mod コマンドには、Bzlmod が有効な場合にユーザーが外部依存関係グラフを理解するためのさまざまなツールが用意されています。依存関係グラフの可視化、特定のモジュールまたはモジュールのバージョンがグラフに存在する理由の確認、モジュールのバッキング リポジトリ定義の表示、モジュールが生成したモジュール拡張機能とリポジトリの使用状況の検査などを行うことができます。
構文
bazel mod <subcommand> [<options>] [<arg> [<arg>...]]
使用可能なサブコマンドとそれに対応する必須の引数は次のとおりです。
graph: プロジェクトの完全な依存関係グラフがルート モジュールから表示されます。--fromで 1 つ以上のモジュールが指定されている場合、これらのモジュールはルートの直下に表示され、グラフはそれらのモジュールからのみ展開されます（例を参照）。deps <arg>...:graphと同様に、指定された各モジュールの解決済みの直接依存関係を表示します。all_paths <arg>...: ルートから指定された<arg>...までの既存のパスをすべて表示します。--fromで 1 つ以上のモジュールが指定されている場合、これらのモジュールはルートの直下に表示され、グラフには--fromモジュールから引数モジュールへの既存のパスが含まれます（例を参照）。path <arg>...: セマンティクスはall_pathsと同じですが、--fromモジュールの 1 つから引数モジュールのいずれかへの単一のパスのみを表示します。explain <arg>...: 指定したモジュールが依存関係グラフに表示されるすべての場所と、それらに直接依存するモジュールが表示されます。explainコマンドの出力は基本的にall_pathsコマンドのプルーニング バージョンになります。これには、1）ルート モジュール、2）引数モジュールにつながるルート モジュールの直接依存関係、3）引数モジュールの直接依存関係、4）引数モジュール自体が含まれます（例を参照）。show_repo <arg>...: 指定したリポジトリの定義を表示します（例を参照）。show_extension <extension>...: 指定された各拡張機能に関する情報を表示します。生成されたリポジトリと、use_repoを使用してそれらをインポートするモジュールのリスト、指定されたタグとuse_repo呼び出しを含む、拡張機能が使用されている各モジュールの使用状況のリストです（例を参照）。
<arg> は、1 つ以上のモジュールまたはリポジトリを指します。以下のいずれかになります。
リテラル文字列
<root>: 現在のプロジェクトを表すルート モジュール。<name>@<version>: バージョン<version>のモジュール<name>。レジストリ以外のオーバーライドがあるモジュールの場合は、<version>としてアンダースコア（_）を使用します。<name>: モジュール<name>の現在のすべてのバージョン。@@<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": 各モジュールのバージョン解決に関する追加情報を出力グラフに含めます。解決中にモジュール バージョンが変更された場合は、どのバージョンで置き換えられたか、または元のバージョンは何でしたか、置き換えられた理由、そしてその理由が「最小バージョンの選択」の場合はどのモジュールが新しいバージョンをリクエストしたかを示します。--include_unusedデフォルト: "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、その他の場合は無限です。--cyclesデフォルト: "false": 出力グラフにサイクルのエッジを含めます。--include_builtinデフォルト: "false": 出力グラフに組み込みモジュール（@bazel_toolsなど）を含めます。このフラグはデフォルトでは無効になっています。これは、組み込みモジュールが他のすべてのモジュールに暗黙的に依存し、出力がかなり雑然となるためです。--charset <charset>デフォルト: utf8: テキスト出力に使用する文字セットを指定します。有効な値は"utf8"と"ascii"です。唯一の大きな違いは、グラフを"text"出力形式で描画する際に使用される特殊文字です。この特殊文字は"ascii"文字セットには存在しません。そのため、Unicode を使用できないレガシー プラットフォームでの使用もサポートするために、"ascii"文字セットが用意されています。--output <mode>: モジュール拡張機能の使用状況に関する情報を出力グラフの一部として含めます。<mode> は、以下のいずれかになります。text（デフォルト）: 人が読める形式の出力グラフ（ツリーとしてフラット化されます）。json: グラフを JSON オブジェクト（ツリーとしてフラット化）の形式で出力します。graph: Graphviz のドット表現でグラフを出力します。
bazel mod graph --output graph | dot -Tsvg > /tmp/graph.svg
その他にも次のような対応策があります。
--base_module <arg>デフォルト:<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 ...2 つのモジュール間のすべてのパスを表示します。
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>