คำสั่ง mod
ซึ่งเปิดตัวใน Bazel 6.3.0 มีเครื่องมือมากมายที่ช่วยให้ผู้ใช้เข้าใจกราฟทรัพยากร Dependency ภายนอกเมื่อเปิดใช้ Bzlmod เครื่องมือนี้ช่วยให้คุณเห็นภาพกราฟการอ้างอิง ค้นหาว่าเหตุใดโมดูลหนึ่งๆ หรือบางเวอร์ชันของโมดูลจึงแสดงอยู่ในกราฟ ดูโมดูลสนับสนุนคำจำกัดความของที่เก็บ ตรวจสอบการใช้ส่วนขยายโมดูลและที่เก็บที่โมดูลนั้นๆ สร้างขึ้น รวมถึงฟังก์ชันอื่นๆ
ไวยากรณ์
bazel mod <subcommand> [<options>] [<arg> [<arg>...]]
คำสั่งย่อยที่ใช้ได้และอาร์กิวเมนต์ที่จำเป็นที่เกี่ยวข้องมีดังนี้
graph
: แสดงกราฟทรัพยากร Dependency ทั้งหมดของโปรเจ็กต์ โดยเริ่มจากโมดูลรูท หากระบุโมดูลอย่างน้อย 1 รายการใน--from
โมดูลเหล่านี้จะแสดงใต้รูทโดยตรง และกราฟจะขยายขึ้นเท่านั้นโดยเริ่มจากโมดูลดังกล่าว (ดูตัวอย่าง)deps <arg>...
: แสดงทรัพยากร Dependency โดยตรงที่แก้ไขแล้วของโมดูลที่ระบุแต่ละรายการ คล้ายกับgraph
all_paths <arg>...
: แสดงเส้นทางที่มีอยู่ทั้งหมดตั้งแต่รูทไปยัง<arg>...
ที่ระบุ หากระบุโมดูลอย่างน้อย 1 รายการใน--from
โมดูลเหล่านี้จะแสดงใต้รูทโดยตรง และกราฟจะแสดงเส้นทางที่มีอยู่จากโมดูล--from
ไปยังโมดูลอาร์กิวเมนต์ (ดูตัวอย่าง)path <arg>...
: มีความหมายเหมือนกับall_paths
แต่แสดงเส้นทางเดียวจากโมดูล--from
ไปยังโมดูลอาร์กิวเมนต์ใดโมดูลหนึ่งexplain <arg>...
: แสดงตำแหน่งทั้งหมดที่โมดูลที่ระบุปรากฏในกราฟทรัพยากร Dependency พร้อมกับโมดูลที่โมดูลดังกล่าวอ้างอิงโดยตรง เอาต์พุตของคำสั่งexplain
โดยพื้นฐานแล้วเป็นคำสั่งall_paths
เวอร์ชันที่ตัดออก ซึ่งจะมี 1) โมดูลรูท 2) ทรัพยากร Dependency โดยตรงของโมดูลรูทที่นำไปสู่โมดูลอาร์กิวเมนต์ 3) ทรัพยากร Dependency โดยตรงของโมดูลอาร์กิวเมนต์ และ 4) ตัวโมดูลอาร์กิวเมนต์ (ดูตัวอย่าง)show_repo <arg>...
: แสดงคำจำกัดความของที่เก็บที่ระบุ (ดูตัวอย่าง)show_extension <extension>...
: แสดงข้อมูลเกี่ยวกับส่วนขยายที่ระบุแต่ละรายการ ได้แก่ รายการที่เก็บที่สร้างขึ้นพร้อมกับโมดูลที่นําเข้าโดยใช้use_repo
และรายการการใช้ส่วนขยายนั้นในแต่ละโมดูลที่ใช้ ซึ่งประกอบด้วยแท็กที่ระบุและการเรียกuse_repo
(ดูตัวอย่าง)
<arg>
อ้างถึงโมดูลหรือที่เก็บ ซึ่งอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้
สตริงตามตัวอักษร
<root>
: โมดูลรากที่แสดงโปรเจ็กต์ปัจจุบันของคุณ<name>@<version>
: โมดูล<name>
ที่เวอร์ชัน<version>
สำหรับโมดูลที่มีการลบล้างที่ไม่ใช่รีจิสทรี ให้ใช้ขีดล่าง (_
) เป็น<version>
<name>
: เวอร์ชันที่นำเสนอทั้งหมดของโมดูล<name>
@<repo_name>
: ที่เก็บที่มีชื่อชัดเจนที่ระบุในบริบทของ--base_module
@@<repo_name>
: ที่เก็บที่มีชื่อ Canonical ที่ระบุ
ในบริบทที่ต้องการระบุโมดูล คุณจะใช้ <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>[,...]]
default:<root>
: โมดูลที่กราฟขยายในgraph
,all_paths
,path
และexplain
โปรดดูรายละเอียดเพิ่มเติมในคำอธิบายของคำสั่งย่อย--verbose
default: "false": รวมข้อมูลเพิ่มเติมเกี่ยวกับความละเอียดของเวอร์ชันของแต่ละโมดูลไว้ในกราฟเอาต์พุต หากเวอร์ชันของโมดูลมีการเปลี่ยนแปลงในระหว่างความละเอียด ให้แสดงเวอร์ชันที่ถูกแทนที่หรือเวอร์ชันเดิม เหตุผลของการเปลี่ยน และโมดูลใดที่ขอเวอร์ชันใหม่หากเหตุผลคือการเลือกเวอร์ชันต่ำสุด--include_unused
default: "false": ใส่โมดูลที่เคยอยู่ในกราฟการอ้างอิงไว้ในกราฟเอาต์พุต แต่ไม่มีการใช้งานหลังจากแปลงโมดูลแล้ว--extension_info <mode>
: ใส่ข้อมูลเกี่ยวกับการใช้ส่วนขยายโมดูลเป็นส่วนหนึ่งของกราฟเอาต์พุต (ดูตัวอย่าง)<mode>
อาจเป็นหนึ่งในรายการต่อไปนี้hidden
(ค่าเริ่มต้น): ไม่แสดงข้อมูลใดๆ เกี่ยวกับส่วนขยายusages
: แสดงส่วนขยายในแต่ละโมดูลที่ใช้ โดยจะพิมพ์ในรูปแบบ$<extension>
repos
: นอกเหนือจากusages
ให้แสดงที่เก็บที่นำเข้าโดยใช้use_repo
ภายใต้การใช้งานส่วนขยายแต่ละรายการall
: นอกเหนือจากusages
และrepos
แล้ว ยังแสดงที่เก็บซึ่งสร้างส่วนขยายที่ไม่ได้นำเข้าโดยโมดูลใดเลย ที่เก็บเพิ่มเติมเหล่านี้จะแสดงใต้รายการแรกของส่วนขยายที่สร้างในเอาต์พุต และเชื่อมต่อกับขอบที่เป็นจุด
--extension_filter <extension>[,<extension>[,...]]
: หากระบุไว้ กราฟเอาต์พุตจะมีเฉพาะโมดูลที่ใช้ส่วนขยายที่ระบุ รวมถึงเส้นทางที่นำไปสู่โมดูลเหล่านั้น การระบุรายการส่วนขยายที่ว่างเปล่า (เช่นเดียวกับใน--extension_filter=
) จะเทียบเท่ากับการระบุส่วนขยายทั้งหมดที่โมดูลใดก็ตามในกราฟการอ้างอิงใช้--depth <N>
: ความลึกของกราฟเอาต์พุต ความลึกที่ 1 จะแสดงเฉพาะราก และส่วน Dependency โดยตรงเท่านั้น ค่าเริ่มต้นจะเป็น 1 สำหรับexplain
, 2 สำหรับdeps
และอนันต์สำหรับค่าอื่นๆ--cycles
default: "false": รวมขอบของวงกลมในกราฟเอาต์พุต--include_builtin
default: "false": รวมโมดูลในตัว (เช่น@bazel_tools
) ในกราฟเอาต์พุต แฟล็กนี้ปิดใช้อยู่โดยค่าเริ่มต้นเนื่องจากโมดูลอื่นๆ ในตัวจะขึ้นอยู่กับโมดูลอื่นโดยปริยาย ซึ่งทำให้เอาต์พุตกระจัดกระจายอย่างมาก--charset <charset>
default: utf8: ระบุชุดอักขระที่จะใช้สำหรับเอาต์พุตข้อความ ค่าที่ถูกต้องคือ"utf8"
และ"ascii"
ความแตกต่างที่มีนัยสำคัญเพียงอย่างเดียวคืออักขระพิเศษที่ใช้เพื่อวาดกราฟในรูปแบบเอาต์พุต"text"
ซึ่งไม่มีอยู่ในชุดอักขระ"ascii"
ดังนั้นจึงมีชุดอักขระ"ascii"
เพื่อรองรับการใช้งานในแพลตฟอร์มเดิมที่ใช้ Unicode ไม่ได้--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
เพื่อแสดงเฉพาะการใช้ส่วนขยายจากโมดูลที่ระบุ
ตัวอย่าง
ตัวอย่างการใช้งานคำสั่ง mod
ที่เป็นไปได้ในโปรเจ็กต์ Bazel จริงจะแสดงอยู่ด้านล่างเพื่อให้คุณเห็นภาพทั่วๆ ไปเกี่ยวกับวิธีใช้คำสั่งดังกล่าวเพื่อตรวจสอบทรัพยากร Dependency ภายนอกของโปรเจ็กต์
ไฟล์ 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")
แสดงกราฟทรัพยากร Dependency ทั้งหมดของโปรเจ็กต์
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 ...
แสดงกราฟทรัพยากร Dependency ทั้งหมด (รวมถึงโมดูลที่ไม่ได้ใช้และข้อมูลเพิ่มเติมเกี่ยวกับความละเอียดของเวอร์ชัน)
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)
แสดงกราฟทรัพยากร Dependency ที่ขยายจากโมดูลที่เฉพาะเจาะจงบางรายการ
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 ...
ดูว่าที่เก็บใดสร้างขึ้นและนำเข้าจากส่วนขยายบางรายการโดยเป็นส่วนหนึ่งของกราฟทรัพยากร Dependency
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>