Bazel 樣式指南和最佳做法

總覽

本指南定義 Fuchsia 平台程式碼集 中 Bazel BUILD.bazel 和 .bzl 檔案的格式、程式設計慣例和最佳做法。

Fuchsia 專案遵循公開的 Bazel《BUILD 樣式指南》和《.bzl 樣式指南》，但有幾項例外情況。此外，Fuchsia 計畫也會強制執行部分建議和最佳做法。

除了涵蓋這些例外狀況，本指南也擷取 Bazel 說明文件其他部分的建議、編纂一些最佳做法、提供與 Fuchsia 程式碼集相關路徑和符號的指引、針對熟悉 Fuchsia 程式碼集 GN 用法的開發人員，重點說明兩者的異同，並新增指引，協助確保 Fuchsia 程式碼集的一致性和可讀性。

狀態

這份文件仍在開發中。這代表 Fuchsia 平台程式碼集目前的一組常見做法和 Bazel 檔案期望。目前內容不夠完整，但會持續更新。

如要提供意見回饋或建議新增內容/其他變更，請參閱「意見回饋」。

Fuchsia 專屬樣式和最佳做法

通用樣式指南和最佳做法適用於所有 Bazel 檔案。

以下提供其他特定指引：

自動化工具

上傳以供審查前，請先使用 fx format-code 在本機格式化程式碼。

隨著時間推移，這項指南中可透過機械驗證的部分，將透過 SHAC 檢查在 static-checks CQ 機器人上強制執行。這已包含執行 buildifier。

建議先在本地執行這些檢查，再上傳並執行 fx host-tool shac check，以供審查。

程序

本文件由 Fuchsia 建構團隊擁有。

意見回饋

請與 Fuchsia Build 團隊聯絡，並/或回報錯誤。