Guía de estilo de BUILD

El formato de archivos 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, todos los archivos BUILD se formatean de la misma manera 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)

• Todas las sentencias load()

• La función package()

• Llamadas a reglas y macros

Buildifier distingue 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. Esta distinción es importante cuando se realizan cambios automatizados (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 nunca referencias superiores, como ..). Los archivos generados deben tener el prefijo ":" para indicar que no son fuentes. Los archivos fuente no deben tener el prefijo :. Las reglas deben tener el prefijo :. Por ejemplo, supongamos que x.cc es un archivo fuente:

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 objetivos deben ser descriptivos. Si un destino contiene un archivo fuente, generalmente 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 destino, no crees un destino epónimo.

Prefiere usar 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__, nombres que tienen una semántica especial y pueden causar confusión y comportamientos inesperados cuando se usan.

En 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".
  • En el caso de 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 de Java *_binary y *_test, usa "Upper CamelCase". Esto permite que el nombre del 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 diferenciarlas (por ejemplo, :foo_dev, :foo_prod o :bar_x86, :bar_x64)
• Sufijo _test segmentado con _test, _unittest, Test o Tests
• Evita los sufijos sin significado, como _lib o _library (a menos que sea necesario para evitar conflictos entre un objetivo _library y su _binary correspondiente).
• Para los destinos relacionados con .proto:
  • Los destinos proto_library deben tener nombres que terminen en _proto
  • Las reglas específicas de *_proto_library deben coincidir con el proto subyacente, pero reemplazar _proto por un sufijo específico del idioma, como el siguiente:
    • 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 limitado posible, pero debe permitir el acceso de las pruebas y las dependencias inversas. Usa __pkg__ y __subpackages__ según corresponda.

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

Dependencias

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

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

Es preferible enumerar las dependencias directamente, como una sola lista. Colocar las dependencias "comunes" de varios destinos en una variable reduce la capacidad de mantenimiento, imposibilita que las herramientas cambien las dependencias de un destino y puede generar dependencias no utilizadas.

Globs

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

Recursivo

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

Los globs recursivos dificultan la comprensión de los archivos BUILD porque omiten los subdirectorios que contienen archivos BUILD.

En 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é remoto y paralelismo.

Es una buena práctica 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 minúsculas y guiones bajos para declarar variables (como my_variable).

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

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

• Cuando configures atributos de tipo booleano, usa valores booleanos, no valores enteros. Por motivos heredados, las reglas aún convierten números enteros en booleanos según sea necesario, pero esto no se recomienda. Justificación: flaky = 1 se podría interpretar de forma incorrecta como "corrige este destino volviéndolo a ejecutar una vez". flaky = True indica de forma inequívoca que "esta prueba es inestable".

Diferencias con la guía de estilo de Python

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

• No hay un límite estricto para la longitud de la línea. Los comentarios y las cadenas largos suelen dividirse en 79 columnas, pero no es obligatorio. No se debe aplicar en las revisiones de código ni en las secuencias de comandos previas a la confirmación. Justificación: Las etiquetas pueden ser largas y exceder este límite. Es común que las herramientas generen o editen archivos BUILD, lo que no se adapta bien a un límite de longitud de línea.

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

• Usa espacios alrededor del signo = para los argumentos de palabras clave en las reglas. Justificación: Los argumentos con nombre 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 desde 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 la guía de estilo de Python, pero se recomienda la coherencia. Por lo tanto, decidimos usar solo cadenas entre 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. Justificación: La estructura de un archivo BUILD no es como la de un archivo de Python típico. Solo tiene instrucciones de nivel superior. Usar una sola línea en blanco hace que los archivos BUILD sean más cortos.