Guia de estilo do build

Informar um problema Ver a fonte Nightly · 8.0 · 7.4 · 7.3 · 7.2 · 7.1 · 7.0  · 6.5

A formatação de arquivos BUILD segue a mesma abordagem do Go, em que uma ferramenta padronizada cuida da maioria dos problemas de formatação. O Buildifier é uma ferramenta que analisa e emite o código-fonte em um estilo padrão. Portanto, todos os arquivos BUILD são formatados da mesma forma automatizada, o que torna a formatação irrelevante durante as revisões de código. Isso também facilita a compreensão, edição e geração de arquivos BUILD por ferramentas.

A formatação do arquivo BUILD precisa corresponder à saída de buildifier.

Exemplo de formatação

# 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",
    ],
)

Estrutura do arquivo

Recomendação: use a seguinte ordem (cada elemento é opcional):

  • Descrição do pacote (um comentário)

  • Todas as instruções load()

  • A função package().

  • Chamadas para regras e macros

O Buildifier faz uma distinção entre um comentário independente e um comentário anexado a um elemento. Se um comentário não estiver anexado a um elemento específico, use uma linha vazia depois dele. A distinção é importante ao fazer mudanças automáticas, por exemplo, para manter ou remover um comentário ao excluir uma regra.

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

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

Referências a destinos no pacote atual

Os arquivos precisam ser referenciados pelos caminhos relativos ao diretório do pacote (sem usar referências ascendentes, como ..). Os arquivos gerados precisam ter o prefixo ":" para indicar que não são origens. Os arquivos de origem não devem ter o prefixo :. As regras precisam ter o prefixo :. Por exemplo, supondo que x.cc seja um arquivo de origem:

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

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

Nomeação de destino

Os nomes de destino precisam ser descritivos. Se um destino tiver um arquivo de origem, ele geralmente terá um nome derivado dessa origem. Por exemplo, um cc_library para chat.cc pode ser chamado de chat, ou um java_library para DirectMessage.java pode ser chamado de direct_message.

O destino homônimo de um pacote (o destino com o mesmo nome do diretório que o contém) precisa fornecer a funcionalidade descrita pelo nome do diretório. Se não houver esse destino, não crie um destino com o mesmo nome.

Prefira usar o nome curto ao se referir a um destino homônimo (//x em vez de //x:x). Se você estiver no mesmo pacote, prefira a referência local (:x em vez de //x).

Evite usar nomes de destino "reservados" que tenham um significado especial. Isso inclui all, __pkg__ e __subpackages__. Esses nomes têm semântica especial e podem causar confusão e comportamentos inesperados quando usados.

Na ausência de uma convenção de equipe predominante, estas são algumas recomendações não vinculativas usadas amplamente no Google:

  • Em geral, use "snake_case"
    • Para um java_library com um src, isso significa usar um nome que não seja o mesmo que o nome do arquivo sem a extensão.
    • Para regras *_binary e *_test do Java, use "Upper CamelCase". Isso permite que o nome de destino corresponda a um dos srcs. Para java_test, isso permite que o atributo test_class seja inferido do nome do destino.
  • Se houver várias variantes de um destino específico, adicione um sufixo para eliminar a ambiguidade (por exemplo, :foo_dev, :foo_prod ou :bar_x86, :bar_x64)
  • Sufixo _test com _test, _unittest, Test ou Tests
  • Evite sufixos sem sentido, como _lib ou _library, a menos que seja necessário evitar conflitos entre um destino _library e o _binary correspondente.
  • Para metas relacionadas a proto:
    • Os destinos proto_library precisam ter nomes que terminam em _proto
    • As regras *_proto_library específicas de idiomas precisam corresponder ao proto subjacente, mas substituem _proto por um sufixo específico de idioma, como:
      • cc_proto_library: _cc_proto
      • java_proto_library: _java_proto
      • java_lite_proto_library: _java_proto_lite

Visibilidade

A visibilidade precisa ser restrita o máximo possível, mas permitindo o acesso por testes e dependências reversas. Use __pkg__ e __subpackages__ conforme necessário.

Evite definir o pacote default_visibility como //visibility:public. O //visibility:public precisa ser definido individualmente apenas para destinos na API pública do projeto. Elas podem ser bibliotecas projetadas para serem dependentes de projetos externos ou binários que podem ser usados pelo processo de build de um projeto externo.

Dependências

As dependências precisam ser restritas a dependências diretas (dependências necessárias pelas fontes listadas na regra). Não liste dependências transitivas.

As dependências locais do pacote precisam ser listadas primeiro e referenciadas de uma forma compatível com a seção Referências a destinos no pacote atual acima (não pelo nome absoluto do pacote).

Prefira listar as dependências diretamente, como uma única lista. Colocar as dependências "comuns" de várias metas em uma variável reduz a capacidade de manutenção, impossibilita que as ferramentas mudem as dependências de uma meta e pode levar a dependências não utilizadas.

Globs

Indique "sem destinos" com []. Não use um glob que não corresponde a nada: ele é mais propenso a erros e menos óbvio do que uma lista vazia.

Recursivo

Não use globs recursivos para corresponder a arquivos de origem (por exemplo, glob(["**/*.java"])).

Os globs recursivos dificultam a análise de arquivos BUILD porque pulam subdiretórios que contêm arquivos BUILD.

Os globs recursivos geralmente são menos eficientes do que ter um arquivo BUILD por diretório com um gráfico de dependência definido entre eles, já que isso permite um melhor armazenamento em cache remoto e paralelismo.

É uma boa prática criar um arquivo BUILD em cada diretório e definir um gráfico de dependência entre eles.

Não recursivo

Globais não recursivos geralmente são aceitáveis.

Outras convenções

  • Use letras maiúsculas e sublinhados para declarar constantes (como GLOBAL_CONSTANT) e letras minúsculas e sublinhados para declarar variáveis (como my_variable).

  • Os rótulos nunca devem ser divididos, mesmo que tenham mais de 79 caracteres. Os rótulos precisam ser literais de string sempre que possível. Rationale: facilita a pesquisa e a substituição. Isso também melhora a legibilidade.

  • O valor do atributo name precisa ser uma string de constante literal, exceto em macros. Rationale: as ferramentas externas usam o atributo de nome para se referir a uma regra. Eles precisam encontrar regras sem precisar interpretar o código.

  • Ao definir atributos do tipo booleano, use valores booleanos, não valores inteiros. Por motivos legadas, as regras ainda convertem números inteiros em booleanos conforme necessário, mas isso não é recomendado. Rationale: flaky = 1 pode ser interpretado incorretamente como "deflake this target by rerunning it once". flaky = True diz de forma inequívoca "este teste é instável".

Diferenças em relação ao guia de estilo do Python

Embora a compatibilidade com o guia de estilo do Python seja uma meta, há algumas diferenças:

  • Não há limite de comprimento de linha rígido. Comentários e strings longos geralmente são divididos em 79 colunas, mas isso não é obrigatório. Ele não deve ser aplicado em análises de código ou scripts de pré-envio. Rationale: os rótulos podem ser longos e exceder esse limite. É comum que os arquivos BUILD sejam gerados ou editados por ferramentas, o que não combina com um limite de comprimento de linha.

  • Não há suporte para concatenação de strings implícitas. Use o operador +. Rationale: os arquivos BUILD contêm muitas listas de strings. É fácil esquecer uma vírgula, o que leva a um resultado completamente diferente. Isso criou muitos bugs no passado. Confira também esta discussão.

  • Use espaços em torno do sinal = para argumentos de palavras-chave nas regras. Rationale: os argumentos nomeados são muito mais frequentes do que em Python e sempre estão em uma linha separada. Os espaços melhoram a legibilidade. Essa convenção existe há muito tempo, e não vale a pena modificar todos os arquivos BUILD existentes.

  • Por padrão, use aspas duplas para strings. Rationale: isso não é especificado no guia de estilo do Python, mas recomenda consistência. Então, decidimos usar apenas strings com aspas duplas. Muitas linguagens usam aspas duplas para literais de string.

  • Use uma única linha em branco entre duas definições de nível superior. Rationale: a estrutura de um arquivo BUILD não é como um arquivo Python típico. Ele tem apenas instruções de nível superior. Usar uma única linha em branco encurta os arquivos BUILD.