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 建構團隊聯絡，和/或回報錯誤。