Pemformatan file BUILD
mengikuti pendekatan yang sama dengan Go, dengan alat standar
yang menangani sebagian besar masalah pemformatan.
Buildifier adalah alat yang mengurai dan
mengeluarkan kode sumber dalam gaya standar. Oleh karena itu, setiap file BUILD
diformat dengan cara otomatis yang sama, sehingga pemformatan tidak menjadi masalah selama
peninjauan kode. Hal ini juga mempermudah alat untuk memahami, mengedit, dan
membuat file BUILD
.
Pemformatan file BUILD
harus cocok dengan output buildifier
.
Contoh pemformatan
# Test code implementing the Foo controller.
package(default_testonly = True)
py_test(
name = "foo_test",
srcs = glob(["*.py"]),
data = [
"//data/production/foo:startfoo",
"//foo",
"//third_party/java/jdk:jdk-k8",
],
flaky = True,
deps = [
":check_bar_lib",
":foo_data_check",
":pick_foo_port",
"//pyglib",
"//testing/pybase",
],
)
Struktur file
Rekomendasi: Gunakan urutan berikut (setiap elemen bersifat opsional):
Deskripsi paket (komentar)
Semua pernyataan
load()
Fungsi
package()
.Panggilan ke aturan dan makro
Buildifier membuat perbedaan antara komentar mandiri dan komentar yang dilampirkan ke elemen. Jika komentar tidak dilampirkan ke elemen tertentu, gunakan baris kosong setelahnya. Perbedaannya penting saat melakukan perubahan otomatis (misalnya, untuk menyimpan atau menghapus komentar saat menghapus aturan).
# Standalone comment (such as to make a section in a file)
# Comment for the cc_library below
cc_library(name = "cc")
Referensi ke target dalam paket saat ini
File harus dirujuk berdasarkan jalurnya yang relatif terhadap direktori paket
(tanpa pernah menggunakan referensi atas, seperti ..
). File yang dihasilkan harus
diawali dengan ":
" untuk menunjukkan bahwa file tersebut bukan sumber. File sumber
tidak boleh diawali dengan :
. Aturan harus diawali dengan :
. Misalnya,
dengan asumsi x.cc
adalah file sumber:
cc_library(
name = "lib",
srcs = ["x.cc"],
hdrs = [":gen_header"],
)
genrule(
name = "gen_header",
srcs = [],
outs = ["x.h"],
cmd = "echo 'int x();' > $@",
)
Penamaan target
Nama target harus deskriptif. Jika target berisi satu file sumber,
target umumnya harus memiliki nama yang berasal dari sumber tersebut (misalnya, cc_library
untuk chat.cc
dapat diberi nama chat
, atau java_library
untuk
DirectMessage.java
dapat diberi nama direct_message
).
Target eponymous untuk paket (target dengan nama yang sama dengan direktori yang berisi) harus menyediakan fungsi yang dijelaskan oleh nama direktori. Jika tidak ada target tersebut, jangan buat target dengan nama yang sama.
Sebaiknya gunakan nama pendek saat merujuk ke target eponymous (//x
,
bukan //x:x
). Jika Anda berada dalam paket yang sama, pilih referensi
lokal (:x
, bukan //x
).
Hindari penggunaan nama target "yang direservasi" yang memiliki arti khusus. Ini mencakup
all
, __pkg__
, dan __subpackages__
. Nama ini memiliki semantik
khusus dan dapat menyebabkan kebingungan serta perilaku yang tidak terduga saat digunakan.
Jika tidak ada konvensi tim yang berlaku, berikut beberapa rekomendasi yang tidak mengikat yang digunakan secara luas di Google:
- Secara umum, gunakan "snake_case"
- Untuk
java_library
dengan satusrc
, ini berarti menggunakan nama yang tidak sama dengan nama file tanpa ekstensi - Untuk aturan
*_binary
dan*_test
Java, gunakan "Upper CamelCase". Hal ini memungkinkan nama target cocok dengan salah satusrc
. Untukjava_test
, hal ini memungkinkan atributtest_class
diinferensi dari nama target.
- Untuk
- Jika ada beberapa varian target tertentu, tambahkan akhiran untuk
membedakan (seperti.
:foo_dev
,:foo_prod
, atau:bar_x86
,:bar_x64
) - Akhiri target
_test
dengan_test
,_unittest
,Test
, atauTests
- Hindari akhiran yang tidak bermakna seperti
_lib
atau_library
(kecuali jika diperlukan untuk menghindari konflik antara target_library
dan_binary
yang sesuai) - Untuk target terkait proto:
- Target
proto_library
harus memiliki nama yang diakhiri dengan_proto
- Aturan
*_proto_library
khusus bahasa harus cocok dengan proto yang mendasarinya, tetapi ganti_proto
dengan akhiran khusus bahasa seperti:cc_proto_library
:_cc_proto
java_proto_library
:_java_proto
java_lite_proto_library
:_java_proto_lite
- Target
Visibilitas
Visibilitas harus dicakup seketat mungkin, sambil tetap mengizinkan akses
oleh pengujian dan dependensi terbalik. Gunakan __pkg__
dan __subpackages__
sesuai
kebutuhan.
Hindari menetapkan paket default_visibility
ke //visibility:public
.
//visibility:public
harus ditetapkan satu per satu hanya untuk target di
API publik project. Library ini dapat berupa library yang didesain untuk diandalkan
oleh project eksternal atau biner yang dapat digunakan oleh proses build
project eksternal.
Dependensi
Dependensi harus dibatasi untuk dependensi langsung (dependensi yang diperlukan oleh sumber yang tercantum dalam aturan). Jangan cantumkan dependensi transitif.
Dependensi lokal paket harus dicantumkan terlebih dahulu dan dirujuk dengan cara yang kompatibel dengan bagian Referensi ke target dalam paket saat ini di atas (bukan dengan nama paket absolutnya).
Sebaiknya cantumkan dependensi secara langsung, sebagai satu daftar. Menempatkan dependensi "umum" dari beberapa target ke dalam variabel akan mengurangi kemudahan pemeliharaan, membuat alat tidak dapat mengubah dependensi target, dan dapat menyebabkan dependensi yang tidak digunakan.
Glob
Menunjukkan "tidak ada target" dengan []
. Jangan gunakan glob yang tidak cocok dengan apa pun: lebih rentan terhadap error dan kurang jelas daripada daftar kosong.
Rekursif
Jangan gunakan glob rekursif untuk mencocokkan file sumber (misalnya,
glob(["**/*.java"])
).
Gelombang rekursif membuat file BUILD
sulit dipahami karena melewati
subdirektori yang berisi file BUILD
.
Glob rekursif umumnya kurang efisien daripada memiliki file BUILD
per
direktori dengan grafik dependensi yang ditentukan di antara keduanya karena hal ini memungkinkan
caching dan paralelisme jarak jauh yang lebih baik.
Sebaiknya tulis file BUILD
di setiap direktori dan tentukan
grafik dependensi di antara keduanya.
Non-rekursif
Glob non-rekursif umumnya dapat diterima.
Konvensi lainnya
Gunakan huruf besar dan garis bawah untuk mendeklarasikan konstanta (seperti
GLOBAL_CONSTANT
), gunakan huruf kecil dan garis bawah untuk mendeklarasikan variabel (sepertimy_variable
).Label tidak boleh dibagi, meskipun panjangnya lebih dari 79 karakter. Label harus berupa string literal jika memungkinkan. Argumentasi: Cara ini memudahkan menemukan dan mengganti. Hal ini juga meningkatkan keterbacaan.
Nilai atribut nama harus berupa string konstanta literal (kecuali dalam makro). Alasan: Alat eksternal menggunakan atribut nama untuk merujuk aturan. Mereka perlu menemukan aturan tanpa harus menafsirkan kode.
Saat menetapkan atribut jenis boolean, gunakan nilai boolean, bukan nilai bilangan bulat. Karena alasan lama, aturan masih mengonversi bilangan bulat menjadi boolean sesuai kebutuhan, tetapi sebaiknya jangan dilakukan. Alasan:
flaky = 1
dapat dibaca salah sebagai "deflake target ini dengan menjalankannya sekali lagi".flaky = True
dengan jelas menyatakan "pengujian ini tidak stabil".
Perbedaan dengan panduan gaya Python
Meskipun kompatibilitas dengan panduan gaya Python merupakan tujuannya, ada beberapa perbedaan:
Tidak ada batas panjang baris yang ketat. Komentar panjang dan string panjang sering kali dibagi menjadi 79 kolom, tetapi hal ini tidak wajib. Hal ini tidak boleh diterapkan dalam ulasan kode atau skrip pra-pengiriman. Alasan: Label dapat panjang dan melebihi batas ini. File
BUILD
biasanya dibuat atau diedit oleh alat, yang tidak cocok dengan batas panjang baris.Penggabungan string implisit tidak didukung. Gunakan operator
+
. Alasan: FileBUILD
berisi banyak daftar string. Kita sering kali melupakan koma, yang menyebabkan hasil yang sama sekali berbeda. Hal ini telah menyebabkan banyak bug di masa lalu. Lihat juga diskusi ini.Gunakan spasi di sekitar tanda
=
untuk argumen kata kunci dalam aturan. Alasan: Argumen bernama jauh lebih sering daripada di Python dan selalu berada di baris terpisah. Spasi meningkatkan keterbacaan. Konvensi ini sudah ada sejak lama, dan tidak perlu mengubah semua fileBUILD
yang ada.Secara default, gunakan tanda petik ganda untuk string. Alasan: Hal ini tidak ditentukan dalam panduan gaya Python, tetapi merekomendasikan konsistensi. Jadi, kita memutuskan untuk hanya menggunakan string dengan tanda kutip ganda. Banyak bahasa menggunakan tanda petik ganda untuk literal string.
Gunakan satu baris kosong di antara dua definisi tingkat teratas. Alasan: Struktur file
BUILD
tidak seperti file Python pada umumnya. File ini hanya memiliki pernyataan tingkat teratas. Menggunakan satu baris kosong akan membuat fileBUILD
lebih pendek.