Format file BUILD
mengikuti pendekatan yang sama dengan Go, yang mana alat standar
akan menangani sebagian besar masalah pemformatan.
Buildifier adalah alat yang mengurai dan
memancarkan kode sumber dalam gaya standar. Oleh karena itu, setiap file BUILD
diformat dengan cara otomatis yang sama, yang membuat pemformatan menjadi bukan masalah selama peninjauan kode. Hal ini juga mempermudah alat untuk memahami, mengedit, dan
menghasilkan file BUILD
.
Pemformatan file BUILD
harus sesuai 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 membedakan 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 mempertahankan 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 oleh jalurnya yang relatif terhadap direktori paket
(tanpa harus menggunakan referensi ke 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 biasanya 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 eponim untuk paket (target dengan nama yang sama dengan direktori yang memuatnya) harus menyediakan fungsi yang dijelaskan oleh nama direktori. Jika tidak ada target tersebut, jangan buat target eponim.
Memilih menggunakan nama pendek saat merujuk ke target yang memiliki nama serupa (//x
, bukan //x:x
). Jika Anda berada dalam paket yang sama, pilihlah referensi lokal (:x
, bukan //x
).
Hindari penggunaan nama target "yang dicadangkan" yang memiliki arti khusus. Ini mencakup
all
, __pkg__
, dan __subpackages__
, nama-nama ini memiliki semantik
khusus dan dapat menyebabkan kebingungan dan perilaku yang tidak terduga saat digunakan.
Jika tidak ada konvensi tim yang berlaku, berikut beberapa rekomendasi tidak mengikat yang banyak digunakan di Google:
- Secara umum, gunakan "snake_case"
- Untuk
java_library
dengan satusrc
, artinya 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
disimpulkan dari nama target.
- Untuk
- Jika ada beberapa varian dari target tertentu, tambahkan akhiran untuk
memperjelas (misalnya,
:foo_dev
,:foo_prod
, atau:bar_x86
,:bar_x64
) - Akhiran 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:
proto_library
target 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
Visibilitas
Visibilitas harus dibatasi seketat mungkin, dengan tetap mengizinkan akses
melalui pengujian dan dependensi terbalik. Gunakan __pkg__
dan __subpackages__
sebagaimana
diperlukan.
Hindari menyetel paket default_visibility
ke //visibility:public
.
//visibility:public
harus ditetapkan satu per satu hanya untuk target di API publik project. Ini bisa berupa library yang dirancang untuk diandalkan
oleh project eksternal atau biner yang dapat digunakan oleh proses build
project eksternal.
Dependensi
Dependensi harus dibatasi ke dependensi langsung (dependensi yang diperlukan oleh sumber yang tercantum dalam aturan). Jangan mencantumkan 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).
Memilih untuk mencantumkan dependensi secara langsung sebagai satu daftar. Penerapan dependensi "common" dari beberapa target ke dalam variabel akan mengurangi pemeliharaan, sehingga tidak memungkinkan alat untuk mengubah dependensi target, dan dapat menyebabkan dependensi yang tidak digunakan.
Glob
Tunjukkan "tidak ada target" dengan []
. Jangan gunakan glob yang tidak cocok dengan glob: daftar tersebut lebih rentan terhadap error dan kurang jelas daripada daftar kosong.
Rekursif
Jangan gunakan glob rekursif agar cocok dengan file sumber (misalnya, glob(["**/*.java"])
).
glob rekursif membuat file BUILD
sulit untuk dijelaskan karena melewati
subdirektori yang berisi file BUILD
.
glob rekursif umumnya kurang efisien dibandingkan memiliki file BUILD
per direktori dengan grafik dependensi yang didefinisikan di antaranya karena hal ini memungkinkan caching dan paralelisme jarak jauh yang lebih baik.
Sebaiknya buat file BUILD
di setiap direktori dan tentukan
grafik dependensi di antara direktori tersebut.
Tidak rekursif
glob non-rekursif secara umum 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 dipisahkan, meskipun lebih dari 79 karakter. Label harus berupa literal string jika memungkinkan. Rationale: Mempermudah pencarian dan penggantian. Hal ini juga meningkatkan keterbacaan.
Nilai atribut nama harus berupa string konstanta literal (kecuali dalam makro). Rasional: Alat eksternal menggunakan atribut nama untuk merujuk aturan. Mereka harus menemukan aturan tanpa harus menafsirkan kode.
Saat menetapkan atribut jenis boolean, gunakan nilai boolean, bukan nilai bilangan bulat. Untuk alasan lama, aturan tetap mengonversi bilangan bulat menjadi boolean sesuai kebutuhan, tetapi hal ini tidak disarankan. Rasional:
flaky = 1
dapat salah dibaca dengan mengatakan "deflake target ini dengan menjalankan ulang sekali".flaky = True
tanpa ambigu mengatakan "pengujian ini tidak stabil".
Perbedaan dengan panduan gaya Python
Meskipun kompatibilitas dengan panduan gaya Python adalah sasaran, ada beberapa perbedaan:
Tidak ada batas panjang baris yang ketat. Komentar panjang dan string panjang sering kali dibagi menjadi 79 kolom, tetapi tidak wajib. Parameter ini tidak boleh diterapkan dalam peninjauan kode atau skrip pra-pengiriman. Rasional: Label bisa panjang dan melebihi batas ini. File
BUILD
biasanya dibuat atau diedit oleh alat, yang tidak mengikuti batas panjang baris.Penyambungan string implisit tidak didukung. Gunakan operator
+
. Rasional: FileBUILD
berisi banyak daftar string. Sulit untuk melupakan koma, yang menyebabkan hasil lengkap. Hal ini telah menyebabkan banyak bug di masa lalu. Lihat juga diskusi ini.Gunakan spasi di sekitar tanda
=
untuk argumen kata kunci dalam aturan. Rasional: Argumen bernama jauh lebih sering daripada di Python dan selalu berada di baris terpisah. Spasi meningkatkan keterbacaan. Konvensi ini telah ada sejak lama, dan tidak perlu mengubah semua fileBUILD
yang ada.Secara default, gunakan tanda petik ganda untuk string. Rationale: Ini tidak ditentukan dalam panduan gaya Python, tetapi merekomendasikan konsistensi. Jadi, kami memutuskan untuk hanya menggunakan string dengan tanda kutip ganda. Banyak bahasa menggunakan tanda kutip ganda untuk literal string.
Gunakan satu baris kosong antara dua definisi tingkat atas. Rationale: Struktur file
BUILD
tidak seperti file Python biasa. Laporan ini hanya memiliki pernyataan tingkat atas. Penggunaan satu baris kosong akan membuat fileBUILD
lebih pendek.