MODULE.bazel ไฟล์

รายงานปัญหา

เมธอดที่มีในไฟล์ MODULE.bazel

สมาชิก

archive_override

None archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)

ระบุว่าทรัพยากร Dependency นี้ควรมาจากไฟล์ที่เก็บถาวร (zip, gzip เป็นต้น) ที่ตําแหน่งหนึ่งๆ ไม่ใช่จากรีจิสทรี คำสั่งนี้จะมีผลในโมดูลรูทเท่านั้น กล่าวคือ หากผู้อื่นใช้โมดูลเป็นแบบอ้างอิง ระบบจะไม่สนใจการลบล้างของโมดูลนั้น

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
module_name ต้องระบุ
ชื่อของทรัพยากร Dependency ของโมดูล Bazel ที่จะใช้การลบล้างนี้
urls string หรือทำซ้ำ strings ได้ ต้องระบุ
URL ของที่เก็บถาวร ซึ่งอาจเป็น http(s):// หรือ file:// URL
integrity ค่าเริ่มต้นคือ ''
checksum ของไฟล์ที่เก็บถาวรซึ่งอยู่ในรูปแบบ Subresource Integrity
strip_prefix ค่าเริ่มต้นคือ ''
คำนำหน้าไดเรกทอรีเพื่อตัดออกจากไฟล์ที่แยกออกมา
patches ซ้ำกันของ string ได้ ค่าเริ่มต้นคือ []
รายการป้ายกำกับที่ชี้ไปยังไฟล์แพตช์ที่จะใช้กับโมดูลนี้ ไฟล์แพตช์ต้องอยู่ในโครงสร้างแหล่งที่มาของโปรเจ็กต์ระดับบนสุด โดยจะใช้ตามลำดับของรายการ
patch_cmds ซ้ำกันของ string ได้ โดยค่าเริ่มต้นคือ []
ลำดับของคำสั่ง Bash ที่จะใช้กับ Linux/Macos หลังจากใช้แพตช์
patch_strip ค่าเริ่มต้นคือ 0
เหมือนกับอาร์กิวเมนต์ --strip ของแพตช์ Unix

bazel_dep

None bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)

ประกาศการพึ่งพาโมดูล Bazel อื่นโดยตรง

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
name ต้องระบุ
ชื่อของโมดูลที่จะเพิ่มเป็นแบบอ้างอิงโดยตรง
version ค่าเริ่มต้นคือ ''
เวอร์ชันของโมดูลที่จะเพิ่มเป็นแบบอ้างอิงโดยตรง
max_compatibility_level ค่าเริ่มต้นคือ -1
จำนวนสูงสุด compatibility_level รายการที่รองรับเพื่อให้เพิ่มโมดูลเป็นทรัพยากร Dependency โดยตรง เวอร์ชันของโมดูลหมายถึงระดับความเข้ากันได้ขั้นต่ำที่รองรับ ส่วนระดับขั้นสูงสุดหากไม่ได้ระบุแอตทริบิวต์นี้
repo_name ค่าเริ่มต้นคือ ''
ชื่อของที่เก็บภายนอกที่แสดงถึงทรัพยากร Dependency นี้ นี่คือชื่อของโมดูลโดยค่าเริ่มต้น
dev_dependency ค่าเริ่มต้นคือ False
หากเป็น "จริง" ระบบจะไม่สนใจทรัพยากร Dependency นี้หากโมดูลปัจจุบันไม่ใช่โมดูลรูทหรือเปิดใช้ "--ignore_dev_dependency"

git_override

None git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0)

ระบุว่าทรัพยากร Dependency ควรมาจากคอมมิตของที่เก็บ Git คำสั่งนี้จะมีผลในโมดูลรูทเท่านั้น กล่าวคือ หากผู้อื่นใช้โมดูลเป็นแบบอ้างอิง ระบบจะไม่สนใจการลบล้างของโมดูลนั้น

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
module_name ต้องระบุ
ชื่อของทรัพยากร Dependency ของโมดูล Bazel ที่จะใช้การลบล้างนี้
remote ต้องระบุ
URL ของที่เก็บ Git ระยะไกล
commit ค่าเริ่มต้นคือ ''
คอมมิตที่ควรตรวจสอบ
patches ซ้ำกันของ string ได้ ค่าเริ่มต้นคือ []
รายการป้ายกำกับที่ชี้ไปยังไฟล์แพตช์ที่จะใช้กับโมดูลนี้ ไฟล์แพตช์ต้องอยู่ในโครงสร้างแหล่งที่มาของโปรเจ็กต์ระดับบนสุด โดยจะใช้ตามลำดับของรายการ
patch_cmds ซ้ำกันของ string ได้ โดยค่าเริ่มต้นคือ []
ลำดับของคำสั่ง Bash ที่จะใช้กับ Linux/Macos หลังจากใช้แพตช์
patch_strip ค่าเริ่มต้นคือ 0
เหมือนกับอาร์กิวเมนต์ --strip ของแพตช์ Unix

local_path_override

None local_path_override(module_name, path)

ระบุว่าทรัพยากร Dependency ควรมาจากไดเรกทอรีบางรายการบนดิสก์ในเครื่อง คำสั่งนี้จะมีผลในโมดูลรูทเท่านั้น กล่าวคือ หากผู้อื่นใช้โมดูลเป็นแบบอ้างอิง ระบบจะไม่สนใจการลบล้างของโมดูลนั้น

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
module_name ต้องระบุ
ชื่อของทรัพยากร Dependency ของโมดูล Bazel ที่จะใช้การลบล้างนี้
path ต้องระบุ
เส้นทางไปยังไดเรกทอรีที่มีโมดูลนี้

โมดูล

None module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])

ประกาศคุณสมบัติบางอย่างของโมดูล Bazel ที่แสดงโดยที่เก็บ Bazel ปัจจุบัน พร็อพเพอร์ตี้เหล่านี้เป็นข้อมูลเมตาที่สำคัญของโมดูล (เช่น ชื่อและเวอร์ชัน) หรือส่งผลต่อลักษณะการทำงานของโมดูลปัจจุบันและโมดูลที่เกี่ยวข้อง

ควรเรียกใช้ไม่เกิน 1 ครั้ง โดยสามารถละเว้นได้ต่อเมื่อโมดูลนี้เป็นโมดูลรากเท่านั้น (เช่น ในกรณีที่โมดูลอื่นไม่ได้อ้างอิงโดยโมดูลอื่น)

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
name ค่าเริ่มต้นคือ ''
ชื่อของโมดูล ละเว้นได้ต่อเมื่อโมดูลนี้เป็นโมดูลรูทเท่านั้น (เช่น ในกรณีที่โมดูลอื่นไม่ได้อ้างอิงโดยโมดูลอื่น) ชื่อโมดูลที่ถูกต้องต้องมีลักษณะดังนี้ 1) มีเฉพาะตัวอักษรพิมพ์เล็ก (a-z) ตัวเลข (0-9) จุด (.) ขีดกลาง (-) และขีดล่าง (_); 2) ขึ้นต้นด้วยตัวอักษรพิมพ์เล็ก 3) ลงท้ายด้วยตัวอักษรพิมพ์เล็กหรือตัวเลข
version ค่าเริ่มต้นคือ''
เวอร์ชันของโมดูล ละเว้นได้ต่อเมื่อโมดูลนี้เป็นโมดูลรูทเท่านั้น (เช่น ในกรณีที่โมดูลอื่นไม่ได้อ้างอิงโดยโมดูลอื่น) เวอร์ชันต้องอยู่ในรูปแบบ SemVer ที่ผ่อนคลาย โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบ
compatibility_level ค่าเริ่มต้นคือ 0
ระดับความเข้ากันได้ของโมดูล ซึ่งควรเปลี่ยนทุกครั้งที่มีการทำการเปลี่ยนแปลงสำคัญที่ใช้ร่วมกันไม่ได้ โดยพื้นฐานแล้ว นี่ก็คือ "เวอร์ชันหลัก" ของโมดูลในแง่ของ SemVer ยกเว้นว่าโมดูลนี้ไม่ได้ฝังอยู่ในสตริงเวอร์ชันเอง แต่อยู่อีกช่องหนึ่ง โมดูลที่มีระดับความเข้ากันได้แตกต่างกันจะเข้าร่วมในความละเอียดของเวอร์ชันเหมือนเป็นโมดูลที่มีชื่อต่างกัน แต่กราฟการอ้างอิงสุดท้ายไม่สามารถมีโมดูลหลายรายการที่มีชื่อเดียวกันแต่มีระดับความเข้ากันได้ต่างกัน (เว้นแต่มีการใช้ multiple_version_override) ดูรายละเอียดเพิ่มเติมได้ในเอกสารประกอบ
repo_name ค่าเริ่มต้นคือ ''
ชื่อของที่เก็บที่แสดงถึงโมดูลนี้ ตามที่โมดูลมองเห็น โดยค่าเริ่มต้น ชื่อของที่เก็บจะเป็นชื่อของโมดูล คุณสามารถระบุเพื่อให้ย้ายข้อมูลได้ง่ายขึ้นสำหรับโปรเจ็กต์ที่ใช้ชื่อที่เก็บสำหรับตัวเองซึ่งต่างจากชื่อโมดูล
bazel_compatibility ซ้ำกันของ string ได้ โดยมีค่าเริ่มต้นเป็น []
รายการเวอร์ชัน Bazel ที่อนุญาตให้ผู้ใช้ประกาศเวอร์ชัน Bazel ที่เข้ากันได้กับโมดูลนี้ โดยจะไม่ส่งผลต่อการแก้ปัญหาทรัพยากร Dependency แต่ bzlmod จะใช้ข้อมูลนี้เพื่อตรวจสอบว่า Bazel เวอร์ชันปัจจุบันของคุณใช้งานร่วมกันได้หรือไม่ รูปแบบของค่านี้เป็นสตริงของค่าข้อจำกัดบางค่าที่คั่นด้วยเครื่องหมายจุลภาค ระบบรองรับข้อจำกัด 3 ประการ ได้แก่ <=X.X.X: เวอร์ชัน Bazel ต้องเท่ากับหรือมากกว่า X.X.X โดยจะใช้เมื่อมีการเปลี่ยนแปลงที่ใช้ร่วมกันไม่ได้ในเวอร์ชันที่ใหม่กว่า >=X.X.X: เวอร์ชัน Bazel ต้องเท่ากับหรือใหม่กว่า X.X.X. ใช้เมื่อคุณขึ้นอยู่กับฟีเจอร์บางอย่างที่ใช้ได้ตั้งแต่ X.X.X. -X.X.X: Bazel เวอร์ชัน X.X.X ไม่สามารถทำงานร่วมกันได้ ใช้เมื่อมีข้อบกพร่องใน X.X.X ที่รบกวนคุณ แต่ได้รับการแก้ไขในเวอร์ชันหลังๆ

multiple_version_override

None multiple_version_override(module_name, versions, registry='')

ระบุว่าทรัพยากร Dependency ควรมาจากรีจิสทรี แต่ควรอนุญาตให้ทรัพยากร Dependency หลายเวอร์ชันอยู่ร่วมกันได้ ดูรายละเอียดเพิ่มเติมได้ในเอกสารประกอบ คำสั่งนี้จะมีผลในโมดูลรูทเท่านั้น กล่าวคือ หากผู้อื่นใช้โมดูลเป็นแบบอ้างอิง ระบบจะไม่สนใจการลบล้างของโมดูลนั้น

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
module_name ต้องระบุ
ชื่อของทรัพยากร Dependency ของโมดูล Bazel ที่จะใช้การลบล้างนี้
versions ซ้ำกันของ strings ได้ ต้องระบุ
ระบุเวอร์ชันที่อนุญาตให้ทำงานควบคู่กันอย่างชัดเจน โดยเวอร์ชันเหล่านี้จะต้องอยู่ในการเลือกกราฟการอ้างอิงล่วงหน้าอยู่แล้ว ระบบจะ "อัปเกรด" ทรัพยากร Dependency ของโมดูลนี้เป็นเวอร์ชันที่อนุญาตที่สูงกว่าที่ใกล้เคียงที่สุดในระดับความเข้ากันได้เดียวกัน ในขณะที่ทรัพยากร Dependency ที่มีเวอร์ชันสูงกว่าเวอร์ชันที่อนุญาตในระดับความเข้ากันได้เดียวกันจะส่งผลให้เกิดข้อผิดพลาด
registry ค่าเริ่มต้นคือ ''
ลบล้างรีจิสทรีของโมดูลนี้ แทนที่จะค้นหาโมดูลนี้จากรายการรีจิสทรีเริ่มต้น ควรใช้รีจิสทรีที่ระบุ

register_execution_platforms

None register_execution_platforms(dev_dependency=False, *platform_labels)

ระบุแพลตฟอร์มการดำเนินการที่กำหนดไว้แล้วสำหรับการลงทะเบียนเมื่อเลือกโมดูลนี้ ควรเป็นรูปแบบเป้าหมายสัมบูรณ์ (เช่น ขึ้นต้นด้วย @ หรือ //) โปรดดูข้อมูลเพิ่มเติมในการแก้ปัญหาของ Toolchain

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
dev_dependency ค่าเริ่มต้นคือ False
หากเป็น "จริง" ระบบจะไม่ลงทะเบียนแพลตฟอร์มการดำเนินการหากโมดูลปัจจุบันไม่ใช่โมดูลรูทหรือเปิดใช้ "--ignore_dev_dependency"
platform_labels ลำดับของสตริง ต้องระบุ
ป้ายกำกับของแพลตฟอร์มที่จะลงทะเบียน

register_toolchains

None register_toolchains(dev_dependency=False, *toolchain_labels)

ระบุห่วงโซ่เครื่องมือที่กำหนดไว้แล้วสำหรับลงทะเบียนเมื่อเลือกโมดูลนี้ ควรเป็นรูปแบบเป้าหมายสัมบูรณ์ (เช่น ขึ้นต้นด้วย @ หรือ //) โปรดดูข้อมูลเพิ่มเติมในการแก้ปัญหาของ Toolchain

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
dev_dependency ค่าเริ่มต้นคือ False
หากเป็น "จริง" ระบบจะไม่ลงทะเบียนห่วงโซ่เครื่องมือหากโมดูลปัจจุบันไม่ใช่โมดูลรูทหรือเปิดใช้ "--ignore_dev_dependency"
toolchain_labels ลำดับของ strings; ต้องระบุ
ป้ายกำกับของ Toolchain ในการลงทะเบียน ป้ายกำกับอาจประกอบด้วย :all ซึ่งในกรณีนี้ เป้าหมายที่นำเสนอเครื่องมือทั้งหมดในแพ็กเกจจะได้รับการบันทึกตามลำดับแบบพจนานุกรมตามชื่อ

single_version_override

None single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)

ระบุว่าทรัพยากร Dependency ควรมาจากรีจิสทรี แต่ควรปักหมุดเวอร์ชันของรีจิสทรี หรือลบล้างรีจิสทรีหรือรายการแพตช์ที่ใช้ คำสั่งนี้จะมีผลในโมดูลรูทเท่านั้น กล่าวคือ หากผู้อื่นใช้โมดูลเป็นแบบอ้างอิง ระบบจะไม่สนใจการลบล้างของโมดูลนั้น

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
module_name ต้องระบุ
ชื่อของทรัพยากร Dependency ของโมดูล Bazel ที่จะใช้การลบล้างนี้
version ค่าเริ่มต้นคือ ''
ลบล้างเวอร์ชันที่ประกาศของโมดูลนี้ในกราฟการอ้างอิง กล่าวคือ โมดูลนี้จะถูก "ปักหมุด" ไว้กับเวอร์ชันการลบล้างนี้ คุณละเว้นแอตทริบิวต์นี้ได้หากแอตทริบิวต์ทั้งหมดต้องการลบล้างคือรีจิสทรีหรือแพตช์
registry ค่าเริ่มต้นคือ ''
ลบล้างรีจิสทรีของโมดูลนี้ แทนที่จะค้นหาโมดูลนี้จากรายการรีจิสทรีเริ่มต้น ควรใช้รีจิสทรีที่ระบุ
patches ซ้ำกันของ string ได้ ค่าเริ่มต้นคือ []
รายการป้ายกำกับที่ชี้ไปยังไฟล์แพตช์ที่จะใช้กับโมดูลนี้ ไฟล์แพตช์ต้องอยู่ในโครงสร้างแหล่งที่มาของโปรเจ็กต์ระดับบนสุด โดยจะใช้ตามลำดับของรายการ
patch_cmds ซ้ำกันของ string ได้ โดยค่าเริ่มต้นคือ []
ลำดับของคำสั่ง Bash ที่จะใช้กับ Linux/Macos หลังจากใช้แพตช์
patch_strip ค่าเริ่มต้นคือ 0
เหมือนกับอาร์กิวเมนต์ --strip ของแพตช์ Unix

use_extension

module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)

แสดงผลออบเจ็กต์พร็อกซีที่แสดงส่วนขยายโมดูล โดยคุณสามารถเรียกใช้เมธอดเพื่อสร้างแท็กส่วนขยายโมดูลได้

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
extension_bzl_file ต้องระบุ
ป้ายกำกับไฟล์ Starlark ที่บ่งบอกถึงส่วนขยายโมดูล
extension_name ต้องระบุ
ชื่อของส่วนขยายโมดูลที่จะใช้ ไฟล์ Starlark ต้องส่งออกสัญลักษณ์ที่มีชื่อนี้
dev_dependency ค่าเริ่มต้นคือ False
หากเป็น "จริง" ระบบจะไม่สนใจการใช้ส่วนขยายโมดูลนี้หากโมดูลปัจจุบันไม่ใช่โมดูลรูทหรือเปิดใช้ "--ignore_dev_dependency"
isolate ค่าเริ่มต้นคือFalse
ทดลอง พารามิเตอร์นี้อยู่ในขั้นทดลองและอาจมีการเปลี่ยนแปลงได้ตลอดเวลา โปรดอย่าพึ่งพาสิ่งนี้ อาจเปิดใช้ในการทดลองได้โดยการตั้งค่า ---experimental_isolated_extension_usages
หากเป็นจริง การใช้ส่วนขยายโมดูลนี้จะแยกจากการใช้งานอื่นๆ ทั้งหมด ทั้งในโมดูลนี้และโมดูลอื่น แท็กที่สร้างขึ้นเพื่อการใช้งานนี้จะไม่ส่งผลต่อการใช้งานอื่นๆ และที่เก็บที่สร้างโดยส่วนขยายเพื่อการใช้งานนี้จะแตกต่างจากที่เก็บอื่นๆ ทั้งหมดที่ส่วนขยายสร้างขึ้น

ขณะนี้พารามิเตอร์นี้อยู่ในขั้นทดลองและใช้ได้เฉพาะกับแฟล็ก --experimental_isolated_extension_usages

use_repo

None use_repo(extension_proxy, *args, **kwargs)

นำเข้าที่เก็บซึ่งสร้างโดยส่วนขยายโมดูลที่ระบุลงในขอบเขตของโมดูลปัจจุบันอย่างน้อย 1 รายการ

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
extension_proxy ต้องระบุ
ออบเจ็กต์พร็อกซีของส่วนขยายโมดูลที่แสดงผลโดยการเรียก use_extension
args ต้องระบุ
ชื่อของที่เก็บที่จะนำเข้า
kwargs ต้องระบุ
ระบุที่เก็บบางรายการที่จะนำเข้าไปยังขอบเขตของโมดูลปัจจุบันโดยใช้ชื่อต่างกัน คีย์ควรเป็นชื่อที่ใช้ในขอบเขตปัจจุบัน ส่วนค่าควรเป็นชื่อเดิมที่ส่วนขยายโมดูลส่งออก

use_repo_rule

repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)

แสดงผลค่าพร็อกซีที่เรียกใช้ได้โดยตรงในไฟล์ MODULE.bazel เป็นกฎที่เก็บอย่างน้อย 1 ครั้ง Repos ที่สร้างขึ้นในลักษณะนี้จะปรากฏเฉพาะกับโมดูลปัจจุบัน ภายใต้ชื่อที่ประกาศโดยใช้แอตทริบิวต์ name บนพร็อกซี นอกจากนี้ แอตทริบิวต์บูลีน dev_dependency โดยนัยยังสามารถใช้ในพร็อกซีเพื่อระบุว่าที่เก็บบางรายการสร้างขึ้นเมื่อโมดูลปัจจุบันเป็นโมดูลรากเท่านั้น

พารามิเตอร์

พารามิเตอร์ คำอธิบาย
repo_rule_bzl_file ต้องระบุ
ป้ายกำกับไฟล์ Starlark ที่เป็นตัวกำหนดกฎที่เก็บ
repo_rule_name ต้องระบุ
ชื่อของกฎที่เก็บที่จะใช้ ไฟล์ Starlark ต้องส่งออกสัญลักษณ์ที่มีชื่อนี้