Project and buffer diff previews header keymaps broken

[dpetka2001]

Description

After this commit 6b7592c which tried to create a new feature for #377, the mappings in the header for each diff preview are showing nil (nil).

• nvim --version output: NVIM v0.11.0-dev-1693+g8ce2833411
• Operating system: Linux Mint 21.3

[tanvirtin]

Thanks for letting me know. Can I get your setup configuration please?

require('vgit').setup({}) -- <-- what are you passing here if anything?

[dpetka2001]

{
    "tanvirtin/vgit.nvim",
    event = "VimEnter",
    branch = "v1.0.x",
    opts = {
      keymaps = {
        { mode = "n", key = "<leader>Gk", handler = "hunk_up", desc = "Hunk Up" },
        { mode = "n", key = "<leader>Gj", handler = "hunk_down", desc = "Hunk Down" },
        { mode = "n", key = "<leader>Gs", handler = "buffer_hunk_stage", desc = "Buffer Hunk Stage" },
        { mode = "n", key = "<leader>Gr", handler = "buffer_hunk_reset", desc = "Buffer Hunk Reset" },
        { mode = "n", key = "<leader>Gp", handler = "buffer_hunk_preview", desc = "Buffer Hunk Preview" },
        { mode = "n", key = "<leader>Gb", handler = "buffer_blame_preview", desc = "Buffer Blame Preview" },
        { mode = "n", key = "<leader>Gf", handler = "buffer_diff_preview", desc = "Buffer Diff Preview" },
        { mode = "n", key = "<leader>Gh", handler = "buffer_history_preview", desc = "Buffer History Preview" },
        { mode = "n", key = "<leader>Gu", handler = "buffer_reset", desc = "Buffer Reset" },
        { mode = "n", key = "<leader>Gd", handler = "project_diff_preview", desc = "Project Diff Preview" },
        { mode = "n", key = "<leader>Gx", handler = "toggle_diff_preference", desc = "Toggle Diff Preference" },
      },
      settings = {
        -- You can either allow corresponding mapping for existing hl, or re-define them yourself entirely.
        hls = {
          GitCount = "Keyword",
          GitSymbol = "CursorLineNr",
          GitTitle = "Directory",
          GitSelected = "QuickfixLine",
          GitBackground = "Normal",
          GitAppBar = "StatusLine",
          GitHeader = "NormalFloat",
          GitFooter = "NormalFloat",
          GitBorder = "LineNr",
          GitLineNr = "LineNr",
          GitComment = "Comment",
          GitSignsAdd = {
            gui = nil,
            fg = "#d7ffaf",
            bg = nil,
            sp = nil,
            override = false,
          },
          GitSignsChange = {
            gui = nil,
            fg = "#7AA6DA",
            bg = nil,
            sp = nil,
            override = false,
          },
          GitSignsDelete = {
            gui = nil,
            fg = "#e95678",
            bg = nil,
            sp = nil,
            override = false,
          },
          GitSignsAddLn = "DiffAdd",
          GitSignsDeleteLn = "DiffDelete",
          GitWordAdd = {
            gui = nil,
            fg = nil,
            bg = "#5d7a22",
            sp = nil,
            override = false,
          },
          GitWordDelete = {
            gui = nil,
            fg = nil,
            bg = "#960f3d",
            sp = nil,
            override = false,
          },
          GitConflictCurrentMark = "DiffAdd",
          GitConflictAncestorMark = "Visual",
          GitConflictIncomingMark = "DiffChange",
          GitConflictCurrent = "DiffAdd",
          GitConflictAncestor = "Visual",
          GitConflictMiddle = "Visual",
          GitConflictIncoming = "DiffChange",
        },
        live_blame = {
          enabled = true,
          format = function(blame, git_config)
            local config_author = git_config["user.name"]
            local author = blame.author
            if config_author == author then
              author = "You"
            end
            local time = os.difftime(os.time(), blame.author_time) / (60 * 60 * 24 * 30 * 12)
            local time_divisions = {
              { 1, "years" },
              { 12, "months" },
              { 30, "days" },
              { 24, "hours" },
              { 60, "minutes" },
              { 60, "seconds" },
            }
            local counter = 1
            local time_division = time_divisions[counter]
            local time_boundary = time_division[1]
            local time_postfix = time_division[2]
            while time < 1 and counter ~= #time_divisions do
              time_division = time_divisions[counter]
              time_boundary = time_division[1]
              time_postfix = time_division[2]
              time = time * time_boundary
              counter = counter + 1
            end
            local commit_message = blame.commit_message
            if not blame.committed then
              author = "You"
              commit_message = "Uncommitted changes"
              return string.format(" %s • %s", author, commit_message)
            end
            local max_commit_message_length = 255
            if #commit_message > max_commit_message_length then
              commit_message = commit_message:sub(1, max_commit_message_length) .. "..."
            end
            return string.format(
              " %s, %s • %s",
              author,
              string.format("%s %s ago", time >= 0 and math.floor(time + 0.5) or math.ceil(time - 0.5), time_postfix),
              commit_message
            )
          end,
        },
        live_gutter = {
          enabled = true,
          edge_navigation = true, -- This allows users to navigate within a hunk
        },
        scene = {
          diff_preference = "unified", -- unified or split
          keymaps = {
            quit = "q",
          },
        },
        diff_preview = {
          keymaps = {
            reset = "r",
            buffer_stage = "S",
            buffer_unstage = "U",
            buffer_hunk_stage = "s",
            buffer_hunk_unstage = "u",
            toggle_view = "t",
          },
        },
        project_diff_preview = {
          keymaps = {
            commit = "C",
            buffer_stage = "s",
            buffer_unstage = "u",
            buffer_hunk_stage = "gs",
            buffer_hunk_unstage = "gu",
            buffer_reset = "r",
            stage_all = "S",
            unstage_all = "U",
            reset_all = "R",
          },
        },
        project_stash_preview = {
          keymaps = {
            add = "A",
            apply = "a",
            pop = "p",
            drop = "d",
            clear = "C",
          },
        },
        project_logs_preview = {
          keymaps = {
            previous = "-",
            next = "=",
          },
        },
        project_commit_preview = {
          keymaps = {
            save = "S",
          },
        },
        signs = {
          priority = 10,
          definitions = {
            -- The sign definitions you provide will automatically be instantiated for you.
            GitConflictCurrentMark = {
              linehl = "GitConflictCurrentMark",
              texthl = nil,
              numhl = nil,
              icon = nil,
              text = "",
            },
            GitConflictAncestorMark = {
              linehl = "GitConflictAncestorMark",
              texthl = nil,
              numhl = nil,
              icon = nil,
              text = "",
            },
            GitConflictIncomingMark = {
              linehl = "GitConflictIncomingMark",
              texthl = nil,
              numhl = nil,
              icon = nil,
              text = "",
            },
            GitConflictCurrent = {
              linehl = "GitConflictCurrent",
              texthl = nil,
              numhl = nil,
              icon = nil,
              text = "",
            },
            GitConflictAncestor = {
              linehl = "GitConflictAncestor",
              texthl = nil,
              numhl = nil,
              icon = nil,
              text = "",
            },
            GitConflictMiddle = {
              linehl = "GitConflictMiddle",
              texthl = nil,
              numhl = nil,
              icon = nil,
              text = "",
            },
            GitConflictIncoming = {
              linehl = "GitConflictIncoming",
              texthl = nil,
              numhl = nil,
              icon = nil,
              text = "",
            },
            GitSignsAddLn = {
              linehl = "GitSignsAddLn",
              texthl = nil,
              numhl = nil,
              icon = nil,
              text = "",
            },
            GitSignsDeleteLn = {
              linehl = "GitSignsDeleteLn",
              texthl = nil,
              numhl = nil,
              icon = nil,
              text = "",
            },
            GitSignsAdd = {
              texthl = "GitSignsAdd",
              numhl = nil,
              icon = nil,
              linehl = nil,
              text = "┃",
            },
            GitSignsDelete = {
              texthl = "GitSignsDelete",
              numhl = nil,
              icon = nil,
              linehl = nil,
              text = "┃",
            },
            GitSignsChange = {
              texthl = "GitSignsChange",
              numhl = nil,
              icon = nil,
              linehl = nil,
              text = "┃",
            },
          },
          usage = {
            -- Please ensure these signs are defined.
            screen = {
              add = "GitSignsAddLn",
              remove = "GitSignsDeleteLn",
              conflict_current_mark = "GitConflictCurrentMark",
              conflict_current = "GitConflictCurrent",
              conflict_middle = "GitConflictMiddle",
              conflict_incoming_mark = "GitConflictIncomingMark",
              conflict_incoming = "GitConflictIncoming",
              conflict_ancestor_mark = "GitConflictAncestorMark",
              conflict_ancestor = "GitConflictAncestor",
            },
            main = {
              add = "GitSignsAdd",
              remove = "GitSignsDelete",
              change = "GitSignsChange",
            },
          },
        },
        symbols = {
          void = "⣿",
          open = "",
          close = "",
        },
      },
    },
  },

Basically the advanced example setup from this repo's README and I'm just changing the mappings into tables, so that I can have descriptions.

[dpetka2001]

So, in the advanced example if I comment out the tables project_diff_preview and diff_preview, then I can see the default mappings in the header when I invoke those actions.

[tanvirtin]

It makes sense, I was able to replicate the issue. I'll issue a fix shortly, in the meantime you can just use a different format for these key mapping for example.

Also only use the advanced settings if you intend to reconfigure the defaults.

[dpetka2001]

I was testing the advanced example because I wanted to experiment with the signs and maybe get rid of gitsigns.nvim. But I will comment most of the stuff out for now (except for the keymaps section) and only gradually uncomment what I want to change indeed.

Thank you for your time.

[tanvirtin]

Should be fixed in the latest branch. If you face any issues as always leave an issue thanks!