feat: recursively initialize external Swift packages to match SPM behavior (#1095)

Fixes #1090.

Author: cgrindel

docs/repository_rules_overview.md

@@ -65,7 +65,7 @@ Used to download and build an external Swift package.
 | <a id="swift_package-patch_cmds_win"></a>patch_cmds_win |  Sequence of Powershell commands to be applied on Windows after patches are applied. If this attribute is not set, patch_cmds will be executed on Windows, which requires Bash binary to exist.   | List of strings | optional | <code>[]</code> |
 | <a id="swift_package-patch_tool"></a>patch_tool |  The patch(1) utility to use. If this is specified, Bazel will use the specified patch tool instead of the Bazel-native patch implementation.   | String | optional | <code>""</code> |
 | <a id="swift_package-patches"></a>patches |  A list of files that are to be applied as patches after extracting the archive. By default, it uses the Bazel-native patch implementation which doesn't support fuzz match and binary patch, but Bazel will fall back to use patch command line tool if <code>patch_tool</code> attribute is specified or there are arguments other than <code>-p</code> in <code>patch_args</code> attribute.   | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | <code>[]</code> |
-| <a id="swift_package-recursive_init_submodules"></a>recursive_init_submodules |  Whether to clone submodules recursively in the repository.   | Boolean | optional | <code>False</code> |
+| <a id="swift_package-recursive_init_submodules"></a>recursive_init_submodules |  Whether to clone submodules recursively in the repository.   | Boolean | optional | <code>True</code> |
 | <a id="swift_package-remote"></a>remote |  The version control location from where the repository should be downloaded.   | String | required |  |
 | <a id="swift_package-repo_mapping"></a>repo_mapping |  A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.&lt;p&gt;For example, an entry <code>"@foo": "@bar"</code> declares that, for any time this repository depends on <code>@foo</code> (such as a dependency on <code>@foo//some:target</code>, it should actually resolve that dependency within globally-declared <code>@bar</code> (<code>@bar//some:target</code>).   | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | required |  |
 | <a id="swift_package-shallow_since"></a>shallow_since |  an optional date, not after the specified commit; the argument is not allowed if a tag is specified (which allows cloning with depth 1). Setting such a date close to the specified commit allows for a more shallow clone of the repository, saving bandwidth and wall-clock time.   | String | optional | <code>""</code> |

examples/interesting_deps/MODULE.bazel

@@ -59,7 +59,3 @@ use_repo(
     "swiftpkg_swift_log",
 )
 # swift_deps END
-swift_deps.configure_package(
-    name = "swiftpkg_libwebp_xcode",
-    init_submodules = True,
-)

swiftpkg/bzlmod/swift_deps.bzl

@@ -91,7 +91,7 @@ _configure_package_tag = tag_class(
             mandatory = True,
         ),
         "recursive_init_submodules": attr.bool(
-            default = False,
+            default = True,
             doc = "Whether to clone submodules recursively in the repository.",
         ),
     },

swiftpkg/internal/swift_package.bzl

@@ -109,7 +109,7 @@ The commit or revision to download from version control.\
         doc = "Whether to clone submodules in the repository.",
     ),
     "recursive_init_submodules": attr.bool(
-        default = False,
+        default = True,
         doc = "Whether to clone submodules recursively in the repository.",
     ),
     "remote": attr.string(