feat(actions): true partial hunk staging

Resolves #338
lewis6991 · Dec 4, 2021 · f362e54 · f362e54
1 parent 0ffa5a0
commit f362e54
Show file tree

Hide file tree

Showing 14 changed files with 442 additions and 197 deletions.
diff --git a/README.md b/README.md
@@ -189,7 +189,7 @@ Stage/reset all hunks in buffer                          | :white_check_mark:
 Undo staged hunks                                        | :white_check_mark:   |                                               |
 Word diff in buffer                                      | :white_check_mark:   |                                               |
 Word diff in hunk preview                                | :white_check_mark:   | :white_check_mark:                            |
-Stage partial hunks                                      |                      | :white_check_mark:                            |
+Stage partial hunks                                      | :white_check_mark:   |                                               |
 Hunk text object                                         | :white_check_mark:   | :white_check_mark:                            |
 Diff against index or any commit                         | :white_check_mark:   | :white_check_mark:                            |
 Folding of unchanged text                                |                      | :white_check_mark:                            |

diff --git a/doc/gitsigns.txt b/doc/gitsigns.txt
@@ -132,9 +132,11 @@ prev_hunk({opts})                                       *gitsigns.prev_hunk()*
                     See |gitsigns.next_hunk()|.
 
 stage_hunk({range})                                    *gitsigns.stage_hunk()*
-                Stage the hunk at the cursor position, or all hunks in the
-                given range. If {range} is provided, all hunks that intersect
-                with the given range are staged.
+                Stage the hunk at the cursor position, or all lines in the
+                given range. If {range} is provided, all lines in the given
+                range are staged. This supports partial-hunks, meaning if a
+                range only includes a portion of a particular hunk, only the
+                lines within the range will be staged.
 
                 Attributes: ~
                     {async}
@@ -144,8 +146,10 @@ stage_hunk({range})                                    *gitsigns.stage_hunk()*
                     up the line range from which you want to stage the hunks.
 
 undo_stage_hunk()                                 *gitsigns.undo_stage_hunk()*
-                Undo the last call of stage_hunk(). Note: only the calls to
-                stage_hunk() performed in the current session can be undone.
+                Undo the last call of stage_hunk().
+
+                Note: only the calls to stage_hunk() performed in the current
+                session can be undone.
 
                 Attributes: ~
                     {async}
@@ -166,9 +170,10 @@ reset_buffer_index()                           *gitsigns.reset_buffer_index()*
 
 reset_hunk({range})                                    *gitsigns.reset_hunk()*
                 Reset the lines of the hunk at the cursor position, or all
-                hunks in the given range, to what it is in Git's index. If
-                {range} is provided, all hunks that intersect with the given
-                range are reset.
+                lines in the given range. If {range} is provided, all lines in
+                the given range are reset. This supports partial-hunks,
+                meaning if a range only includes a portion of a particular
+                hunk, only the lines within the range will be reset.
 
                 Parameters:~
                     {range} table|nil List-like table of two integers making

diff --git a/lua/gitsigns.lua b/lua/gitsigns.lua
diff --git a/lua/gitsigns/actions.lua b/lua/gitsigns/actions.lua
diff --git a/lua/gitsigns/diff_int.lua b/lua/gitsigns/diff_int.lua
diff --git a/lua/gitsigns/hunks.lua b/lua/gitsigns/hunks.lua
diff --git a/teal/gitsigns.tl b/teal/gitsigns.tl
@@ -32,7 +32,7 @@ local record M
   -- Internal, API unstable
   _update_highlights : function()
   _update_cwd_head   : function()
-  _run_func          : function(range: {integer, integer}, func: string, ...: any)
+  _run_func          : function(range: {integer, integer, integer}, func: string, ...: any)
   _complete          : function(arglead: string, line: string): {string}
   _attach_enable     : function()
   _attach_disable    : function()
@@ -387,15 +387,15 @@ local function parse_args_to_lua(...: string): {any}
   return args
 end
 
-M._run_func = function(range: {integer, integer}, func: string, ...: string)
+M._run_func = function(range: {integer, integer, integer}, func: string, ...: string)
   local actions = require('gitsigns.actions')
   local actions0 = actions as {string:function}
 
   local args = parse_args_to_lua(...)
 
   if type(actions0[func]) == 'function' then
-    if range and range[1] ~= range[2] then
-      actions.user_range = range
+    if range and range[1] > 0 then
+      actions.user_range = {range[2], range[3]}
     else
       actions.user_range = nil
     end
@@ -439,7 +439,7 @@ local function setup_command()
     '-nargs=+',
     '-complete=customlist,v:lua.package.loaded.gitsigns._complete',
     'Gitsigns',
-    'lua require("gitsigns")._run_func({<line1>, <line2>}, <f-args>)'
+    'lua require("gitsigns")._run_func({<range>, <line1>, <line2>}, <f-args>)'
   }, ' '))
 end