How to set a keymap to get directly to a log of the current file?

[georgeguimaraes]

Hello, I'm finally digging into configuring Neogit and loving all the functionality. Tks!

But how can I set a keymap to get a log_current for the file I'm in? I tried:

vim.keymap.set(
  "n",
  "<leader>gl",
  require("neogit").action("log", "log_current", { "--", "%" }),
  { desc = "Neogit Log for this file" }
)

but the window came empty.

[CKolkey]

You'll need to expand '%' via vim.fn.expand() before passing it as an argument - we don't do that for you internally.

[georgeguimaraes]

Still didn't work, NeogitLogView window came empty.

This is what I tried:

vim.keymap.set(
  "n",
  "<leader>gl",
  require("neogit").action("log", "log_current", { "--", vim.fn.expand("%") }),
  { desc = "Neogit Log for this file" }
)

[georgeguimaraes]

I did some debugging using NEOGIT_LOG_CONSOLE="sync" NEOGIT_LOG_LEVEL="trace" nvim, then opened a README.md file in a git repo, and used my keymap above.

The logs:

[neogit] [TRACE 08:38:12] ...rge/.local/share/nvim/lazy/neogit/lua/neogit/process.lua:363: [PROCESS] Spawning: { "git", "rev-parse", "--show-toplevel" }
[neogit] [DEBUG 08:38:12] ...share/nvim/lazy/neogit/lua/neogit/lib/git/repository.lua:103: [REPO]: Initializing Repository
[neogit] [DEBUG 08:38:12] ...e/.local/share/nvim/lazy/neogit/lua/neogit/lib/state.lua:10: [STATE]: Reading file: '/Users/george/.local/state/nvim/neogit/%Users%george%code%analytics'
[neogit] [DEBUG 08:38:12] ...e/.local/share/nvim/lazy/neogit/lua/neogit/lib/state.lua:10: [STATE]: Loaded: '/Users/george/.local/state/nvim/neogit/%Users%george%code%analytics'
[neogit] [TRACE 08:38:17] ....local/share/nvim/lazy/neogit/lua/neogit/lib/git/cli.lua:871: [CLI]: Executing 'log': 'git --no-pager --literal-pathspecs --no-optional-locks -c core.preloadindex=true -c color.ui=always log --format={"sanitized_subject_line":"%f","rel_date":"%cr","author_name":"%aN","oid":"%H","commit_notes":"%N","tree":"%T","author_email":"%aE","subject":"%s","author_date":"%aD","committer_email":"%cE","committer_name":"%cN","ref_name":"%D","parent":"%P","abbreviated_parent":"%p","committer_date":"%cD","body":"%b","abbreviated_tree":"%t","encoding":"%e","abbreviated_commit":"%h","null":null}, --no-patch -- --max-count=256'
[neogit] [TRACE 08:38:17] ...rge/.local/share/nvim/lazy/neogit/lua/neogit/process.lua:363: [PROCESS] Spawning: { "git", "--no-pager", "--literal-pathspecs", "--no-optional-locks", "-c", "core.preloadindex=true", "-c", "color.ui=always", "log", '--format={"sanitized_subject_line":"%f","rel_date":"%cr","author_name":"%aN","oid":"%H","commit_notes":"%N","tree":"%T","author_email":"%aE","subject":"%s","author_date":"%aD","committer_email":"%cE","committer_name":"%cN","ref_name":"%D","parent":"%P","abbreviated_parent":"%p","committer_date":"%cD","body":"%b","abbreviated_tree":"%t","encoding":"%e","abbreviated_commit":"%h","null":null},', "--no-patch", "--", "--max-count=256" }
[neogit] [TRACE 08:38:17] ....local/share/nvim/lazy/neogit/lua/neogit/lib/git/cli.lua:634: [CLI] Execution of 'git --no-pager --literal-pathspecs --no-optional-locks -c core.preloadindex=true -c color.ui=always log --format={"sanitized_subject_line":"%f","rel_date":"%cr","author_name":"%aN","oid":"%H","commit_notes":"%N","tree":"%T","author_email":"%aE","subject":"%s","author_date":"%aD","committer_email":"%cE","committer_name":"%cN","ref_name":"%D","parent":"%P","abbreviated_parent":"%p","committer_date":"%cD","body":"%b","abbreviated_tree":"%t","encoding":"%e","abbreviated_commit":"%h","null":null}, --no-patch -- --max-count=256' succeeded in 45 ms
[neogit] [TRACE 08:38:17] ...rge/.local/share/nvim/lazy/neogit/lua/neogit/process.lua:76: [PROCESS] Preview buffer already exists. Focusing the existing one

And yes, running in my terminal

❯ git --no-pager --literal-pathspecs --no-optional-locks -c core.preloadindex=true -c color.ui=always log --format='{"sanitized_subject_line":"%f","rel_date":"%cr","author_name":"%aN","oid":"%H","commit_notes":"%N","tree":"%T","author_email":"%aE","subject":"%s","author_date":"%aD","committer_email":"%cE","committer_name":"%cN","ref_name":"%D","parent":"%P","abbreviated_parent":"%p","committer_date":"%c","body":"%b","abbreviated_tree":"%t","encoding":"%e","abbreviated_commit":"%h","null":null}', --no-patch -- --max-count=256

yields nothing

Adding README.md after --:

❯ git --no-pager --literal-pathspecs --no-optional-locks -c core.preloadindex=true -c color.ui=always log --format='{"sanitized_subject_line":"%f","rel_date":"%cr","author_name":"%aN","oid":"%H","commit_notes":"%N","tree":"%T","author_email":"%aE","subject":"%s","author_date":"%aD","committer_email":"%cE","committer_name":"%cN","ref_name":"%D","parent":"%P","abbreviated_parent":"%p","committer_date":"%c","body":"%b","abbreviated_tree":"%t","encoding":"%e","abbreviated_commit":"%h","null":null}', --no-patch -- README.md --max-count=256
{"sanitized_subject_line":"Run-acceptance-tests-together-with-the-normal-tests","rel_date":"4 months ago","author_name":"George Guimarães","oid":"b7d6f0cea89 ........

yields a lot of commits

So the problem seems to be that vim.fn.expand("%") is not being expanded to be the current file I'm in. Any thoughts?

[CKolkey]

ohh, ok, I'll have to dig into the argument forwarding. Thanks for the log, that helps

[georgeguimaraes]

Got it working!

vim.keymap.set("n", "<leader>gl", function()
  local file = vim.fn.expand("%")
  require("neogit").action("log", "log_current", { "--", file })()
end, { desc = "Neogit Log for this file" })

I had to move the expansion out of neogit's function.

[georgeguimaraes]

Tks @CKolkey!

[CKolkey]

Nice! Of course you had to wrap that in a closure 😅 Don't know how I missed that. The vim fn needs to be evaluated dynamically.

Cool idea :) think I'll steal it

[georgeguimaraes]

@CKolkey I think you're gonna love this too. I used git log -L to follow a range of changes for a visual range on nvim. Here's my complete lazy config. the keymap is the same, because the mode is different:

  {
    "NeogitOrg/neogit",
    event = "VeryLazy",
    dependencies = {
      "nvim-lua/plenary.nvim", -- required
      "sindrets/diffview.nvim", -- optional
      "nvim-telescope/telescope.nvim", -- optional
    },
    cmd = "Neogit",
    keys = {
      { "<leader>gn", "<cmd>Neogit<cr>", desc = "Neogit" },
      {
        "<leader>gl",
        function()
          local file = vim.fn.expand("%")
          vim.cmd([[execute "normal! \<ESC>"]])
          local line_start = vim.fn.getpos("'<")[2]
          local line_end = vim.fn.getpos("'>")[2]
          require("neogit").action("log", "log_current", { "-L" .. line_start .. "," .. line_end .. ":" .. file })()
        end,
        desc = "Neogit Log for this range",
        mode = "v",
      },
      {
        "<leader>gl",
        function()
          local file = vim.fn.expand("%")
          require("neogit").action("log", "log_current", { "--", file })()
        end,
        desc = "Neogit Log for this file",
      },
    },
    config = {
      graph_style = "unicode",
    },
  },

[CKolkey]

Definitely - thanks for sharing. It's always cool to see people use your stuff in new an interesting ways :D