Add gazelle for bzl_library generation (#1132)

keith · web-flow · commit 02c6c1c4b33d · 2024-01-09T18:19:28.000Z
This makes it easier to keep these up to date. Also if we have conflicts
with upstream we can just ignore those changes and re-run this
afterwards
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -32,4 +32,6 @@ apple_cc_configure = use_extension("@build_bazel_apple_support//crosstool:setup.
 use_repo(apple_cc_configure, "local_config_apple_cc")
 
 # Dev dependencies
+bazel_dep(name = "bazel_skylib_gazelle_plugin", version = "1.5.0", dev_dependency = True)
+bazel_dep(name = "gazelle", version = "0.33.0", dev_dependency = True, repo_name = "bazel_gazelle")
 bazel_dep(name = "stardoc", version = "0.6.2", dev_dependency = True, repo_name = "io_bazel_stardoc")
diff --git a/WORKSPACE b/WORKSPACE
@@ -58,3 +58,20 @@ stardoc_external_deps()
 load("@stardoc_maven//:defs.bzl", stardoc_pinned_maven_install = "pinned_maven_install")
 
 stardoc_pinned_maven_install()
+
+http_archive(
+    name = "bazel_skylib_gazelle_plugin",
+    sha256 = "747addf3f508186234f6232674dd7786743efb8c68619aece5fb0cac97b8f415",
+    urls = [
+        "https://mirror.bazel.build/github.com/bazelbuild/bazel-skylib/releases/download/1.5.0/bazel-skylib-gazelle-plugin-1.5.0.tar.gz",
+        "https://github.com/bazelbuild/bazel-skylib/releases/download/1.5.0/bazel-skylib-gazelle-plugin-1.5.0.tar.gz",
+    ],
+)
+
+load("@bazel_skylib_gazelle_plugin//:workspace.bzl", "bazel_skylib_gazelle_plugin_workspace")
+
+bazel_skylib_gazelle_plugin_workspace()
+
+load("@bazel_skylib_gazelle_plugin//:setup.bzl", "bazel_skylib_gazelle_plugin_setup")
+
+bazel_skylib_gazelle_plugin_setup()
diff --git a/doc/BUILD.bazel b/doc/BUILD.bazel
@@ -1,5 +1,7 @@
-load("@bazel_skylib//rules:write_file.bzl", "write_file")
+load("@bazel_gazelle//:def.bzl", "gazelle", "gazelle_binary")
+load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
 load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
+load("@bazel_skylib//rules:write_file.bzl", "write_file")
 load("@io_bazel_stardoc//stardoc:stardoc.bzl", "stardoc")
 
 _DOC_SRCS = {
@@ -157,3 +159,25 @@ sh_binary(
     srcs = ["update.sh"],
     data = [file + ".md_" for file in _DOC_SRCS.keys() + ["setup"]],
 )
+
+gazelle(
+    name = "gazelle",
+    gazelle = ":gazelle_bin",
+    visibility = ["//visibility:private"],
+)
+
+gazelle_binary(
+    name = "gazelle_bin",
+    languages = [
+        "@bazel_skylib_gazelle_plugin//bzl",
+    ],
+    visibility = ["//visibility:private"],
+)
+
+# Have to keep since bazel doesn't propagate a bzl_library for these files
+# gazelle:ignore
+bzl_library(
+    name = "bazel_tools_bzl",
+    srcs = ["@bazel_tools//tools:bzl_srcs"],
+    visibility = ["//swift:__pkg__"],
+)
diff --git a/examples/xplatform/swift_import/BUILD b/examples/xplatform/swift_import/BUILD
@@ -1,3 +1,4 @@
+load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
 load("//swift:swift.bzl", "swift_binary", "swift_import", "swift_library")
 load(":get_swiftmodule.bzl", "get_swiftmodule")
 
@@ -31,3 +32,10 @@ swift_library(
     srcs = ["dep.swift"],
     module_name = "dep",
 )
+
+bzl_library(
+    name = "get_swiftmodule",
+    srcs = ["get_swiftmodule.bzl"],
+    visibility = ["//visibility:public"],
+    deps = ["//swift"],
+)
diff --git a/swift/BUILD b/swift/BUILD
@@ -10,16 +10,11 @@ package(default_visibility = ["//visibility:public"])
 
 licenses(["notice"])
 
-bzl_library(
-    name = "bazel_tools_bzl",
-    srcs = ["@bazel_tools//tools:bzl_srcs"],
-)
-
 bzl_library(
     name = "repositories",
     srcs = ["repositories.bzl"],
     deps = [
-        ":bazel_tools_bzl",
+        "//doc:bazel_tools_bzl",
         "//swift/internal:swift_autoconfiguration",
     ],
 )
@@ -55,7 +50,7 @@ bzl_library(
     deps = [
         ":swift_compiler_plugin",
         "//swift/internal:providers",
-        "//swift/internal:swift_binary_test",
+        "//swift/internal:swift_binary_test_rules",
         "//swift/internal:swift_c_module",
         "//swift/internal:swift_common",
         "//swift/internal:swift_feature_allowlist",
@@ -152,3 +147,18 @@ filegroup(
     name = "empty",
     visibility = ["//visibility:private"],
 )
+
+bzl_library(
+    name = "extensions",
+    srcs = ["extensions.bzl"],
+    deps = [":repositories"],
+)
+
+bzl_library(
+    name = "extras",
+    srcs = ["extras.bzl"],
+    deps = [
+        "@build_bazel_apple_support//lib:repositories",
+        "@rules_proto//proto:repositories",
+    ],
+)
diff --git a/swift/internal/BUILD b/swift/internal/BUILD
@@ -87,12 +87,6 @@ bzl_library(
     deps = ["@bazel_skylib//lib:paths"],
 )
 
-bzl_library(
-    name = "env_expansion",
-    srcs = ["env_expansion.bzl"],
-    visibility = ["//swift:__subpackages__"],
-)
-
 bzl_library(
     name = "features",
     srcs = ["features.bzl"],
@@ -124,11 +118,6 @@ bzl_library(
     deps = ["@bazel_skylib//lib:paths"],
 )
 
-bzl_library(
-    name = "package_specs",
-    srcs = ["package_specs.bzl"],
-)
-
 bzl_library(
     name = "proto_gen_utils",
     srcs = ["proto_gen_utils.bzl"],
@@ -175,24 +164,6 @@ bzl_library(
     ],
 )
 
-bzl_library(
-    name = "swift_binary_test",
-    srcs = ["swift_binary_test.bzl"],
-    visibility = ["//swift:__subpackages__"],
-    deps = [
-        ":compiling",
-        ":derived_files",
-        ":env_expansion",
-        ":feature_names",
-        ":linking",
-        ":providers",
-        ":swift_common",
-        ":utils",
-        "@bazel_skylib//lib:dicts",
-        "@bazel_skylib//lib:partial",
-    ],
-)
-
 bzl_library(
     name = "swift_clang_module_aspect",
     srcs = ["swift_clang_module_aspect.bzl"],
@@ -369,12 +340,6 @@ bzl_library(
     ],
 )
 
-bzl_library(
-    name = "transitions",
-    srcs = ["transitions.bzl"],
-    visibility = ["//swift:__subpackages__"],
-)
-
 bzl_library(
     name = "utils",
     srcs = ["utils.bzl"],
@@ -404,29 +369,6 @@ bzl_library(
     ],
 )
 
-bzl_library(
-    name = "explicit_module_map_file",
-    srcs = ["explicit_module_map_file.bzl"],
-)
-
-bzl_library(
-    name = "feature_names",
-    srcs = ["feature_names.bzl"],
-    visibility = ["//swift:__subpackages__"],
-)
-
-bzl_library(
-    name = "vfsoverlay",
-    srcs = ["vfsoverlay.bzl"],
-    visibility = ["//swift:__subpackages__"],
-)
-
-bzl_library(
-    name = "build_settings",
-    srcs = ["build_settings.bzl"],
-    deps = ["@bazel_skylib//rules:common_settings"],
-)
-
 # Indirection needed to prevent using `objc_library` outside of macOS
 alias(
     name = "swizzle_absolute_xcttestsourcelocation",
@@ -457,3 +399,69 @@ filegroup(
         "//swift:__pkg__",
     ],
 )
+
+bzl_library(
+    name = "swift_binary_test_rules",
+    srcs = ["swift_binary_test_rules.bzl"],
+    visibility = ["//swift:__subpackages__"],
+    deps = [
+        ":compiling",
+        ":derived_files",
+        ":env_expansion",
+        ":feature_names",
+        ":linking",
+        ":providers",
+        ":swift_common",
+        ":utils",
+        "@bazel_skylib//lib:dicts",
+    ],
+)
+
+bzl_library(
+    name = "build_settings",
+    srcs = ["build_settings.bzl"],
+    visibility = ["//swift:__subpackages__"],
+    deps = ["@bazel_skylib//rules:common_settings"],
+)
+
+bzl_library(
+    name = "env_expansion",
+    srcs = ["env_expansion.bzl"],
+    visibility = ["//swift:__subpackages__"],
+)
+
+bzl_library(
+    name = "explicit_module_map_file",
+    srcs = ["explicit_module_map_file.bzl"],
+    visibility = ["//swift:__subpackages__"],
+)
+
+bzl_library(
+    name = "feature_names",
+    srcs = ["feature_names.bzl"],
+    visibility = ["//swift:__subpackages__"],
+)
+
+bzl_library(
+    name = "package_specs",
+    srcs = ["package_specs.bzl"],
+    visibility = ["//swift:__subpackages__"],
+)
+
+bzl_library(
+    name = "target_triples",
+    srcs = ["target_triples.bzl"],
+    visibility = ["//swift:__subpackages__"],
+)
+
+bzl_library(
+    name = "transitions",
+    srcs = ["transitions.bzl"],
+    visibility = ["//swift:__subpackages__"],
+)
+
+bzl_library(
+    name = "vfsoverlay",
+    srcs = ["vfsoverlay.bzl"],
+    visibility = ["//swift:__subpackages__"],
+)
diff --git a/swift/internal/swift_binary_test_rules.bzl b/swift/internal/swift_binary_test_rules.bzl
diff --git a/swift/swift.bzl b/swift/swift.bzl
@@ -36,7 +36,7 @@ load(
     _SwiftUsageInfo = "SwiftUsageInfo",
 )
 load(
-    "@build_bazel_rules_swift//swift/internal:swift_binary_test.bzl",
+    "@build_bazel_rules_swift//swift/internal:swift_binary_test_rules.bzl",
     _swift_binary = "swift_binary",
     _swift_test = "swift_test",
 )
diff --git a/test/BUILD b/test/BUILD
@@ -58,17 +58,15 @@ test_suite(
     name = "all_tests",
 )
 
-bzl_library(
-    name = "starlark_tests_bzls",
-    srcs = glob(["*.bzl"]),
-    deps = [
-        "//test/fixtures:starlark_tests_bzls",
-        "//test/rules:starlark_tests_bzls",
-    ],
-)
-
 bzl_test(
     name = "swift_bzl_test",
     src = "swift_bzl_macro.bzl",
     deps = ["//swift"],
 )
+
+bzl_library(
+    name = "swift_bzl_macro",
+    srcs = ["swift_bzl_macro.bzl"],
+    visibility = ["//visibility:private"],
+    deps = ["//swift"],
+)
diff --git a/test/fixtures/BUILD b/test/fixtures/BUILD
@@ -1,13 +1,8 @@
 load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
 
-bzl_library(
-    name = "starlark_tests_bzls",
-    srcs = glob(["*.bzl"]),
-    visibility = ["//test:__pkg__"],
-)
+package(default_visibility = ["//test:__subpackages__"])
 
 bzl_library(
     name = "common",
     srcs = ["common.bzl"],
-    visibility = ["//test:__pkg__"],
 )
diff --git a/test/fixtures/linking/BUILD b/test/fixtures/linking/BUILD
@@ -1,3 +1,4 @@
+load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
 load("//swift:swift.bzl", "swift_binary", "swift_library")
 load("//test/fixtures:common.bzl", "FIXTURE_TAGS")
 load(":fake_framework.bzl", "fake_framework")
@@ -30,3 +31,9 @@ cc_binary(
     tags = FIXTURE_TAGS,
     deps = [":lib"],
 )
+
+bzl_library(
+    name = "fake_framework",
+    srcs = ["fake_framework.bzl"],
+    deps = ["@bazel_tools//tools/cpp:toolchain_utils.bzl"],
+)
diff --git a/test/rules/BUILD b/test/rules/BUILD
@@ -1,17 +1,11 @@
 load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
 
+package(default_visibility = ["//test:__subpackages__"])
+
 bzl_library(
-    name = "starlark_tests_bzls",
-    srcs = glob(["*.bzl"]),
-    visibility = [
-        "//test:__pkg__",
-    ],
-    deps = [
-        "//swift",
-        "@bazel_skylib//lib:collections",
-        "@bazel_skylib//lib:types",
-        "@bazel_skylib//lib:unittest",
-    ],
+    name = "swift_library_artifact_collector",
+    srcs = ["swift_library_artifact_collector.bzl"],
+    deps = ["@build_bazel_rules_swift//swift"],
 )
 
 exports_files(["swift_shell_runner.sh.template"])

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ load(`
`36`	`36`	`_SwiftUsageInfo = "SwiftUsageInfo",`
`37`	`37`	`)`
`38`	`38`	`load(`
`39`		`- "@build_bazel_rules_swift//swift/internal:swift_binary_test.bzl",`
	`39`	`+ "@build_bazel_rules_swift//swift/internal:swift_binary_test_rules.bzl",`
`40`	`40`	`_swift_binary = "swift_binary",`
`41`	`41`	`_swift_test = "swift_test",`
`42`	`42`	`)`