Pertanyaan Umum (FAQ)

Berikut adalah beberapa masalah dan pertanyaan umum terkait ekstensi penulisan.

Mengapa file saya tidak dihasilkan / tindakan saya tidak pernah dijalankan?

Bazel hanya menjalankan tindakan yang diperlukan untuk menghasilkan file output yang diminta.

  • Jika file yang diinginkan memiliki label, Anda dapat memintanya secara langsung: bazel build //pkg:myfile.txt

  • Jika file berada dalam grup output target, Anda mungkin harus menentukan grup output tersebut pada command line: bazel build //pkg:mytarget --output_groups=foo

  • Jika Anda ingin file dibuat secara otomatis setiap kali target Anda disebut pada command line, tambahkan file tersebut ke output default aturan dengan menampilkan penyedia DefaultInfo.

Lihat halaman Aturan untuk informasi selengkapnya.

Mengapa fungsi implementasi saya tidak dijalankan?

Bazel hanya menganalisis target yang diminta untuk build. Anda harus memberi nama target di command line atau sesuatu yang bergantung pada target.

File hilang ketika aksi atau biner saya dieksekusi

Pastikan 1) file telah didaftarkan sebagai input untuk tindakan atau biner, dan 2) skrip atau alat yang dijalankan mengakses file menggunakan jalur yang benar.

Untuk tindakan, Anda mendeklarasikan input dengan meneruskannya ke fungsi ctx.actions.* yang membuat tindakan. Jalur yang benar untuk file tersebut dapat diperoleh menggunakan File.path.

Untuk biner (output yang dapat dieksekusi yang dijalankan oleh perintah bazel run atau bazel test), Anda mendeklarasikan input dengan menyertakannya dalam runfiles. Daripada menggunakan kolom path, gunakan File.short_path, yang merupakan jalur file yang relatif terhadap direktori runfiles tempat biner dijalankan.

Bagaimana cara mengontrol file yang dibuat oleh bazel build //pkg:mytarget?

Gunakan penyedia DefaultInfo untuk menetapkan output default.

Bagaimana cara menjalankan program atau melakukan file I/O sebagai bagian dari build saya?

Alat dapat dideklarasikan sebagai target, sama seperti bagian lain dari build Anda, dan dijalankan selama fase eksekusi untuk membantu membangun target lainnya. Untuk membuat tindakan yang menjalankan alat, gunakan ctx.actions.run dan teruskan alat tersebut sebagai parameter executable.

Selama fase pemuatan dan analisis, alat tidak dapat berjalan, Anda juga tidak dapat menjalankan I/O file. Artinya, alat dan konten file (kecuali konten file BUILD dan .bzl) tidak dapat memengaruhi cara pembuatan grafik target dan tindakan.

Bagaimana jika saya perlu mengakses data terstruktur yang sama sebelum dan selama fase eksekusi?

Anda dapat memformat data terstruktur sebagai file .bzl. Anda dapat melakukan load() pada file untuk mengaksesnya selama fase pemuatan dan analisis. Anda dapat meneruskannya sebagai input atau runfile ke tindakan dan file yang dapat dieksekusi yang membutuhkannya selama fase eksekusi.

Bagaimana cara mendokumentasikan kode Starlark?

Untuk aturan dan atribut aturan, Anda dapat meneruskan literal docstring (mungkin tanda kutip tiga) ke parameter doc dari rule atau attr.*(). Untuk fungsi dan makro bantuan, gunakan literal docstring dengan tanda kutip tiga mengikuti format yang diberikan di sini. Fungsi implementasi aturan umumnya tidak memerlukan docstring sendiri.

Menggunakan literal string di tempat yang diharapkan akan mempermudah alat otomatis untuk mengekstrak dokumentasi. Jangan ragu untuk menggunakan komentar non-string standar di mana pun yang dapat membantu pembaca kode Anda.