ci: enable buildifier check on ci

.github/workflows/buildifier.yaml

@@ -0,0 +1,20 @@
+name: Buildifier
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: buildifier
+        run: bazel run --enable_bzlmod //:buildifier.check

BUILD.bazel

@@ -1,6 +1,7 @@
 load("@aspect_bazel_lib_host//:defs.bzl", "host")
 load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
 load("@bazel_gazelle//:def.bzl", "DEFAULT_LANGUAGES", "gazelle", "gazelle_binary")
+load("@buildifier_prebuilt//:rules.bzl", "buildifier")
 load("//lib:write_source_files.bzl", "write_source_files")
 load("//lib:yq.bzl", "yq")
 load("//lib:diff_test.bzl", "diff_test")
@@ -33,6 +34,15 @@ gazelle(
     command = "update-repos",
 )
 
+buildifier(
+    name = "buildifier.check",
+    exclude_patterns = [
+        "./.git/*",
+    ],
+    lint_mode = "warn",
+    mode = "diff",
+)
+
 bzl_library(
     name = "internal_deps",
     srcs = ["internal_deps.bzl"],

MODULE.bazel

@@ -2,29 +2,30 @@
 
 module(
     name = "aspect_bazel_lib",
-    compatibility_level = 1,
     version = "0.0.0",
+    compatibility_level = 1,
 )
 
 # Lower-bound versions of our dependencies
 bazel_dep(name = "bazel_skylib", version = "1.4.1")
 bazel_dep(name = "platforms", version = "0.0.4")
+
 # 0.5.4 is the first version with bzlmod support
-bazel_dep(name = "stardoc", repo_name = "io_bazel_stardoc", version = "0.5.4")
+bazel_dep(name = "stardoc", version = "0.5.4", repo_name = "io_bazel_stardoc")
 
 ext = use_extension("@aspect_bazel_lib//lib:extensions.bzl", "ext")
-
-use_repo(ext, "copy_directory_toolchains", "copy_to_directory_toolchains", "jq_toolchains", "yq_toolchains", "coreutils_toolchains", "expand_template_toolchains")
+use_repo(ext, "copy_directory_toolchains", "copy_to_directory_toolchains", "coreutils_toolchains", "expand_template_toolchains", "jq_toolchains", "yq_toolchains")
 
 register_toolchains(
     "@copy_directory_toolchains//:all",
     "@copy_to_directory_toolchains//:all",
     "@jq_toolchains//:all",
     "@yq_toolchains//:all",
     "@coreutils_toolchains//:all",
-    "@expand_template_toolchains//:all"
+    "@expand_template_toolchains//:all",
 )
 
 # Development-only dependencies
 
 bazel_dep(name = "bazel_skylib_gazelle_plugin", version = "1.4.1", dev_dependency = True)
+bazel_dep(name = "buildifier_prebuilt", version = "6.0.0.1", dev_dependency = True)

WORKSPACE

@@ -46,3 +46,12 @@ go_rules_dependencies()
 go_register_toolchains(version = "1.18.3")
 
 gazelle_dependencies()
+
+# Buildifier
+load("@buildifier_prebuilt//:deps.bzl", "buildifier_prebuilt_deps")
+
+buildifier_prebuilt_deps()
+
+load("@buildifier_prebuilt//:defs.bzl", "buildifier_prebuilt_register_toolchains")
+
+buildifier_prebuilt_register_toolchains()

e2e/bzlmod_write_source_files_external/MODULE.bazel

@@ -1,17 +1,14 @@
 module(
     name = "bzlmod_write_source_files_external",
-    compatibility_level = 1,
     version = "0.0.0",
+    compatibility_level = 1,
 )
 
 bazel_dep(name = "aspect_bazel_lib", version = "0.0.0")
-
 local_path_override(
     module_name = "aspect_bazel_lib",
     path = "../..",
 )
 
 test_ext = use_extension("//:test_extension.bzl", "test_ext")
-
 use_repo(test_ext, "test")
-

e2e/copy_to_directory/MODULE.bazel

@@ -1,20 +1,16 @@
 module(
     name = "copy_to_directory",
-    compatibility_level = 1,
     version = "0.0.0",
+    compatibility_level = 1,
 )
 
 bazel_dep(name = "bazel_skylib", version = "1.1.1")
-
 bazel_dep(name = "aspect_bazel_lib", version = "0.0.0")
-
 local_path_override(
     module_name = "aspect_bazel_lib",
     path = "../..",
 )
 
 ext = use_extension("@aspect_bazel_lib//lib:extensions.bzl", "ext")
-
 ext.host()
-
 use_repo(ext, "aspect_bazel_lib_host")

e2e/coreutils/BUILD.bazel

@@ -10,22 +10,21 @@ genrule(
 
 hashes(
     name = "hash",
-    src = "test.bin"
+    src = "test.bin",
 )
 
 filegroup(
     name = "md5",
+    srcs = [":hash"],
     output_group = "md5",
-    srcs = [":hash"]
 )
 
 filegroup(
     name = "sha1",
+    srcs = [":hash"],
     output_group = "sha1",
-    srcs = [":hash"]
 )
 
-
 # This tests that the "in" file to write_source_files can be a
 # label to an external repository target when bzlmod is enabled.
 write_source_files(
@@ -34,7 +33,6 @@ write_source_files(
         "ls.txt.expected": ":ls.txt",
         "sha256.txt": ":hash",
         "sha1.txt": ":sha1",
-        "md5.txt": ":md5"
+        "md5.txt": ":md5",
     },
 )
-

e2e/coreutils/MODULE.bazel

@@ -1,15 +1,14 @@
 module(
     name = "coreutils",
-    compatibility_level = 1,
     version = "0.0.0",
+    compatibility_level = 1,
 )
 
 bazel_dep(name = "aspect_bazel_lib", version = "0.0.0")
-
 local_path_override(
     module_name = "aspect_bazel_lib",
     path = "../..",
 )
 
 ext = use_extension("@aspect_bazel_lib//lib:extensions.bzl", "ext")
-use_repo(ext, "coreutils_toolchains")
+use_repo(ext, "coreutils_toolchains")

e2e/smoke/BUILD.bazel

@@ -86,4 +86,4 @@ diff_test(
         "@aspect_bazel_lib//lib:bzlmod": "a_stamp_expected_bzlmod",
         "//conditions:default": "a_stamp_expected",
     }),
-)
+)

e2e/smoke/MODULE.bazel

@@ -1,13 +1,11 @@
 module(
     name = "smoke",
-    compatibility_level = 1,
     version = "0.0.0",
+    compatibility_level = 1,
 )
 
 bazel_dep(name = "bazel_skylib", version = "1.1.1")
-
 bazel_dep(name = "aspect_bazel_lib", version = "0.0.0")
-
 local_path_override(
     module_name = "aspect_bazel_lib",
     path = "../..",

internal_deps.bzl

@@ -53,6 +53,15 @@ def bazel_lib_internal_deps():
         ],
     )
 
+    http_archive(
+        name = "buildifier_prebuilt",
+        sha256 = "e46c16180bc49487bfd0f1ffa7345364718c57334fa0b5b67cb5f27eba10f309",
+        strip_prefix = "buildifier-prebuilt-6.1.0",
+        urls = [
+            "https://github.com/keith/buildifier-prebuilt/archive/6.1.0.tar.gz",
+        ],
+    )
+
     # Register toolchains for tests
     register_jq_toolchains()
     register_yq_toolchains()

lib/BUILD.bazel

@@ -65,20 +65,19 @@ bzl_library(
     name = "expand_make_vars",
     srcs = ["expand_make_vars.bzl"],
     deps = [
+        ":expand_template",
         "//lib/private/docs:expand_locations",
         "//lib/private/docs:expand_variables",
-        ":expand_template",
     ],
 )
 
-
 bzl_library(
     name = "expand_template",
     srcs = ["expand_template.bzl"],
     deps = [
         "//lib/private/docs:expand_locations",
-        "//lib/private/docs:expand_variables",
         "//lib/private/docs:expand_template",
+        "//lib/private/docs:expand_variables",
     ],
 )
 
@@ -273,4 +272,4 @@ bzl_library(
     name = "strings",
     srcs = ["strings.bzl"],
     deps = ["//lib/private/docs:strings"],
-)
+)

lib/expand_make_vars.bzl

@@ -6,5 +6,6 @@ load(":expand_template.bzl", _expand_template = "expand_template")
 
 expand_locations = _expand_locations
 expand_variables = _expand_variables
+
 # TODO: 2.0 remove re-export from this file.
 expand_template = _expand_template

lib/expand_template.bzl

@@ -2,4 +2,4 @@
 
 load("//lib/private:expand_template.bzl", _expand_template = "expand_template")
 
-expand_template = _expand_template
+expand_template = _expand_template

lib/extensions.bzl

@@ -4,10 +4,10 @@ load(
     "@aspect_bazel_lib//lib:repositories.bzl",
     "register_copy_directory_toolchains",
     "register_copy_to_directory_toolchains",
-    "register_jq_toolchains",
-    "register_yq_toolchains",
     "register_coreutils_toolchains",
     "register_expand_template_toolchains",
+    "register_jq_toolchains",
+    "register_yq_toolchains",
 )
 load("//lib/private:host_repo.bzl", "host_repo")
 
@@ -18,7 +18,7 @@ def _toolchain_extension(mctx):
     register_yq_toolchains(register = False)
     register_coreutils_toolchains(register = False)
     register_expand_template_toolchains(register = False)
-    
+
     create_host_repo = False
     for module in mctx.modules:
         if len(module.tags.host) > 0:

lib/private/base64.bzl

@@ -6,7 +6,7 @@ Implementation based on https://gist.github.com/trondhumbor/ce57c0c2816bb45a8fbb
 the subset of python available in Starlark.
 """
 
-load(":strings.bzl", "ord", "chr")
+load(":strings.bzl", "chr", "ord")
 
 def decode(data):
     """Decode a Base64 encoded string.
@@ -339,4 +339,4 @@ def _int_to_binary(i, digits = 8):
         fail("expected a int between 0 and 255 (inclusive)")
     if digits < 1 or digits > 8:
         fail("expected digits to be between 1 and 8 (inclusive)")
-    return INT_TO_BINARY[i][8 - digits:]
+    return INT_TO_BINARY[i][8 - digits:]

lib/private/docs/BUILD.bazel

@@ -101,8 +101,8 @@ bzl_library(
     srcs = ["//lib/private:expand_template.bzl"],
     deps = [
         ":expand_locations",
+        "//lib:stamping",
         "@bazel_skylib//lib:dicts",
-        "//lib:stamping"
     ],
 )
 
@@ -229,8 +229,8 @@ bzl_library(
     name = "base64",
     srcs = ["//lib/private:base64.bzl"],
     deps = [
-        ":strings"
-    ]
+        ":strings",
+    ],
 )
 
 bzl_library(
@@ -251,7 +251,7 @@ bzl_library(
 bzl_library(
     name = "expand_template_toolchain",
     srcs = ["//lib/private:expand_template_toolchain.bzl"],
-    deps = ["//lib:stamping"]
+    deps = ["//lib:stamping"],
 )
 
 bzl_library(