Add gazelle for bzl_library generation (#612)

Author: keith

.bazelci/presubmit.yml

@@ -172,4 +172,12 @@ tasks:
     bazel: latest
     <<: *windows_common_toolchain_off
 
+  gazelle_check:
+    name: "Gazelle up-to-date"
+    platform: ubuntu2204
+    bazel: latest
+    shell_commands:
+      - "bazel run //doc:gazelle"
+      - "git diff --exit-code || { echo '::error::Gazelle-generated BUILD files are out of date. Run: bazel run //doc:gazelle'; exit 1; }"
+
 buildifier: 8.5.1

BUILD

@@ -4,6 +4,11 @@ licenses(["notice"])
 
 exports_files(["LICENSE"])
 
+# gazelle:exclude test
+# gazelle:exclude tools/http_dmg/private/tests
+# gazelle:exclude crosstool
+# gazelle:exclude toolchain
+
 # An umbrella bzl_library for anything that needs it (like to then use stardoc),
 # but odds are using the specific sub bzl_library to with the public bzl files
 # are a better choice to get the proper subset of dependencies.

MODULE.bazel

@@ -19,6 +19,9 @@ register_toolchains("@local_config_apple_cc_toolchains//:all")
 xcode_configure = use_extension("//xcode:xcode_configure.bzl", "xcode_configure_extension")
 use_repo(xcode_configure, "local_config_xcode")
 
+bazel_dep(name = "bazel_skylib_gazelle_plugin", version = "1.5.0", dev_dependency = True)
+bazel_dep(name = "gazelle", version = "0.46.0", dev_dependency = True)
+bazel_dep(name = "rules_go", version = "0.59.0", dev_dependency = True)  # TODO: Remove when transitives update past this version
 bazel_dep(name = "rules_shell", version = "0.3.0", dev_dependency = True)
 bazel_dep(name = "stardoc", version = "0.8.0", dev_dependency = True)
 

build_settings/BUILD

@@ -8,7 +8,7 @@ package(
 licenses(["notice"])
 
 bzl_library(
-    name = "build_settings_bzl",
+    name = "build_settings",
     srcs = ["build_settings.bzl"],
     deps = ["@bazel_skylib//rules:common_settings"],
 )

configs/BUILD

@@ -10,7 +10,7 @@ selects.config_setting_group(
         cpu
         for cpu in APPLE_PLATFORMS_CONSTRAINTS.keys()
     ] + [
-        "@apple_support//constraints:apple",
+        "//constraints:apple",
     ],
 )
 
@@ -35,5 +35,4 @@ selects.config_setting_group(
 bzl_library(
     name = "platforms",
     srcs = ["platforms.bzl"],
-    visibility = ["//visibility:public"],
 )

doc/BUILD

@@ -1,5 +1,6 @@
 load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
 load("@bazel_skylib//rules:write_file.bzl", "write_file")
+load("@gazelle//:def.bzl", "gazelle", "gazelle_binary")
 load("@rules_shell//shell:sh_binary.bzl", "sh_binary")
 load("@stardoc//stardoc:stardoc.bzl", "stardoc")
 
@@ -64,7 +65,7 @@ _DOC_SRCS = {
         symbol_names = symbols,
         tags = ["no-sandbox"],  # https://github.com/bazelbuild/stardoc/issues/112
         deps = [
-            "//rules",
+            "//rules:rules.doc",
             "//xcode:providers",
         ],
     )
@@ -113,3 +114,17 @@ sh_binary(
     srcs = ["update.sh"],
     data = [file + ".md_" for file in _DOC_SRCS.keys()],
 )
+
+gazelle(
+    name = "gazelle",
+    gazelle = ":gazelle_bin",
+    visibility = ["//visibility:private"],
+)
+
+gazelle_binary(
+    name = "gazelle_bin",
+    languages = [
+        "@bazel_skylib_gazelle_plugin//bzl",
+    ],
+    visibility = ["//visibility:private"],
+)

lib/BUILD

@@ -49,11 +49,6 @@ bzl_library(
     ],
 )
 
-bzl_library(
-    name = "missing_platform_fallback_users",
-    srcs = ["missing_platform_fallback_users.bzl"],
-)
-
 bzl_library(
     name = "lipo",
     srcs = ["lipo.bzl"],
@@ -63,14 +58,18 @@ bzl_library(
     ],
 )
 
-bzl_library(
-    name = "transitions",
-    srcs = ["transitions.bzl"],
-)
-
-# Public bzl_library for anything that needs to depend on xcode_support.bzl.
 bzl_library(
     name = "xcode_support",
     srcs = ["xcode_support.bzl"],
     deps = ["//xcode:providers"],
 )
+
+bzl_library(
+    name = "missing_platform_fallback_users",
+    srcs = ["missing_platform_fallback_users.bzl"],
+)
+
+bzl_library(
+    name = "transitions",
+    srcs = ["transitions.bzl"],
+)

lib/private/BUILD

@@ -2,15 +2,9 @@ load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
 
 licenses(["notice"])
 
-package(
-    default_visibility = ["//lib:__subpackages__"],
-)
+package(default_visibility = ["//:__subpackages__"])
 
 bzl_library(
     name = "providers",
     srcs = ["providers.bzl"],
-    visibility = [
-        "//lib:__subpackages__",
-        "//test:__pkg__",
-    ],
 )

rules/BUILD

@@ -17,11 +17,6 @@ bzl_library(
     ],
 )
 
-bzl_library(
-    name = "toolchain_substitution",
-    srcs = ["toolchain_substitution.bzl"],
-)
-
 bzl_library(
     name = "universal_binary",
     srcs = ["universal_binary.bzl"],
@@ -33,11 +28,16 @@ bzl_library(
 )
 
 bzl_library(
-    name = "rules",
+    name = "rules.doc",
     srcs = ["rules.doc.bzl"],
     deps = [
         ":toolchain_substitution",
         ":universal_binary",
         "//rules/private:apple_genrule",
     ],
 )
+
+bzl_library(
+    name = "toolchain_substitution",
+    srcs = ["toolchain_substitution.bzl"],
+)

tools/http_dmg/BUILD.bazel

@@ -1,15 +1,10 @@
 load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
 
-bzl_library(
-    name = "bazel_tools_bzl",
-    srcs = ["@bazel_tools//tools:bzl_srcs"],
-)
-
 bzl_library(
     name = "http_dmg",
     srcs = ["http_dmg.bzl"],
     visibility = ["//visibility:public"],
     deps = [
-        ":bazel_tools_bzl",
+        "@bazel_tools//tools/build_defs/repo:utils.bzl",
     ],
 )