nvim-git-fixer 🔧

Create fixup!, amend!, reword! or squash! commits with ease. (See the --autosquash option of git rebase for further information about these commit types)

Installation

Plug 'LhKipp/nvim-git-fixer'
Plug 'tpope/vim-fugitive' " Required

" Needed for stage_hunk, undo_stage_hunk and refresh actions. But can be swapped out. See configuration below.
Plug 'lewis6991/gitsigns.nvim'

" Needed if you want to use telescope to pick the commits to fix
Plug 'nvim-telescope/telescope.nvim'

Don't forget to call setup 😏

require('fixer').setup{}

Usage

-- Create a `fixup!` commit only with the contents of the hunk under the cursor
-- Use a telescope based picker to select the commit to fix
require('fixer/picker/telescope').commit{hunk_only=true, type="fixup"} 

-- Create an `amend!` commit with the contents of the index
-- Use a telescope based picker to select the commit to fix
require('fixer/picker/telescope').commit{type="amend"}

-- `type`'s supported are: 'fixup', 'amend', 'reword' and 'squash'

-- For convenience:  Create a 'normal' commit with the contents of the hunk under the cursor
require('fixer').commit_hunk()

Note: When only commiting the hunk under the cursor (hunk_only=true), nvim-git-fixer will try to stash the index only. Git does not offer such a functionality. Therefore a technique as explained here https://stackoverflow.com/a/60925924 is used. This method is not perfect (but it works in 95% of all situations on my machine 🙃)

Configuration

Currently the configuration only allows to pick a different plugin to do stage hunk actions.

-- defaults shown --
require('fixer').setup{
    stage_hunk_action = function () require("gitsigns").stage_hunk() end,
    undo_stage_hunk_action = function () require("gitsigns").undo_stage_hunk() end,
    refresh_hunks_action = function () require("gitsigns").refresh() end,
}

You can also write your own commit-hash-picker. The basic logic is:

local fixer = require('fixer')

local commit_only_current_hunk = true
local commit_type = "fixup" -- Or "amend", "reword", "squash"
local hash = pick_hash() -- Your magic function here

if commit_only_current_hunk then
    fixer.start_single_hunk_commit()
end
fixer.commit(commit_type, hash)
if commit_only_current_hunk then
    fixer.finish_single_hunk_commit()
end