Build スタイルガイド

7.3 · 7.2 · 7.1 · 7.0 · 6.5

BUILD ファイルのフォーマットは Go と同じアプローチに従います。標準化されたツールがほとんどのフォーマットの問題に対応します。Buildifier は、標準的なスタイルでソースコードを解析して出力するツールです。したがって、すべての BUILD ファイルは同じ自動化された方法でフォーマットされるため、コードレビュー中にフォーマットが問題になることはありません。また、ツールが BUILD ファイルを理解、編集、生成しやすくなります。

BUILD ファイルの形式は、buildifier の出力と一致している必要があります。

書式設定の例

# Test code implementing the Foo controller.
package(default_testonly = True)

py_test(
    name = "foo_test",
    srcs = glob(["*.py"]),
    data = [
        "//data/production/foo:startfoo",
        "//foo",
        "//third_party/java/jdk:jdk-k8",
    ],
    flaky = True,
    deps = [
        ":check_bar_lib",
        ":foo_data_check",
        ":pick_foo_port",
        "//pyglib",
        "//testing/pybase",
    ],
)

ファイル構造

おすすめの方法: 次の順序を使用します（どの要素も省略可能です）。

  • パッケージの説明（コメント）

  • すべての load() ステートメント

  • package() 関数。

  • ルールとマクロの呼び出し

Buildifier は、独立したコメントと要素に添付されたコメントを区別します。コメントが特定の要素に関連付けられていない場合は、その要素の後に空行を使用します。この区別は、自動変更を行う場合（ルールを削除するときにコメントを保持または削除する場合など）に重要です。

# Standalone comment (such as to make a section in a file)

# Comment for the cc_library below
cc_library(name = "cc")

現在のパッケージ内のターゲットへの参照

ファイルは、パッケージ ディレクトリに対する相対パスで参照する必要があります（.. などのアップ参照は使用しないでください）。生成されたファイルには、ソースではないことを示すために「:」という接頭辞を付ける必要があります。ソースファイルに : という接頭辞を付けないでください。ルールの先頭には : を付ける必要があります。たとえば、x.cc がソースファイルであるとします。

cc_library(
    name = "lib",
    srcs = ["x.cc"],
    hdrs = [":gen_header"],
)

genrule(
    name = "gen_header",
    srcs = [],
    outs = ["x.h"],
    cmd = "echo 'int x();' > $@",
)

ターゲットの命名

ターゲット名はわかりやすいものにします。ターゲットに 1 つのソースファイルがある場合、通常、ターゲットにはそのソースから派生した名前が付けられます（たとえば、chat.cc の cc_library には chat という名前、DirectMessage.java の java_library には direct_message という名前を付けることができます）。

パッケージの同名のターゲット（包含ディレクトリと同じ名前のターゲット）は、ディレクトリ名で記述された機能を提供する必要があります。そのようなターゲットがない場合、同名のターゲットを作成しないでください。

同名のターゲット（//x:x ではなく //x）を参照する場合は、略称を使用します。同じパッケージの場合は、ローカル参照（//x ではなく :x）を優先します。

特別な意味を持つ「予約済み」ターゲット名は使用しないでください。これには、all、__pkg__、__subpackages__ が含まれます。これらの名前には特別な意味があり、使用すると混乱や予期しない動作が発生する可能性があります。

チームの慣行がない場合は、Google で広く使用されている拘束力のない推奨事項を以下に示します。

  • 通常は 「snake_case」 を使用します。
    • java_library に src が 1 つある場合は、ファイル名と拡張子のない名前を使用します。
    • Java の *_binary ルールと *_test ルールの場合は、「Upper CamelCase」を使用します。これにより、ターゲット名を src のいずれかに一致させることができます。java_test の場合、これにより、ターゲットの名前から test_class 属性を推測できます。
  • 特定のターゲットに複数のバリエーションがある場合は、末尾に接尾辞を追加して区別します（例: :foo_dev、:foo_prod、または :bar_x86、:bar_x64）
  • _test ターゲットの接尾辞を _test、_unittest、Test、または Tests に変更
  • _lib や _library などの意味のない接尾辞は使用しないでください（_library ターゲットと対応する _binary の競合を回避するために必要な場合を除く）。
  • proto 関連のターゲットの場合:
    • proto_library ターゲットの名前は _proto で終わる必要があります。
    • 言語固有の *_proto_library ルールは、基盤となる proto と一致する必要がありますが、_proto は次のような言語固有の接尾辞に置き換える必要があります。
      • cc_proto_library: _cc_proto
      • java_proto_library: _java_proto
      • java_lite_proto_library: _java_proto_lite

公開設定

可視性は、テストとリバース依存関係によるアクセスを許可しながら、できるだけ狭くする必要があります。必要に応じて __pkg__ と __subpackages__ を使用します。

パッケージ default_visibility を //visibility:public に設定しないでください。//visibility:public は、プロジェクトの公開 API 内のターゲットにのみ個別に設定する必要があります。外部プロジェクトに依存するように設計されたライブラリや、外部プロジェクトのビルドプロセスで使用できるバイナリなどです。

依存関係

依存関係は、直接依存関係（ルールにリストされているソースに必要な依存関係）に制限する必要があります。推移的依存関係はリストに含めないでください。

パッケージローカルの依存関係は最初にリストし、上記の現在のパッケージ内のターゲットへの参照のセクションと互換性のある方法で参照する必要があります（絶対的なパッケージ名ではなく）。

依存関係を単一のリストとして直接リストするのが望ましい。複数のターゲットの「共通」依存関係を変数に格納すると、メンテナンス性が低下し、ツールでターゲットの依存関係を変更できなくなり、未使用の依存関係につながる可能性があります。

glob

[] で「ターゲットなし」を指定します。何も一致しないグロブは使用しないでください。空のリストよりもエラーが発生しやすく、わかりにくいためです。

Recursive

ソースファイルの照合に再帰 glob を使用しないでください（例: glob(["**/*.java"])）。

再帰 glob を使用すると、BUILD ファイルを含むサブディレクトリがスキップされるため、BUILD ファイルは推論が難しくなります。

一般に、再帰的なグロブは、ディレクトリごとに BUILD ファイルがあり、それらの間に依存関係グラフが定義されている場合よりも効率が低くなります。これは、リモート キャッシュと並列処理を改善できるためです。

各ディレクトリに BUILD ファイルを作成し、それらの間の依存関係グラフを定義することをおすすめします。

非再帰

非再帰の glob は通常使用できます。

その他の規則

  • 大文字とアンダースコアを使用して定数（GLOBAL_CONSTANT など）を宣言し、小文字とアンダースコアを使用して変数（my_variable など）を宣言します。

  • ラベルは、79 文字を超える場合でも分割しないでください。ラベルは、可能な限り文字列リテラルである必要があります。根拠: 検索と置換が容易になります。また、読みやすさも向上します。

  • name 属性の値は、リテラルの定数文字列にする必要があります（マクロを除く）。理由: 外部ツールは、name 属性を使用してルールを参照します。コードを解釈することなくルールを見つける必要があります。

  • ブール型の属性を設定する場合は、整数値ではなくブール値を使用します。以前の理由により、ルールでは引き続き必要に応じて整数をブール値に変換しますが、これは推奨されません。根拠: flaky = 1 は、「1 回再実行してこのターゲットをデフレークする」と誤解される可能性があります。flaky = True は「このテストは不安定である」と明確に示します。

Python スタイルガイドとの違い

Python スタイルガイドとの互換性が目標ですが、いくつか違いがあります。

  • 行の長さに厳格な制限はありません。長いコメントや長い文字列は 79 列に分割されることがよくありますが、必須ではありません。コードレビューや送信前スクリプトでは適用しないでください。理由: ラベルは長くなり、この上限を超える場合があります。BUILD ファイルは通常、ツールによって生成または編集されますが、これは行の長さの上限に適していません。

  • 暗黙的な文字列の連結はサポートされていません。+ 演算子を使用します。理由: BUILD ファイルには、文字列リストが多数含まれています。カンマを忘れると、まったく異なる結果になります。過去には、このことが原因で多くのバグが発生しました。こちらのディスカッションもご覧ください。

  • ルールのキーワード引数では、= 記号の前後にスペースを使用します。理論的根拠: 名前付き引数は Python よりも頻繁に使用され、常に別の行に配置されます。スペースを入れると読みやすくなります。この規則は長い間使用されており、既存の BUILD ファイルをすべて変更する価値はありません。

  • デフォルトでは、文字列に二重引用符を使用します。理由: これは Python スタイルガイドでは指定されていませんが、一貫性を保つことをおすすめします。そのため、二重引用符付きの文字列のみを使用することにしました。多くの言語では、文字列リテラルに二重引用符を使用します。

  • 2 つのトップレベルの定義の間には 1 行の空白行を使用します。理由: BUILD ファイルの構造は、一般的な Python ファイルとは異なります。トップレベルのステートメントのみがあります。1 行を空白にすると、BUILD ファイルが短くなります。