File MODULE.bazel

Laporkan masalah

Metode tersedia dalam file MODULE.bazel.

Anggota

archive_override

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

Menentukan bahwa dependensi ini harus berasal dari file arsip (zip, gzip, dll.) di lokasi tertentu, bukan dari registry. Perintah ini hanya berlaku di modul root; dengan kata lain, jika modul digunakan sebagai dependensi oleh orang lain, penggantiannya sendiri akan diabaikan.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel tempat penggantian ini diterapkan.
urls string; atau Iterable string; wajib
URL arsip; dapat berupa URL http(s):// atau file://.
integrity defaultnya adalah ''
Checksum file arsip yang diharapkan, dalam format Subresource Integrity.
strip_prefix defaultnya adalah ''
Awalan direktori yang akan dihapus dari file yang diekstrak.
patches Iterasi string; defaultnya adalah []
Daftar label yang mengarah ke file patch untuk diterapkan dalam modul ini. File patch harus ada di hierarki sumber project tingkat atas. Kolom tersebut diterapkan dalam urutan daftar.
patch_cmds string dapat diiterasi; defaultnya adalah []
Urutan perintah Bash yang akan diterapkan di Linux/Macos setelah patch diterapkan.
patch_strip defaultnya adalah 0
Sama dengan argumen --strip patch Unix.

bazel_dep

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

Mendeklarasikan dependensi langsung pada modul Bazel lainnya.

Parameter

Parameter Deskripsi
name wajib
Nama modul yang akan ditambahkan sebagai dependensi langsung.
version defaultnya adalah ''
Versi modul yang akan ditambahkan sebagai dependensi langsung.
max_compatibility_level defaultnya adalah -1
compatibility_level maksimum yang didukung untuk modul yang akan ditambahkan sebagai dependensi langsung. Versi modul menunjukkan kompatibilitas_level minimum yang didukung, serta maksimum jika atribut ini tidak ditentukan.
repo_name defaultnya adalah ''
Nama repo eksternal yang mewakili dependensi ini. Ini adalah nama modul secara default.
dev_dependency Defaultnya adalah False
Jika true (benar), dependensi ini akan diabaikan jika modul saat ini bukan modul root atau `--ignore_dev_dependency` diaktifkan.

git_override

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

Menentukan bahwa dependensi harus berasal dari commit tertentu dari repositori Git. Perintah ini hanya berlaku di modul root; dengan kata lain, jika modul digunakan sebagai dependensi oleh orang lain, penggantiannya sendiri akan diabaikan.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel tempat penggantian ini diterapkan.
remote wajib
URL repositori Git jarak jauh.
commit defaultnya adalah ''
Commit yang harus diperiksa.
patches Iterasi string; defaultnya adalah []
Daftar label yang mengarah ke file patch untuk diterapkan dalam modul ini. File patch harus ada di hierarki sumber project tingkat atas. Kolom tersebut diterapkan dalam urutan daftar.
patch_cmds string dapat diiterasi; defaultnya adalah []
Urutan perintah Bash yang akan diterapkan di Linux/Macos setelah patch diterapkan.
patch_strip defaultnya adalah 0
Sama dengan argumen --strip patch Unix.

local_path_override

None local_path_override(module_name, path)

Menentukan bahwa dependensi harus berasal dari direktori tertentu pada disk lokal. Perintah ini hanya berlaku di modul root; dengan kata lain, jika modul digunakan sebagai dependensi oleh orang lain, penggantiannya sendiri akan diabaikan.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel tempat penggantian ini diterapkan.
path diperlukan
Jalur ke direktori tempat modul ini berada.

modul

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

Mendeklarasikan properti tertentu dari modul Bazel yang diwakili oleh repo Bazel saat ini. Properti ini merupakan metadata penting modul (seperti nama dan versi), atau memengaruhi perilaku modul saat ini dan turunannya.

Nama tersebut harus dipanggil paling banyak sekali. Itu dapat dihilangkan hanya jika modul ini adalah modul root (seperti pada, jika tidak akan bergantung pada modul lain).

Parameter

Parameter Deskripsi
name default-nya adalah ''
Nama modul. Dapat dihilangkan hanya jika modul ini adalah modul root (seperti pada, jika tidak akan bergantung pada modul lain). Nama modul yang valid harus: 1) hanya berisi huruf kecil (a-z), angka (0-9), titik (.), tanda hubung (-), dan garis bawah (_); 2) diawali dengan huruf kecil; 3) diakhiri dengan huruf kecil atau angka.
version default-nya adalah ''
Versi modul. Dapat dihilangkan hanya jika modul ini adalah modul root (seperti pada, jika tidak akan bergantung pada modul lain). Versi harus dalam format SemVer yang tidak terlalu ketat. Lihat dokumentasi untuk mengetahui detail selengkapnya.
compatibility_level Defaultnya adalah 0
Tingkat kompatibilitas modul; level ini harus diubah setiap kali ada perubahan besar yang tidak kompatibel. Ini pada dasarnya adalah "versi utama" modul dalam hal SemVer, kecuali bahwa modul ini tidak disematkan dalam string versi itu sendiri, tetapi ada sebagai kolom terpisah. Modul dengan tingkat kompatibilitas yang berbeda berpartisipasi dalam resolusi versi seolah-olah modul tersebut adalah modul dengan nama yang berbeda, tetapi grafik dependensi akhir tidak boleh berisi beberapa modul dengan nama yang sama tetapi dengan tingkat kompatibilitas yang berbeda (kecuali jika multiple_version_override berlaku). Lihat dokumentasi untuk detail selengkapnya.
repo_name defaultnya adalah ''
Nama repositori yang mewakili modul ini, seperti yang terlihat oleh modul itu sendiri. Secara default, nama repo adalah nama modul. Nama ini dapat ditentukan untuk memudahkan migrasi bagi project yang telah menggunakan nama repo untuk project itu sendiri yang berbeda dengan nama modulnya.
bazel_compatibility Iterasi string; defaultnya adalah []
Daftar versi bazel yang memungkinkan pengguna mendeklarasikan versi Bazel mana yang kompatibel dengan modul ini. Ini TIDAK memengaruhi resolusi dependensi, tetapi bzlmod akan menggunakan informasi ini untuk memeriksa apakah versi Bazel Anda saat ini kompatibel. Format nilai ini adalah string dari beberapa nilai batasan yang dipisahkan oleh koma. Tiga batasan didukung: <=X.X.X: Versi Bazel harus sama atau lebih lama dari X.X.X. Digunakan saat ada perubahan yang tidak kompatibel yang diketahui dalam versi yang lebih baru. >=X.X.X: Versi Bazel harus sama atau lebih baru dari X.X.X.Digunakan saat Anda bergantung pada beberapa fitur yang hanya tersedia sejak X.X.X. -X.X.X: Versi Bazel X.X.X tidak kompatibel. Digunakan saat ada bug di X.X.X yang merusak Anda, tetapi diperbaiki di versi yang lebih baru.

multiple_version_override

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

Menentukan bahwa dependensi harus tetap berasal dari registry, tetapi beberapa versinya harus diizinkan untuk berdampingan. Lihat dokumentasi untuk detail selengkapnya. Perintah ini hanya berlaku di modul root; dengan kata lain, jika modul digunakan sebagai dependensi oleh orang lain, penggantiannya sendiri akan diabaikan.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel tempat penggantian ini diterapkan.
versions Iterable string; wajib
Menentukan secara eksplisit versi yang diizinkan untuk berdampingan. Versi ini harus sudah ada dalam pra-pilihan grafik dependensi. Dependensi pada modul ini akan "diupgrade" ke versi terdekat yang diizinkan pada tingkat kompatibilitas yang sama, sedangkan dependensi yang memiliki versi yang lebih tinggi daripada versi yang diizinkan pada tingkat kompatibilitas yang sama akan menyebabkan error.
registry defaultnya adalah ''
Mengganti registry untuk modul ini; alih-alih menemukan modul ini dari daftar default registry, registry yang ditentukan seharusnya digunakan.

register_execution_platforms

None register_execution_platforms(dev_dependency=False, *platform_labels)

Menentukan platform eksekusi yang sudah ditentukan untuk didaftarkan saat modul ini dipilih. Harus berupa pola target absolut (yaitu dimulai dengan @ atau //). Lihat resolusi toolchain untuk informasi lebih lanjut.

Parameter

Parameter Deskripsi
dev_dependency defaultnya adalah False
Jika true (benar), platform eksekusi tidak akan terdaftar jika modul saat ini bukan modul root atau `--ignore_dev_dependency` diaktifkan.
platform_labels urutan string; wajib
Label platform yang akan didaftarkan.

register_toolchains

None register_toolchains(dev_dependency=False, *toolchain_labels)

Menentukan toolchain yang sudah ditetapkan untuk didaftarkan saat modul ini dipilih. Harus berupa pola target absolut (yaitu dimulai dengan @ atau //). Lihat resolusi toolchain untuk informasi lebih lanjut.

Parameter

Parameter Deskripsi
dev_dependency defaultnya adalah False
Jika true (benar), toolchain tidak akan didaftarkan jika modul saat ini bukan modul root atau `--ignore_dev_Dependency` diaktifkan.
toolchain_labels urut string; required
Label toolchain yang akan didaftarkan. Label dapat menyertakan :all, yang dalam hal ini, semua target penyedia toolchain dalam paket akan didaftarkan dalam urutan leksikografis berdasarkan nama.

single_version_override

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

Menentukan bahwa dependensi harus tetap berasal dari registry, tetapi versinya harus disematkan, atau registry-nya diganti, atau daftar patch yang diterapkan. Perintah ini hanya berlaku di modul root; dengan kata lain, jika modul digunakan sebagai dependensi oleh orang lain, penggantiannya sendiri akan diabaikan.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel tempat penggantian ini diterapkan.
version defaultnya adalah ''
Mengganti versi yang dinyatakan modul ini dalam grafik dependensi. Dengan kata lain, modul ini akan "disematkan" ke versi penggantian ini. Atribut ini dapat dihilangkan jika semua yang ingin diganti adalah registry atau patch.
registry defaultnya adalah ''
Mengganti registry untuk modul ini; alih-alih menemukan modul ini dari daftar default registry, registry yang ditentukan seharusnya digunakan.
patches Iterasi string; defaultnya adalah []
Daftar label yang mengarah ke file patch untuk diterapkan dalam modul ini. File patch harus ada di hierarki sumber project tingkat atas. Kolom tersebut diterapkan dalam urutan daftar.
patch_cmds string dapat diiterasi; defaultnya adalah []
Urutan perintah Bash yang akan diterapkan di Linux/Macos setelah patch diterapkan.
patch_strip defaultnya adalah 0
Sama dengan argumen --strip patch Unix.

use_extension

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

Menampilkan objek proxy yang merepresentasikan ekstensi modul; metodenya dapat dipanggil untuk membuat tag ekstensi modul.

Parameter

Parameter Deskripsi
extension_bzl_file diperlukan
Label ke file Starlark yang menentukan ekstensi modul.
extension_name wajib
Nama ekstensi modul yang akan digunakan. Simbol dengan nama ini harus diekspor oleh file Starlark.
dev_dependency Defaultnya adalah False
Jika true (benar), penggunaan ekstensi modul ini akan diabaikan jika modul saat ini bukan modul root atau `--ignore_dev_dependency` diaktifkan.
isolate default-nya adalah False
Eksperimental. Parameter ini bersifat eksperimental dan dapat berubah setiap saat. Jangan bergantung pada hal itu. Fitur ini dapat diaktifkan secara eksperimental dengan menetapkan ---experimental_isolated_extension_usages
Jika true (benar), penggunaan ekstensi modul ini akan diisolasi dari semua penggunaan lain, baik dalam modul ini maupun modul lainnya. Tag yang dibuat untuk penggunaan ini tidak memengaruhi penggunaan lain dan repositori yang dihasilkan oleh ekstensi untuk penggunaan ini akan berbeda dari semua repositori lain yang dibuat oleh ekstensi.

Parameter ini saat ini bersifat eksperimental dan hanya tersedia dengan flag --experimental_isolated_extension_usages.

use_repo

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

Mengimpor satu atau beberapa repositori yang dibuat oleh ekstensi modul tertentu ke dalam cakupan modul saat ini.

Parameter

Parameter Deskripsi
extension_proxy wajib
Objek proxy ekstensi modul yang ditampilkan oleh panggilan use_extension.
args wajib
Nama repositori yang akan diimpor.
kwargs wajib
Menentukan repositori tertentu yang akan diimpor ke dalam cakupan modul saat ini dengan nama yang berbeda. Kunci harus berupa nama yang akan digunakan dalam cakupan saat ini, sedangkan nilainya harus berupa nama asli yang diekspor oleh ekstensi modul.

use_repo_rule

repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)

Menampilkan nilai proxy yang dapat langsung dipanggil dalam file MODULE.bazel sebagai aturan repositori, satu atau beberapa kali. Repo yang dibuat dengan cara tersebut hanya dapat dilihat oleh modul saat ini, dengan nama yang dideklarasikan menggunakan atribut name di proxy. Atribut dev_dependency Boolean implisit juga dapat digunakan pada proxy untuk menunjukkan bahwa repo tertentu hanya akan dibuat saat modul saat ini adalah modul root.

Parameter

Parameter Deskripsi
repo_rule_bzl_file wajib
Label ke file Starlark yang menentukan aturan repo.
repo_rule_name wajib
Nama aturan repo yang akan digunakan. Simbol dengan nama ini harus diekspor oleh file Starlark.