chore: avoid adding .build directory to client's workspace (#771)

- Pass `--build-path` to select `swift package` calls that are executed
during `update-repos` (i.e., `//:swift_update_pkgs`).
- Remove obsolete `.bazelignore` files.
- Remove call to utility that cleans up `.build` directories.

Closes #758.

Author: cgrindel

BUILD.bazel

@@ -29,8 +29,6 @@ tidy(
         # Remove the child workspace symlinks before doing some of the other
         # operations that my experience infinite symlink expansion errors.
         "@rules_bazel_integration_test//tools:remove_child_wksp_bazel_symlinks",
-        # Remove any Swift .build directories
-        "//tools/remove_swift_build_dirs",
         "@rules_bazel_integration_test//tools:update_deleted_packages",
         ":bzlformat_missing_pkgs_fix",
         ":update_all",

examples/firebase_example/.bazelignore

@@ -26,7 +26,7 @@ go_library(
         "module_to_products_index.go",
         "module_type.go",
         "package.go",
-        "packages_index.go",
+        "package_index.go",
         "patch.go",
         "product.go",
         "product_index.go",

examples/tca_example/.bazelignore

@@ -6,16 +6,14 @@ import (
 	"strings"
 )
 
-const swiftPkgBuildDirname = ".build"
 const swiftPkgCheckoutsDirname = "checkouts"
 
 // CodeDirForRemotePackage returns the path to the dependency's code. For source control
 // dependencies, it is the checkout directory.
-func CodeDirForRemotePackage(pkgDir string, url string) string {
+func CodeDirForRemotePackage(buildDir string, url string) string {
 	// Return the checkout directory
 	return filepath.Join(
-		pkgDir,
-		swiftPkgBuildDirname,
+		buildDir,
 		swiftPkgCheckoutsDirname,
 		spmCheckoutDirname(url),
 	)

gazelle/internal/swift/BUILD.bazel

@@ -8,6 +8,7 @@ import (
 )
 
 const pkgDir = "/path/to/pkg"
+const buildDir = "/path/to/build"
 
 func TestCodeDirForRemotePackage(t *testing.T) {
 	tests := []struct {
@@ -16,19 +17,19 @@ func TestCodeDirForRemotePackage(t *testing.T) {
 	}{
 		{
 			url:  "https://github.com/nicklockwood/SwiftFormat",
-			wval: "/path/to/pkg/.build/checkouts/SwiftFormat",
+			wval: "/path/to/build/checkouts/SwiftFormat",
 		},
 		{
 			url:  "https://github.com/nicklockwood/SwiftFormat.git",
-			wval: "/path/to/pkg/.build/checkouts/SwiftFormat",
+			wval: "/path/to/build/checkouts/SwiftFormat",
 		},
 		{
 			url:  "https://github.com/nicklockwood/SwiftFormat.swift",
-			wval: "/path/to/pkg/.build/checkouts/SwiftFormat.swift",
+			wval: "/path/to/build/checkouts/SwiftFormat.swift",
 		},
 	}
 	for _, tc := range tests {
-		actual := swift.CodeDirForRemotePackage(pkgDir, tc.url)
+		actual := swift.CodeDirForRemotePackage(buildDir, tc.url)
 		assert.Equal(t, tc.wval, actual)
 	}
 }

gazelle/internal/swift/code_dir.go

@@ -9,7 +9,7 @@ import (
 // An Executor represents commands provided by the Swift binary.
 type Executor interface {
 	InitPackage(dir, name, pkgType string) error
-	DumpPackage(dir string) ([]byte, error)
+	DumpPackage(dir, buildDir string) ([]byte, error)
 	DescribePackage(dir string) ([]byte, error)
 }
 
@@ -34,10 +34,12 @@ func (sb *SwiftBin) InitPackage(dir, name, pkgType string) error {
 }
 
 // DumpPackage returns the `swift package dump-package` JSON for a Swift package.
-func (sb *SwiftBin) DumpPackage(dir string) ([]byte, error) {
+func (sb *SwiftBin) DumpPackage(dir, buildDir string) ([]byte, error) {
 	var stdout bytes.Buffer
 	var stderr bytes.Buffer
-	cmd := exec.Command(sb.BinPath, "package", "dump-package")
+	args := []string{"package", "dump-package"}
+	args = appendBuildPath(args, buildDir)
+	cmd := exec.Command(sb.BinPath, args...)
 	cmd.Dir = dir
 	cmd.Stdout = &stdout
 	cmd.Stderr = &stderr
@@ -55,7 +57,8 @@ func (sb *SwiftBin) DumpPackage(dir string) ([]byte, error) {
 func (sb *SwiftBin) DescribePackage(dir string) ([]byte, error) {
 	var stdout bytes.Buffer
 	var stderr bytes.Buffer
-	cmd := exec.Command(sb.BinPath, "package", "describe", "--type", "json")
+	args := []string{"package", "describe", "--type", "json"}
+	cmd := exec.Command(sb.BinPath, args...)
 	cmd.Dir = dir
 	cmd.Stdout = &stdout
 	cmd.Stderr = &stderr
@@ -70,18 +73,26 @@ func (sb *SwiftBin) DescribePackage(dir string) ([]byte, error) {
 }
 
 // ResolvePackage executes Swift package dependency resolution for a Swift package.
-func (sb *SwiftBin) ResolvePackage(dir string, updateToLatest bool) error {
+func (sb *SwiftBin) ResolvePackage(dir, buildDir string, updateToLatest bool) error {
 	var pkgCmd string
 	if updateToLatest {
 		pkgCmd = "update"
 	} else {
 		pkgCmd = "resolve"
 	}
 	args := []string{"package", pkgCmd}
+	args = appendBuildPath(args, buildDir)
 	cmd := exec.Command(sb.BinPath, args...)
 	cmd.Dir = dir
 	if out, err := cmd.CombinedOutput(); err != nil {
 		return fmt.Errorf("failed executing `swift package resolve`, out\n%v: %w", string(out), err)
 	}
 	return nil
 }
+
+func appendBuildPath(args []string, buildDir string) []string {
+	if buildDir == "" {
+		return args
+	}
+	return append(args, "--build-path", buildDir)
+}

gazelle/internal/swift/code_dir_test.go

@@ -18,6 +18,11 @@ func TestSwiftBin(t *testing.T) {
 		assert.NoError(t, err)
 		defer os.RemoveAll(dir)
 
+		// Create a build directory
+		buildDir, err := os.MkdirTemp("", "builddir")
+		assert.NoError(t, err)
+		defer os.RemoveAll(buildDir)
+
 		// Find Swift
 		binPath, err := swiftbin.FindSwiftBinPath()
 		assert.NoError(t, err)
@@ -29,7 +34,7 @@ func TestSwiftBin(t *testing.T) {
 		assert.NoError(t, err)
 
 		// Dump the package
-		out, err := sb.DumpPackage(dir)
+		out, err := sb.DumpPackage(dir, buildDir)
 		assert.NoError(t, err)
 		var dumpMap map[string]any
 		err = json.Unmarshal(out, &dumpMap)
@@ -56,6 +61,11 @@ func TestSwiftBin(t *testing.T) {
 		assert.NoError(t, err)
 		defer os.RemoveAll(dir)
 
+		// Create a build directory
+		buildDir, err := os.MkdirTemp("", "builddir")
+		assert.NoError(t, err)
+		defer os.RemoveAll(buildDir)
+
 		// Find Swift
 		binPath, err := swiftbin.FindSwiftBinPath()
 		assert.NoError(t, err)
@@ -72,13 +82,13 @@ func TestSwiftBin(t *testing.T) {
 		assert.NoError(t, err)
 
 		// Resolve the package
-		err = sb.ResolvePackage(dir, false)
+		err = sb.ResolvePackage(dir, buildDir, false)
 		assert.NoError(t, err)
 		resolvedPkgPath := filepath.Join(dir, "Package.resolved")
 		assert.FileExists(t, resolvedPkgPath)
 
 		// Resolve the package to their latest eligible version
-		err = sb.ResolvePackage(dir, true)
+		err = sb.ResolvePackage(dir, buildDir, true)
 		assert.NoError(t, err)
 	})
 }

gazelle/internal/swift/packages_index.go renamed to gazelle/internal/swift/package_index.go

@@ -25,8 +25,8 @@ type PackageInfo struct {
 }
 
 // NewPackageInfo returns the Swift package information from a Swift package on disk.
-func NewPackageInfo(sw swiftbin.Executor, dir string) (*PackageInfo, error) {
-	dump, err := sw.DumpPackage(dir)
+func NewPackageInfo(sw swiftbin.Executor, dir, buildDir string) (*PackageInfo, error) {
+	dump, err := sw.DumpPackage(dir, buildDir)
 	if err != nil {
 		return nil, err
 	}