Add gitsigns recommended keymaps (nvim-lua#531)

* Import gitsigns README.md recommended keymaps (and apply stylua)

the previously added visual mode for ]c [c is kept.

* Add gitsigns keymap descriptions

(cherry picked from commit f8c8b08)

init.lua

@@ -139,43 +139,78 @@ require('lazy').setup({
         -- don't override the built-in and fugitive keymaps
         local gs = package.loaded.gitsigns
 
+        local function map(mode, l, r, opts)
+          opts = opts or {}
+          opts.buffer = bufnr
+          vim.keymap.set(mode, l, r, opts)
+        end
+
         -- Navigation
-        -- next change
-        vim.keymap.set({ 'n', 'v' }, ']c', function()
+        map({ 'n', 'v' }, ']c', function()
           if vim.wo.diff then
             return ']c'
           end
           vim.schedule(function()
             gs.next_hunk()
           end)
           return '<Ignore>'
-        end, { expr = true, buffer = bufnr, desc = 'Jump to next hunk' })
-        -- prev change
-        vim.keymap.set({ 'n', 'v' }, '[c', function()
+        end, { expr = true, desc = 'Jump to next hunk' })
+
+        map({ 'n', 'v' }, '[c', function()
           if vim.wo.diff then
             return '[c'
           end
           vim.schedule(function()
             gs.prev_hunk()
           end)
           return '<Ignore>'
-        end, { expr = true, buffer = bufnr, desc = 'Jump to previous hunk' })
+        end, { expr = true, desc = 'Jump to previous hunk' })
 
         -- Actions
-        vim.keymap.set({ 'n', 'v' }, '<leader>hs', ':Gitsigns stage_hunk<cr>', { desc = 'git [H]unk [S]tage selected' })
-        vim.keymap.set({ 'n', 'v' }, '<leader>hr', ':Gitsigns reset_hunk<cr>', { desc = 'git [H]unk [R]eset selected' })
-        vim.keymap.set('n', '<leader>ha', gs.stage_hunk, { desc = 'git [H]unk [A]add' })
-        vim.keymap.set('n', '<leader>hu', gs.undo_stage_hunk, { desc = 'git [H]unk [U]ndo stage' })
-        -- vim.keymap.set('n', '<leader>hR', gs.reset_buffer , {desc='git [H]unk [R]eset BUFFER'})
-        vim.keymap.set('n', '<leader>hp', gs.preview_hunk, { buffer = bufnr, desc = 'git [H]unk [P]review' })
-        vim.keymap.set('n', '<leader>hb', function() gs.blame_line { full = true } end, { desc = 'git [H]unk [B]lame' })
-        vim.keymap.set('n', '<leader>hd', gs.diffthis, { desc = 'git [H]unk [D]iff' })
-        vim.keymap.set('n', '<leader>hD', function() gs.diffthis('~') end, { desc = 'git [H]unk [D]iff last commit' })
-        vim.keymap.set('n', '<leader>td', gs.toggle_deleted, { desc = 'git [T]oggle [D]eleted' })
-        vim.keymap.set('n', '<leader>ga', ':Git commit --amend --no-edit<cr>', { desc = 'git [A]mend' })
-
-        -- text object
-        vim.keymap.set({ 'o', 'x' }, 'ih', ':<C-U>Gitsigns select_hunk<CR>', { desc = '[I]nside [H]unk' })
+        -- visual mode
+        map('v', '<leader>hs', function()
+          gs.stage_hunk { vim.fn.line '.', vim.fn.line 'v' }
+        end, { desc = 'stage git hunk' })
+        map('v', '<leader>hr', function()
+          gs.reset_hunk { vim.fn.line '.', vim.fn.line 'v' }
+        end, { desc = 'reset git hunk' })
+        -- normal mode
+        map('n', '<leader>hs', gs.stage_hunk, { desc = 'git stage hunk' })
+        map('n', '<leader>hr', gs.reset_hunk, { desc = 'git reset hunk' })
+        map('n', '<leader>hS', gs.stage_buffer, { desc = 'git Stage buffer' })
+        map('n', '<leader>hu', gs.undo_stage_hunk, { desc = 'undo stage hunk' })
+        map('n', '<leader>hR', gs.reset_buffer, { desc = 'git Reset buffer' })
+        map('n', '<leader>hp', gs.preview_hunk, { desc = 'preview git hunk' })
+        map('n', '<leader>hb', function()
+          gs.blame_line { full = false }
+        end, { desc = 'git blame line' })
+        map('n', '<leader>hd', gs.diffthis, { desc = 'git diff against index' })
+        map('n', '<leader>hD', function()
+          gs.diffthis '~'
+        end, { desc = 'git diff against last commit' })
+
+        -- Toggles
+        map('n', '<leader>tb', gs.toggle_current_line_blame, { desc = 'toggle git blame line' })
+        map('n', '<leader>td', gs.toggle_deleted, { desc = 'toggle git show deleted' })
+
+        -- Text object
+        map({ 'o', 'x' }, 'ih', ':<C-U>Gitsigns select_hunk<CR>', { desc = 'select git hunk' })
+
+--         -- Actions
+--         vim.keymap.set({ 'n', 'v' }, '<leader>hs', ':Gitsigns stage_hunk<cr>', { desc = 'git [H]unk [S]tage selected' })
+--         vim.keymap.set({ 'n', 'v' }, '<leader>hr', ':Gitsigns reset_hunk<cr>', { desc = 'git [H]unk [R]eset selected' })
+--         vim.keymap.set('n', '<leader>ha', gs.stage_hunk, { desc = 'git [H]unk [A]add' })
+--         vim.keymap.set('n', '<leader>hu', gs.undo_stage_hunk, { desc = 'git [H]unk [U]ndo stage' })
+--         -- vim.keymap.set('n', '<leader>hR', gs.reset_buffer , {desc='git [H]unk [R]eset BUFFER'})
+--         vim.keymap.set('n', '<leader>hp', gs.preview_hunk, { buffer = bufnr, desc = 'git [H]unk [P]review' })
+--         vim.keymap.set('n', '<leader>hb', function() gs.blame_line { full = true } end, { desc = 'git [H]unk [B]lame' })
+--         vim.keymap.set('n', '<leader>hd', gs.diffthis, { desc = 'git [H]unk [D]iff' })
+--         vim.keymap.set('n', '<leader>hD', function() gs.diffthis('~') end, { desc = 'git [H]unk [D]iff last commit' })
+--         vim.keymap.set('n', '<leader>td', gs.toggle_deleted, { desc = 'git [T]oggle [D]eleted' })
+--         vim.keymap.set('n', '<leader>ga', ':Git commit --amend --no-edit<cr>', { desc = 'git [A]mend' })
+--
+--         -- text object
+--         vim.keymap.set({ 'o', 'x' }, 'ih', ':<C-U>Gitsigns select_hunk<CR>', { desc = '[I]nside [H]unk' })
       end,
     },
   },
@@ -616,11 +651,18 @@ require('which-key').register {
   ['<leader>c'] = { name = '[C]ode', _ = 'which_key_ignore' },
   ['<leader>d'] = { name = '[D]ocument', _ = 'which_key_ignore' },
   ['<leader>g'] = { name = '[G]it', _ = 'which_key_ignore' },
-  ['<leader>h'] = { name = 'More git', _ = 'which_key_ignore' },
+  ['<leader>h'] = { name = 'Git [H]unk', _ = 'which_key_ignore' },
   ['<leader>r'] = { name = '[R]ename', _ = 'which_key_ignore' },
   ['<leader>s'] = { name = '[S]earch', _ = 'which_key_ignore' },
+  ['<leader>t'] = { name = '[T]oggle', _ = 'which_key_ignore' },
   ['<leader>w'] = { name = '[W]orkspace', _ = 'which_key_ignore' },
 }
+-- register which-key VISUAL mode
+-- required for visual <leader>hs (hunk stage) to work
+require('which-key').register({
+  ['<leader>'] = { name = 'VISUAL <leader>' },
+  ['<leader>h'] = { 'Git [H]unk' },
+}, { mode = 'v' })
 
 -- mason-lspconfig requires that these setup functions are called in this order
 -- before setting up the servers.