Migrate to use defs.bzl instead of swiftformat.bzl. (#52)

cgrindel · web-flow · commit 9ff33a2828f8 · 2022-02-03T18:04:58.000Z
diff --git a/README.md b/README.md
@@ -118,7 +118,7 @@ In every Bazel package that contains Swift source files, add a
 
 ```python
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
+    "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",
     "swiftformat_pkg",
 )
 
diff --git a/doc/BUILD.bazel b/doc/BUILD.bazel
@@ -11,7 +11,7 @@ load(
 
 _RULES_AND_MACROS_DOC_PROVIDER = doc_providers.create(
     name = "rules_and_macros_overview",
-    stardoc_input = "//swiftformat:swiftformat.bzl",
+    stardoc_input = "//swiftformat:defs.bzl",
     symbols = [
         "swiftformat_binary",
         "swiftformat_format",
@@ -38,7 +38,7 @@ _API_SRCS = [
 _API_DOC_PROVIDERS = [
     doc_providers.create(
         name = name,
-        stardoc_input = "//swiftformat:swiftformat.bzl",
+        stardoc_input = "//swiftformat:defs.bzl",
         symbols = [name],
         deps = ["//swiftformat"],
     )
@@ -51,7 +51,7 @@ _ALL_DOC_PROVIDERS = [
     doc_providers.create(
         name = "api",
         is_stardoc = False,
-        stardoc_input = "//swiftformat:swiftformat.bzl",
+        stardoc_input = "//swiftformat:defs.bzl",
         deps = ["//swiftformat"],
     ),
 ] + _API_DOC_PROVIDERS
diff --git a/doc/integrate_with_rules_swift.md b/doc/integrate_with_rules_swift.md
@@ -43,7 +43,7 @@ The following shows a `BUILD.bazel` file that uses the
 
 ```python
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
+    "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",
     "swiftformat_library",
 )
 
@@ -74,7 +74,7 @@ Now, create a `swift_library.bzl` file with the following contents:
 
 ```python
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
+    "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",
     "swiftformat_library",
 )
 
diff --git a/examples/exclude_files/Sources/App/BUILD.bazel b/examples/exclude_files/Sources/App/BUILD.bazel
@@ -1,5 +1,5 @@
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
+    "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",
     "swiftformat_binary",
 )
 
diff --git a/examples/exclude_files/Sources/Foo/BUILD.bazel b/examples/exclude_files/Sources/Foo/BUILD.bazel
@@ -1,5 +1,5 @@
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
+    "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",
     "swiftformat_library",
 )
 
diff --git a/examples/exclude_files/Tests/FooTests/BUILD.bazel b/examples/exclude_files/Tests/FooTests/BUILD.bazel
@@ -1,5 +1,5 @@
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
+    "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",
     "swiftformat_test",
 )
 
diff --git a/examples/rules_swift_helpers/Sources/App/BUILD.bazel b/examples/rules_swift_helpers/Sources/App/BUILD.bazel
@@ -1,5 +1,5 @@
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
+    "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",
     "swiftformat_binary",
 )
 
diff --git a/examples/rules_swift_helpers/Sources/Foo/BUILD.bazel b/examples/rules_swift_helpers/Sources/Foo/BUILD.bazel
@@ -1,5 +1,5 @@
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
+    "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",
     "swiftformat_library",
 )
 
diff --git a/examples/rules_swift_helpers/Tests/FooTests/BUILD.bazel b/examples/rules_swift_helpers/Tests/FooTests/BUILD.bazel
@@ -1,5 +1,5 @@
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
+    "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",
     "swiftformat_test",
 )
 
diff --git a/examples/simple/BUILD.bazel b/examples/simple/BUILD.bazel
@@ -1,6 +1,6 @@
 load("@build_bazel_rules_swift//swift:swift.bzl", "swift_binary")
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
+    "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",
     "swiftformat_pkg",
 )
 load(
diff --git a/examples/simple/Foo/BUILD.bazel b/examples/simple/Foo/BUILD.bazel
@@ -1,5 +1,5 @@
 load("@build_bazel_rules_swift//swift:swift.bzl", "swift_library")
-load("@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl", "swiftformat_pkg")
+load("@cgrindel_rules_swiftformat//swiftformat:defs.bzl", "swiftformat_pkg")
 
 swift_library(
     name = "Foo",
diff --git a/swiftformat/BUILD.bazel b/swiftformat/BUILD.bazel
@@ -29,8 +29,8 @@ bzl_library(
 )
 
 bzl_library(
-    name = "swiftformat",
-    srcs = ["swiftformat.bzl"],
+    name = "defs",
+    srcs = ["defs.bzl"],
     deps = [
         "//swiftformat/internal:src_utils",
         "//swiftformat/internal:swiftformat_binary",
@@ -41,6 +41,14 @@ bzl_library(
     ],
 )
 
+bzl_library(
+    name = "swiftformat",
+    srcs = ["swiftformat.bzl"],
+    deps = [
+        ":defs",
+    ],
+)
+
 filegroup(
     name = "all_files",
     srcs = glob(["*"]),
diff --git a/swiftformat/defs.bzl b/swiftformat/defs.bzl
@@ -0,0 +1,36 @@
+load(
+    "//swiftformat/internal:swiftformat_pkg.bzl",
+    _swiftformat_pkg = "swiftformat_pkg",
+)
+load(
+    "//swiftformat/internal:swiftformat_format.bzl",
+    _swiftformat_format = "swiftformat_format",
+)
+load(
+    "//swiftformat/internal:swiftformat_library.bzl",
+    _swiftformat_library = "swiftformat_library",
+)
+load(
+    "//swiftformat/internal:swiftformat_binary.bzl",
+    _swiftformat_binary = "swiftformat_binary",
+)
+load(
+    "//swiftformat/internal:swiftformat_test.bzl",
+    _swiftformat_test = "swiftformat_test",
+)
+load(
+    "//swiftformat/internal:src_utils.bzl",
+    _src_utils = "src_utils",
+)
+
+# Macros
+swiftformat_pkg = _swiftformat_pkg
+swiftformat_library = _swiftformat_library
+swiftformat_binary = _swiftformat_binary
+swiftformat_test = _swiftformat_test
+
+# Rules
+swiftformat_format = _swiftformat_format
+
+# APIs
+src_utils = _src_utils
diff --git a/swiftformat/swiftformat.bzl b/swiftformat/swiftformat.bzl
@@ -1,27 +1,15 @@
+# NOTE: This file is deprecated and will be removed in a future release. Please use
+# //swiftformat:defs.bzl intead.
+
 load(
-    "//swiftformat/internal:swiftformat_pkg.bzl",
-    _swiftformat_pkg = "swiftformat_pkg",
-)
-load(
-    "//swiftformat/internal:swiftformat_format.bzl",
+    "//swiftformat:defs.bzl",
+    _src_utils = "src_utils",
+    _swiftformat_binary = "swiftformat_binary",
     _swiftformat_format = "swiftformat_format",
-)
-load(
-    "//swiftformat/internal:swiftformat_library.bzl",
     _swiftformat_library = "swiftformat_library",
-)
-load(
-    "//swiftformat/internal:swiftformat_binary.bzl",
-    _swiftformat_binary = "swiftformat_binary",
-)
-load(
-    "//swiftformat/internal:swiftformat_test.bzl",
+    _swiftformat_pkg = "swiftformat_pkg",
     _swiftformat_test = "swiftformat_test",
 )
-load(
-    "//swiftformat/internal:src_utils.bzl",
-    _src_utils = "src_utils",
-)
 
 # Macros
 swiftformat_pkg = _swiftformat_pkg

Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ In every Bazel package that contains Swift source files, add a`
`118`	`118`
`119`	`119`	```python
`120`	`120`	`load(`
`121`		`- "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",`
	`121`	`+ "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",`
`122`	`122`	`"swiftformat_pkg",`
`123`	`123`	`)`
`124`	`124`
Original file line number	Diff line number	Diff line change
@@ -43,7 +43,7 @@ The following shows a `BUILD.bazel` file that uses the
`43`	`43`
`44`	`44`	```python
`45`	`45`	`load(`
`46`		`- "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",`
	`46`	`+ "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",`
`47`	`47`	`"swiftformat_library",`
`48`	`48`	`)`
`49`	`49`
@@ -74,7 +74,7 @@ Now, create a `swift_library.bzl` file with the following contents:
`74`	`74`
`75`	`75`	```python
`76`	`76`	`load(`
`77`		`- "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",`
	`77`	`+ "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",`
`78`	`78`	`"swiftformat_library",`
`79`	`79`	`)`
`80`	`80`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`load(`
`2`		`- "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",`
	`2`	`+ "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",`
`3`	`3`	`"swiftformat_binary",`
`4`	`4`	`)`
`5`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`load("@build_bazel_rules_swift//swift:swift.bzl", "swift_binary")`
`2`	`2`	`load(`
`3`		`- "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",`
	`3`	`+ "@cgrindel_rules_swiftformat//swiftformat:defs.bzl",`
`4`	`4`	`"swiftformat_pkg",`
`5`	`5`	`)`
`6`	`6`	`load(`