Label

Label adalah ID untuk target. Label standar dalam bentuk kanonis lengkap terlihat seperti berikut:

@@myrepo//my/app/main:app_binary

Bagian pertama label adalah nama repositori, @@myrepo. Sintaksis @ ganda menandakan bahwa ini adalah nama repo kanonis, yang unik dalam ruang kerja. Label dengan nama repo kanonis secara jelas mengidentifikasi target, apa pun konteksnya.

Nama repo kanonis sering kali berupa string rahasia yang terlihat seperti @@rules_java++toolchains+local_jdk. Yang jauh lebih umum terlihat adalah label dengan nama repo tampak, yang terlihat seperti:

@myrepo//my/app/main:app_binary

Satu-satunya perbedaan adalah nama repo yang diawali dengan satu @, bukan dua. Hal ini mengacu pada repo dengan nama yang tampak myrepo, yang dapat berbeda berdasarkan konteks tempat label ini muncul.

Dalam kasus umum bahwa label mengacu pada repositori yang sama dengan tempat label tersebut digunakan, bagian nama repo dapat dihilangkan. Jadi, di dalam @@myrepo, label pertama biasanya ditulis sebagai

//my/app/main:app_binary

Bagian kedua label adalah nama paket yang tidak memenuhi syarat my/app/main, jalur ke paket relatif terhadap root repositori. Bersama-sama, nama repositori dan nama paket yang tidak memenuhi syarat membentuk nama paket yang sepenuhnya memenuhi syarat @@myrepo//my/app/main. Jika label mengacu pada paket yang sama dengan tempat label tersebut digunakan, nama paket (dan secara opsional, titik dua) dapat dihilangkan. Jadi, di dalam @@myrepo//my/app/main, label ini dapat ditulis dengan salah satu cara berikut:

app_binary
:app_binary

Secara konvensi, titik dua dihilangkan untuk file, tetapi dipertahankan untuk aturan, tetapi tidak signifikan.

Bagian label setelah titik dua, app_binary adalah nama target yang tidak memenuhi syarat. Jika cocok dengan komponen terakhir jalur paket, komponen tersebut, dan titik dua, dapat dihilangkan. Jadi, kedua label ini setara:

//my/app/lib
//my/app/lib:lib

Nama target file dalam subdirektori paket adalah jalur file relatif terhadap root paket (direktori yang berisi file BUILD). Jadi, file ini berada di subdirektori my/app/main/testdata repositori:

//my/app/main:testdata/input.txt

String seperti //my/app dan @@some_repo//my/app memiliki dua arti, bergantung pada konteks tempat string tersebut digunakan: saat Bazel mengharapkan label, string tersebut masing-masing berarti //my/app:app dan @@some_repo//my/app:app. Namun, saat Bazel mengharapkan paket (misalnya, dalam spesifikasi package_group), paket tersebut merujuk ke paket yang berisi label tersebut.

Kesalahan umum dalam file BUILD adalah menggunakan //my/app untuk merujuk ke paket, atau ke semua target dalam paket--hal ini tidak dilakukan. Ingat, hal ini setara dengan //my/app:app, sehingga memberi nama target app dalam paket my/app repositori saat ini.

Namun, penggunaan //my/app untuk merujuk ke paket dianjurkan dalam spesifikasi package_group atau dalam file .bzl, karena hal ini mengomunikasikan dengan jelas bahwa nama paket bersifat absolut dan berakar di direktori tingkat atas ruang kerja.

Label relatif tidak dapat digunakan untuk merujuk ke target dalam paket lain; ID repositori dan nama paket harus selalu ditentukan dalam kasus ini. Misalnya, jika pohon sumber berisi paket my/app dan paket my/app/testdata (setiap direktori ini memiliki file BUILD sendiri), paket yang terakhir berisi file bernama testdepot.zip. Berikut dua cara (satu salah, satu benar) untuk merujuk ke file ini dalam //my/app:BUILD:

Salah — testdata adalah paket yang berbeda, jadi Anda tidak dapat menggunakan jalur relatif

testdata/testdepot.zip

Benar — merujuk ke testdata dengan jalur lengkapnya

//my/app/testdata:testdepot.zip

Label yang dimulai dengan @@// adalah referensi ke repositori utama, yang akan tetap berfungsi meskipun dari repositori eksternal. Oleh karena itu, @@//a/b/c berbeda dengan //a/b/c saat direferensikan dari repositori eksternal. Yang pertama merujuk kembali ke repositori utama, sedangkan yang kedua mencari //a/b/c di repositori eksternal itu sendiri. Hal ini sangat relevan saat menulis aturan di repositori utama yang merujuk ke target di repositori utama, dan akan digunakan dari repositori eksternal.

Untuk mengetahui informasi tentang berbagai cara Anda dapat merujuk ke target, lihat pola target.

Spesifikasi leksikal label

Sintaksis label tidak menganjurkan penggunaan karakter meta yang memiliki arti khusus untuk shell. Hal ini membantu menghindari masalah kutipan yang tidak disengaja, dan memudahkan untuk membuat alat dan skrip yang memanipulasi label, seperti Bazel Query Language.

Detail nama target yang diizinkan ada di bawah.

Nama target — package-name:target-name

target-name adalah nama target dalam paket. Nama aturan adalah nilai atribut name dalam deklarasi aturan dalam file BUILD; nama file adalah nama jalur relatif terhadap direktori yang berisi file BUILD.

Nama target harus sepenuhnya terdiri dari karakter yang diambil dari kumpulan a–z, A–Z, 0–9, dan simbol tanda baca !%-@^_"#$&'()*-+,;<=>?[]{|}~/..

Nama file harus berupa nama jalur relatif dalam bentuk normal, yang berarti nama file tidak boleh diawali atau diakhiri dengan garis miring (misalnya, /foo dan foo/ dilarang ) dan tidak boleh berisi beberapa garis miring berturut-turut sebagai pemisah jalur (misalnya, foo//bar). Demikian pula, referensi tingkat atas (..) dan referensi direktori saat ini (./) dilarang.

Salah — Jangan gunakan .. untuk merujuk ke file dalam paket lain

Benar — Gunakan //package-name:filename

Meskipun umum menggunakan / dalam nama target file, hindari penggunaan / dalam nama aturan. Terutama saat bentuk singkat label digunakan, hal ini dapat membingungkan pembaca. Label //foo/bar/wiz selalu merupakan singkatan dari //foo/bar/wiz:wiz, meskipun tidak ada paket foo/bar/wiz; label tersebut tidak pernah merujuk ke //foo:bar/wiz, meskipun target tersebut ada.

Namun, ada beberapa situasi saat penggunaan garis miring lebih mudah, atau terkadang bahkan diperlukan. Misalnya, nama aturan tertentu harus cocok dengan file sumber utamanya, yang mungkin berada di subdirektori paket.

Nama paket — //package-name:target-name

Nama paket adalah nama direktori yang berisi file BUILD, relatif terhadap direktori tingkat atas repositori yang berisi. Contoh: my/app.

Pada tingkat teknis, Bazel menerapkan hal berikut:

• Karakter yang diizinkan dalam nama paket adalah huruf kecil a hingga z, huruf besar A hingga Z, digit 0 hingga 9, karakter ! \"#$%&'()*+,-.;<=>?@[]^_`{|} (ya, ada karakter spasi di sana!), dan tentu saja garis miring / (karena merupakan pemisah direktori).
• Nama paket tidak boleh diawali atau diakhiri dengan karakter garis miring /.
• Nama paket tidak boleh berisi substring //. Hal ini tidak akan masuk akal---apa jalur direktori yang sesuai?
• Nama paket tidak boleh berisi substring /./ atau /../ atau /.../ dll. Penerapan ini dilakukan untuk menghindari kebingungan saat menerjemahkan antara nama paket logis dan nama direktori fisik, mengingat arti semantik karakter titik dalam string jalur.

Pada tingkat praktis:

• Untuk bahasa dengan struktur direktori yang signifikan bagi sistem modulnya (misalnya, Java), penting untuk memilih nama direktori yang merupakan ID valid dalam bahasa tersebut. Misalnya, jangan dimulai dengan digit awal dan hindari karakter khusus, terutama garis bawah dan tanda hubung.
• Meskipun Bazel mendukung target dalam paket root ruang kerja (misalnya, //:foo), sebaiknya biarkan paket tersebut kosong sehingga semua paket yang bermakna memiliki nama deskriptif.

Aturan

Aturan menentukan hubungan antara input dan output, serta langkah-langkah untuk membuat output. Aturan dapat berupa salah satu dari berbagai jenis (terkadang disebut class aturan), yang menghasilkan library dan executable yang dikompilasi , executable pengujian, dan output lain yang didukung seperti yang dijelaskan dalam Ensiklopedia Build.

File BUILD mendeklarasikan target dengan memanggil aturan.

Pada contoh di bawah, kita melihat deklarasi target my_app menggunakan aturan cc_binary.

cc_binary(
    name = "my_app",
    srcs = ["my_app.cc"],
    deps = [
        "//absl/base",
        "//absl/strings",
    ],
)

Setiap pemanggilan aturan memiliki atribut name (yang harus berupa nama target yang valid), yang mendeklarasikan target dalam paket file BUILD.

Setiap aturan memiliki kumpulan atribut; atribut yang berlaku untuk aturan tertentu, serta signifikansi dan semantik setiap atribut adalah fungsi dari jenis aturan; lihat Ensiklopedia Build untuk daftar aturan dan atribut yang sesuai. Setiap atribut memiliki nama dan jenis. Beberapa jenis umum yang dapat dimiliki atribut adalah bilangan bulat, label, daftar label, string, daftar string, label output, daftar label output. Tidak semua atribut perlu ditentukan dalam setiap aturan. Dengan demikian, atribut membentuk kamus dari kunci (nama) ke nilai opsional yang diketik.

Atribut srcs yang ada di banyak aturan memiliki jenis "daftar label"; nilainya, jika ada, adalah daftar label, yang masing-masing adalah nama target yang merupakan input untuk aturan ini.

Dalam beberapa kasus, nama jenis aturan agak arbitrer, dan yang lebih menarik adalah nama file yang dihasilkan oleh aturan, dan hal ini berlaku untuk genrule. Untuk mengetahui informasi selengkapnya, lihat Aturan Umum: genrule.

Dalam kasus lain, nama tersebut signifikan: misalnya, untuk aturan *_binary dan *_test, nama aturan menentukan nama executable yang dihasilkan oleh build.

Directed acyclic graph atas target ini disebut grafik target atau grafik dependensi build, dan merupakan domain tempat alat Bazel Query beroperasi.