Add -ff option to git clean (#529)

cwalsh · web-flow · commit 38843144a0f9 · 2021-12-17T15:15:24.000-08:00
Git will refuse to modify untracked nested git repositories
(directories with a .git subdirectory) unless a second -f is given.

This adds the ability to pass "-ff" to git clean to enable removing
directories with a .git subdirectory.

An example use case is when a gem from a git source is cached in
vendor/cache/some_gem
Removing this with "git clean" would require "git clean -dff"

Signed-off-by: Cameron Walsh &lt;cameron.walsh@gmail.com&gt;
diff --git a/lib/git/base.rb b/lib/git/base.rb
@@ -290,6 +290,7 @@ def reset_hard(commitish = nil, opts = {})
     # options:
     #  :force
     #  :d
+    #  :ff
     #
     def clean(opts = {})
       self.lib.clean(opts)
diff --git a/lib/git/lib.rb b/lib/git/lib.rb
@@ -684,6 +684,7 @@ def reset(commit, opts = {})
     def clean(opts = {})
       arr_opts = []
       arr_opts << '--force' if opts[:force]
+      arr_opts << '-ff' if opts[:ff]
       arr_opts << '-d' if opts[:d]
       arr_opts << '-x' if opts[:x]
 
diff --git a/tests/units/test_index_ops.rb b/tests/units/test_index_ops.rb
@@ -49,6 +49,11 @@ def test_clean
         g.add
         g.commit("first commit")
 
+        FileUtils.mkdir_p("nested")
+        Dir.chdir('nested') do
+          Git.init
+        end
+
         new_file('file-to-clean', 'blablahbla')
         FileUtils.mkdir_p("dir_to_clean")
 
@@ -76,6 +81,11 @@ def test_clean
 
         g.clean(:force => true, :x => true)
         assert(!File.exist?('ignored_file'))
+
+        assert(File.exist?('nested'))
+
+        g.clean(:ff => true, :d => true)
+        assert(!File.exist?('nested'))
       end
     end
   end

Original file line number	Diff line number	Diff line change
`@@ -290,6 +290,7 @@ def reset_hard(commitish = nil, opts = {})`
`290`	`290`	`# options:`
`291`	`291`	`# :force`
`292`	`292`	`# :d`
	`293`	`+ # :ff`
`293`	`294`	`#`
`294`	`295`	`def clean(opts = {})`
`295`	`296`	`self.lib.clean(opts)`