Guia de estilo do build

A formatação do arquivo 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. Cada arquivo BUILD, portanto, é formatado da mesma maneira automatizada, o que faz com que a formatação não seja um problema durante as revisões de código. Também torna mais fácil para as ferramentas entender, editar e gerar arquivos BUILD.

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 de load()

  • A função package().

  • Chamadas para regras e macros

O buildificador 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 alterações automatizadas (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 relacionados ao diretório do pacote (sem nunca usar referências crescentes, como ..). Os arquivos gerados precisam ser prefixados com ":" para indicar que não são origens. Os arquivos de origem não podem 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();' > $@",
)

Nomenclatura do destino

Os nomes dos destinos devem ser descritivos. Se um destino contiver um arquivo de origem, ele geralmente terá um nome derivado dessa origem. Por exemplo, um cc_library para chat.cc pode ser nomeado como 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 com o mesmo objetivo.

Prefira usar o nome curto ao se referir a um destino de mesmo nome (//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ânticas especiais 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 que são amplamente usadas no Google:

  • Em geral, use "snake_case"
    • Para um java_library com um src, isso significa usar um nome diferente do nome do arquivo sem a extensão.
    • Para as regras *_binary e *_test do Java, use "CaelCase maiúsculas". Isso permite que o nome do destino corresponda a um dos srcs. Para java_test, isso possibilita que o atributo test_class seja inferido do nome do destino.
  • Se houver diversas variantes de um destino específico, adicione um sufixo para desambiguar (como :foo_dev, :foo_prod ou :bar_x86, :bar_x64)
  • Destinos de sufixo _test com _test, _unittest, Test ou Tests
  • Evite sufixos sem sentido, como _lib ou _library, a menos que seja necessário para evitar conflitos entre um destino _library e o _binary correspondente
  • Para destinos relacionados a proto:
    • proto_library destinos precisam ter nomes que terminam em _proto
    • As regras *_proto_library específicas de linguagens precisam corresponder ao proto subjacente, mas substituem _proto por um sufixo específico da linguagem, como:
      • cc_proto_library: _cc_proto
      • java_proto_library: _java_proto
      • java_lite_proto_library: _java_proto_lite

Visibilidade

A visibilidade precisa ter o escopo mais definido possível, permitindo o acesso por testes e dependências reversas. Use __pkg__ e __subpackages__ conforme adequado.

Evite definir o pacote default_visibility como //visibility:public. //visibility:public precisa ser definido individualmente apenas para destinos na API pública do projeto. Podem ser bibliotecas criadas para depender de projetos externos ou binários que podem ser usados pelo processo de compilação de um projeto externo.

Dependências

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

As dependências de pacote local precisam ser listadas primeiro e referenciadas de maneira 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ários destinos em uma variável reduz a manutenção, impossibilita que as ferramentas alterem as dependências de um destino e pode levar a dependências não utilizadas.

Globs

Indique "sem segmentações" com []. Não use um glob que não corresponda a nada, porque é 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 tornam os arquivos BUILD difíceis de considerar porque ignoram 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, porque isso permite melhor armazenamento em cache remoto e paralelismo.

É recomendável criar um arquivo BUILD em cada diretório e definir um gráfico de dependência entre eles.

Não recursiva

Em geral, globs não recursivos são aceitáveis.

Outras convenções

  • Use letras maiúsculas e sublinhados para declarar constantes (como GLOBAL_CONSTANT), use 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. Justificativa: isso facilita a localização e substituição. Isso também melhora a legibilidade.

  • O valor do atributo de nome precisa ser uma string constante literal (exceto em macros). Lógica: as ferramentas externas usam o atributo "name" para se referir a uma regra. Eles precisam encontrar regras sem ter que interpretar o código.

  • Ao definir atributos do tipo booleano, use valores booleanos em vez de números inteiros. Por motivos legados, as regras ainda convertem números inteiros em booleanos conforme necessário, mas isso não é recomendado. Lógica: flaky = 1 pode ser interpretado incorretamente como algo que diz "desafiar esse destino ao executá-lo novamente uma vez". flaky = True diz inequivocamente: "este teste é instável".

Diferenças com o guia de estilo do Python

Embora a compatibilidade com o guia de estilo do Python seja um objetivo, existem algumas diferenças:

  • Não há um limite rígido de comprimento de linha. Comentários e strings longas geralmente são divididos em 79 colunas, mas isso não é obrigatório. Ela não deve ser aplicada em revisões de código ou scripts de pré-envio. Lógica: os rótulos podem ser longos e exceder esse limite. É comum que arquivos BUILD sejam gerados ou editados por ferramentas, o que não funciona bem com um limite de comprimento de linha.

  • A concatenação implícita de strings não é compatível. Use o operador +. Lógica: os arquivos BUILD contêm muitas listas de strings. É fácil esquecer uma vírgula, o que leva a um resultado completamente diferente. Isso já criou muitos bugs no passado. Confira também esta discussão.

  • Use espaços ao redor do sinal = para argumentos de palavra-chave nas regras. Lógica: os argumentos nomeados são muito mais frequentes do que no Python e estão sempre 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 as strings. Lógica: isso não está especificado no guia de estilo do Python, mas recomenda consistência. Por isso, decidimos usar apenas strings entre 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. Lógica: a estrutura de um arquivo BUILD não é como um arquivo Python típico. Ele tem apenas declarações de nível superior. Usar uma única linha em branco torna os arquivos BUILD mais curtos.