feat: clean untracked files (#2237)

Updates #1682

Author: JoeWang1127

internal/gitrepo/gitrepo.go

@@ -21,6 +21,7 @@ import (
 	"log/slog"
 	"os"
 	"os/exec"
+	"path/filepath"
 	"strings"
 	"time"
 
@@ -46,6 +47,7 @@ type Repository interface {
 	CreateBranchAndCheckout(name string) error
 	Push(branchName string) error
 	Restore(paths []string) error
+	CleanUntracked(paths []string) error
 	pushRefSpec(refSpec string) error
 }
 
@@ -479,3 +481,33 @@ func (r *LocalRepository) Restore(paths []string) error {
 	cmd.Dir = r.Dir
 	return cmd.Run()
 }
+
+// CleanUntracked removes untracked files within the given paths.
+func (r *LocalRepository) CleanUntracked(paths []string) error {
+	slog.Info("Cleaning untracked files", "paths", strings.Join(paths, ","))
+	worktree, err := r.repo.Worktree()
+	if err != nil {
+		return err
+	}
+
+	status, err := worktree.Status()
+	if err != nil {
+		return err
+	}
+
+	// Remove an untracked file if it lives within one of the given paths.
+	for _, path := range paths {
+		for file, fileStatue := range status {
+			if !strings.Contains(file, path) || fileStatue.Worktree != git.Untracked {
+				continue
+			}
+
+			relPath := filepath.Join(r.Dir, file)
+			if err := os.Remove(relPath); err != nil {
+				return fmt.Errorf("failed to remove untracked file, %s: %q", relPath, err)
+			}
+		}
+	}
+
+	return nil
+}

internal/gitrepo/gitrepo_test.go

@@ -1192,6 +1192,78 @@ func TestRestore(t *testing.T) {
 	}
 }
 
+func TestCleanUntracked(t *testing.T) {
+	t.Parallel()
+	for _, test := range []struct {
+		name  string
+		paths []string
+	}{
+		{
+			name: "remove_untracked_files_in_paths",
+			paths: []string{
+				"first/path",
+				"second/path",
+			},
+		},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+			repo, dir := initTestRepo(t)
+			localRepo := &LocalRepository{
+				Dir:  dir,
+				repo: repo,
+			}
+
+			// Create tracked files.
+			for _, path := range test.paths {
+				relPath := filepath.Join(dir, path)
+				if err := os.MkdirAll(relPath, 0755); err != nil {
+					t.Fatal(err)
+				}
+				trackedFile := filepath.Join(relPath, "tracked.txt")
+				if err := os.WriteFile(trackedFile, []byte("new content"), 0755); err != nil {
+					t.Fatal(err)
+				}
+			}
+
+			if _, err := localRepo.AddAll(); err != nil {
+				t.Fatal(err)
+			}
+
+			// Create untracked files.
+			for _, path := range test.paths {
+				relPath := filepath.Join(dir, path)
+				if err := os.MkdirAll(relPath, 0755); err != nil {
+					t.Fatal(err)
+				}
+				untrackedFile := filepath.Join(relPath, "untracked.txt")
+				if err := os.WriteFile(untrackedFile, []byte("new content"), 0755); err != nil {
+					t.Fatal(err)
+				}
+			}
+
+			if err := localRepo.CleanUntracked(test.paths); err != nil {
+				t.Error(err)
+
+				return
+			}
+
+			for _, path := range test.paths {
+				// Verify the untracked files are removed.
+				untrackedFile := filepath.Join(dir, path, "untracked.txt")
+				if _, err := os.Stat(untrackedFile); !os.IsNotExist(err) {
+					t.Errorf("untracked file, %s should be removed", untrackedFile)
+				}
+				// Verify the tracked files are untouched.
+				trackedFile := filepath.Join(dir, path, "tracked.txt")
+				if _, err := os.Stat(trackedFile); err != nil {
+					t.Errorf("tracked file, %s should not be touched: %q", trackedFile, err)
+				}
+			}
+		})
+	}
+}
+
 // initTestRepo creates a new git repository in a temporary directory.
 func initTestRepo(t *testing.T) (*git.Repository, string) {
 	t.Helper()