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 つから引数モジュールへのパスを 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>:--base_moduleのコンテキストで特定の見かけ上の名前を持つリポジトリ。@@<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でグラフを展開するモジュール。詳細については、サブコマンドの説明をご覧ください。--verbosedefault: "false": 各モジュールのバージョン解決に関する追加情報を出力グラフに含めます。解決中にモジュール バージョンが変更された場合は、置き換えたバージョン、または置き換えた元のバージョン、置き換えた理由、新しいバージョンをリクエストしたモジュール（理由が最小バージョンの選択である場合）を表示します。--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、それ以外は無限大です。--cyclesデフォルト: "false": 出力グラフに周期のエッジを含めます。--include_builtindefault: "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>