Guía de estilo de BUILD

open_in_newopen_in_newopen_in_new 7.3 · 7.2 · 7.1 · 7.0 · 6.5

El formato de archivo BUILD sigue el mismo enfoque que Go, en el que una herramienta estandarizada se encarga de la mayoría de los problemas de formato. Buildifier es una herramienta que analiza y emite el código fuente en un estilo estándar. Por lo tanto, cada archivo BUILD tiene el mismo formato de forma automática, lo que hace que el formato no sea un problema durante las revisiones de código. También facilita que las herramientas comprendan, editen y generen archivos BUILD.

El formato del archivo BUILD debe coincidir con el resultado de buildifier.

Ejemplo de formato

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

Estructura de archivos

Recomendación: Usa el siguiente orden (todos los elementos son opcionales):

• Descripción del paquete (un comentario)

• Todos los estados de cuenta load()

• La función package()

• Llamadas a reglas y macros

Buildifier hace una distinción entre un comentario independiente y un comentario adjunto a un elemento. Si un comentario no está adjunto a un elemento específico, usa una línea vacía después de él. La distinción es importante cuando se realizan cambios automáticos (por ejemplo, para conservar o quitar un comentario cuando se borra una regla).

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

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

Referencias a destinos en el paquete actual

Se debe hacer referencia a los archivos por sus rutas de acceso relativas al directorio del paquete (sin usar referencias ascendentes, como ..). Los archivos generados deben tener el prefijo ":" para indicar que no son fuentes. Los archivos de origen no deben tener el prefijo :. Las reglas deben tener el prefijo :. Por ejemplo, supongamos que x.cc es un archivo de origen:

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

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

Nombres de los destinos

Los nombres de los destinos deben ser descriptivos. Si un destino contiene un archivo fuente, por lo general, debe tener un nombre derivado de esa fuente (por ejemplo, un cc_library para chat.cc podría llamarse chat, o un java_library para DirectMessage.java podría llamarse direct_message).

El destino epónimo de un paquete (el destino con el mismo nombre que el directorio que lo contiene) debe proporcionar la funcionalidad que describe el nombre del directorio. Si no existe ese objetivo, no crees uno con el mismo nombre.

Usa el nombre corto cuando te refieras a un destino epónimo (//x en lugar de //x:x). Si estás en el mismo paquete, prefiere la referencia local (:x en lugar de //x).

Evita usar nombres de destino "reservados" que tengan un significado especial. Esto incluye all, __pkg__ y __subpackages__, que tienen semántica especial y pueden causar confusión y comportamientos inesperados cuando se usan.

Ante la ausencia de una convención de equipo predominante, estas son algunas recomendaciones no vinculantes que se usan ampliamente en Google:

• En general, usa "snake_case".
  • Para un java_library con un src, esto significa usar un nombre que no sea el mismo que el nombre de archivo sin la extensión.
  • Para las reglas *_binary y *_test de Java, usa "CamelCase mayúscula". Esto permite que el nombre de destino coincida con uno de los src. En el caso de java_test, esto permite que el atributo test_class se infiera a partir del nombre del destino.
• Si hay varias variantes de un objetivo en particular, agrega un sufijo para aclararlo (como :foo_dev, :foo_prod o :bar_x86, :bar_x64)
• Sufija los objetivos _test con _test, _unittest, Test o Tests
• Evita sufijos sin sentido, como _lib o _library (a menos que sea necesario para evitar conflictos entre un objetivo _library y su _binary correspondiente).
• Para los objetivos relacionados con protos, haz lo siguiente:
  • Los destinos de proto_library deben tener nombres que terminen en _proto.
  • Las reglas *_proto_library específicas de los idiomas deben coincidir con el proto subyacente, pero reemplazar _proto por un sufijo específico del idioma, como los siguientes:
    • cc_proto_library: _cc_proto
    • java_proto_library: _java_proto
    • java_lite_proto_library: _java_proto_lite

Visibilidad

La visibilidad debe tener el alcance más estricto posible, a la vez que permite el acceso a través de pruebas y dependencias inversas. Usa __pkg__ y __subpackages__ según corresponda.

Evita configurar el paquete default_visibility en //visibility:public. //visibility:public debe configurarse de forma individual solo para los destinos de la API pública del proyecto. Estas pueden ser bibliotecas diseñadas para que dependan de proyectos externos o binarios que podría usar el proceso de compilación de un proyecto externo.

Dependencias

Las dependencias deben restringirse a dependencias directas (dependencias que necesitan las fuentes que se enumeran en la regla). No incluyas dependencias transitivas.

Las dependencias locales del paquete deben aparecer primero y deben mencionarse de una manera compatible con la sección Referencias a destinos en el paquete actual anterior (no por su nombre de paquete absoluto).

Prefieres enumerar las dependencias directamente, como una sola lista. Poner las dependencias "comunes" de varios destinos en una variable reduce la capacidad de mantenimiento, hace que sea imposible que las herramientas cambien las dependencias de un destino y puede generar dependencias que no se usen.

Globs

Indica "sin objetivos" con []. No uses un glob que no coincida con nada: es más propenso a errores y menos obvio que una lista vacía.

Recurrente

No uses globs recursivos para hacer coincidir archivos de origen (por ejemplo, glob(["**/*.java"])).

Los globs recursivos dificultan el razonamiento sobre los archivos BUILD porque omiten los subdirectorios que contienen archivos BUILD.

Por lo general, los globs recursivos son menos eficientes que tener un archivo BUILD por directorio con un gráfico de dependencias definido entre ellos, ya que esto permite un mejor almacenamiento en caché y paralelismo remotos.

Una práctica recomendada es crear un archivo BUILD en cada directorio y definir un gráfico de dependencias entre ellos.

No recursiva

Por lo general, se aceptan los globs no recursivos.

Otras convenciones

• Usa mayúsculas y guiones bajos para declarar constantes (como GLOBAL_CONSTANT) y usa minúsculas y guiones bajos para declarar variables (como my_variable).

• Las etiquetas nunca deben dividirse, incluso si tienen más de 79 caracteres. Las etiquetas deben ser literales de cadena siempre que sea posible. Justificación: Facilita la búsqueda y el reemplazo. También mejora la legibilidad.

• El valor del atributo name debe ser una cadena constante literal (excepto en macros). Motivación: Las herramientas externas usan el atributo name para hacer referencia a una regla. Deben encontrar reglas sin tener que interpretar el código.

• Cuando configures atributos de tipo booleano, usa valores booleanos, no valores enteros. Por motivos heredados, las reglas siguen convirtiendo números enteros en booleanos según sea necesario, pero no es recomendable. Motivación: flaky = 1 podría malinterpretarse como “quita las astillas de este objetivo reejecutándolo una vez”. flaky = True dice de forma inequívoca que “esta prueba es inestable”.

Diferencias con la guía de estilo de Python

Si bien la compatibilidad con el guía de estilo de Python es un objetivo, existen algunas diferencias:

• No hay un límite estricto de longitud de línea. Los comentarios y las cadenas largas suelen dividirse en 79 columnas, pero no es obligatorio. No debe aplicarse en revisiones de código ni secuencias de comandos del envío previo. Motivo: Las etiquetas pueden ser largas y exceder este límite. Es común que las herramientas generen o editen archivos BUILD, lo que no funciona bien con un límite de longitud de línea.

• No se admite la concatenación de cadenas implícitas. Usa el operador +. Razón: Los archivos BUILD contienen muchas listas de cadenas. Es fácil olvidar una coma, lo que lleva a un resultado completamente diferente. Esto generó muchos errores en el pasado. Consulta también este debate.

• Usa espacios alrededor del signo = para los argumentos de palabras clave en las reglas. Motivación: Los argumentos nombrados son mucho más frecuentes que en Python y siempre se encuentran en una línea separada. Los espacios mejoran la legibilidad. Esta convención existe hace mucho tiempo y no vale la pena modificar todos los archivos BUILD existentes.

• De forma predeterminada, usa comillas dobles para las cadenas. Justificación: Esto no se especifica en el guía de estilo de Python, pero se recomienda la coherencia. Por lo tanto, decidimos usar solo cadenas con comillas dobles. Muchos lenguajes usan comillas dobles para los literales de cadena.

• Usa una sola línea en blanco entre dos definiciones de nivel superior. Razón: La estructura de un archivo BUILD no es como un archivo típico de Python. Solo tiene instrucciones de nivel superior. Si usas una sola línea en blanco, los archivos BUILD serán más cortos.