Merge pull request #675 from darkowlzz/git-clean

git: worktree, add Clean() method for git clean

Author: mcuadros

options.go

@@ -360,3 +360,8 @@ type ListOptions struct {
 	// Auth credentials, if required, to use with the remote repository.
 	Auth transport.AuthMethod
 }
+
+// CleanOptions describes how a clean should be performed.
+type CleanOptions struct {
+	Dir bool
+}

worktree.go

@@ -684,6 +684,33 @@ func (w *Worktree) readGitmodulesFile() (*config.Modules, error) {
 	return m, m.Unmarshal(input)
 }
 
+// Clean the worktree by removing untracked files.
+func (w *Worktree) Clean(opts *CleanOptions) error {
+	s, err := w.Status()
+	if err != nil {
+		return err
+	}
+
+	// Check Worktree status to be Untracked, obtain absolute path and delete.
+	for relativePath, status := range s {
+		// Check if the path contains a directory and if Dir options is false,
+		// skip the path.
+		if relativePath != filepath.Base(relativePath) && !opts.Dir {
+			continue
+		}
+
+		// Remove the file only if it's an untracked file.
+		if status.Worktree == Untracked {
+			absPath := filepath.Join(w.Filesystem.Root(), relativePath)
+			if err := os.Remove(absPath); err != nil {
+				return err
+			}
+		}
+	}
+
+	return nil
+}
+
 func rmFileAndDirIfEmpty(fs billy.Filesystem, name string) error {
 	if err := util.RemoveAll(fs, name); err != nil {
 		return err

worktree_test.go

@@ -1252,3 +1252,38 @@ func (s *WorktreeSuite) TestMoveToExistent(c *C) {
 	c.Assert(hash.IsZero(), Equals, true)
 	c.Assert(err, Equals, ErrDestinationExists)
 }
+
+func (s *WorktreeSuite) TestClean(c *C) {
+	fs := fixtures.ByTag("dirty").One().Worktree()
+
+	// Open the repo.
+	fs, err := fs.Chroot("repo")
+	c.Assert(err, IsNil)
+	r, err := PlainOpen(fs.Root())
+	c.Assert(err, IsNil)
+
+	wt, err := r.Worktree()
+	c.Assert(err, IsNil)
+
+	// Status before cleaning.
+	status, err := wt.Status()
+	c.Assert(len(status), Equals, 2)
+
+	err = wt.Clean(&CleanOptions{})
+	c.Assert(err, IsNil)
+
+	// Status after cleaning.
+	status, err = wt.Status()
+	c.Assert(err, IsNil)
+
+	c.Assert(len(status), Equals, 1)
+
+	// Clean with Dir: true.
+	err = wt.Clean(&CleanOptions{Dir: true})
+	c.Assert(err, IsNil)
+
+	status, err = wt.Status()
+	c.Assert(err, IsNil)
+
+	c.Assert(len(status), Equals, 0)
+}