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 Build 团队联系和/或提交 bug。