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 Build 團隊擁有。

意見回饋

請與 Fuchsia 建構團隊聯絡,和/或回報錯誤。