Add flag to include author information in recent commits

[PriceHiller]

This PR does the following:

• Adds capability to show author name and email in recent commits
  • By default this is disabled, it can be enabled by setting status.recent_commits_include_author_info to true
• Adds syntax matching for recent commit messages to color this new information
• Adds tests to cover this new functionality and prior functionality that wasn't being tested
• Updates the Readme to reflect the new flag

See below for how the recent commits look with the author information included:

Closes #652 😌

[PriceHiller]

Ok, I'm losing sanity. This Works On My Machine™, but fails in the CI.

The recent commits section should have the number of recent commits in it, right?

Mine looks like so:

I'm assuming that in between those parentheses should be the number of recent commits as found by status.recent_commit_count. Should be embedded on this line over here:

neogit/lua/neogit/status.lua

Line 206 in 3d63d76

output:append(string.format("%s (%d)", header, #data.items))

The only reason the "Recent commits" message would have more than 10 is if this line

neogit/lua/neogit/lib/git/log.lua

Line 268 in 3d63d76

local result = M.list({ "--max-count=" .. tostring(count) }, false)

--max-count flag is somehow receiving a different number than config.values.status.recent_commit_count.

I'm not sure how this is happening, but it's driving me up a wall. Any idea @CKolkey @ten3roberts?

[CKolkey]

What would be REALLY cool is to work towards how magit handles this:

(If you don't have emacs installed, I recommend grabbing DOOM emacs to use as a reference.)

^^ Thats the Log Margin popup https://magit.vc/manual/magit/Log-Margin.html

L opens this popup. And, if you want, you can implement the functions of that popup incrementally. The two at the bottom right (s, w) don't really mean anything to neogit since we don't set defaults for stuff across projects yet, at least independant of how a user scopes state.

Using "toggle details" can turn on showing the author name:

I think it would be super cool to implement this as the config mechanism instead of have it be hard-coded config values. You can use the state module to write/read persistent values. And an easy way to do perfect right-aligned text is with virtual text - thats how I did in the reflog view.

It also seems like magit shows the recent commits across all branches, which would be really cool to copy. Then we can show the remote/branch for the commit too.. That doesn't need to be part of this change, just had never noticed that before.

[CKolkey]

Ok, I'm losing sanity. This Works On My Machine™, but fails in the CI.

The recent commits section should have the number of recent commits in it, right?

Mine looks like so:

I'm assuming that in between those parentheses should be the number of recent commits as found by status.recent_commit_count. Should be embedded on this line over here:

neogit/lua/neogit/status.lua

Line 206 in 3d63d76

output:append(string.format("%s (%d)", header, #data.items))

The only reason the "Recent commits" message would have more than 10 is if this line

neogit/lua/neogit/lib/git/log.lua

Line 268 in 3d63d76

local result = M.list({ "--max-count=" .. tostring(count) }, false)

--max-count flag is somehow receiving a different number than config.values.status.recent_commit_count.
I'm not sure how this is happening, but it's driving me up a wall. Any idea @CKolkey @ten3roberts?

Hmm. That seems right to me. Whats the actual number being shown in CI?

[PriceHiller]

Ok, I'm losing sanity. This Works On My Machine™, but fails in the CI.
The recent commits section should have the number of recent commits in it, right?
Mine looks like so:
I'm assuming that in between those parentheses should be the number of recent commits as found by status.recent_commit_count. Should be embedded on this line over here:

neogit/lua/neogit/status.lua

Line 206 in 3d63d76

output:append(string.format("%s (%d)", header, #data.items))

The only reason the "Recent commits" message would have more than 10 is if this line

neogit/lua/neogit/lib/git/log.lua

Line 268 in 3d63d76

local result = M.list({ "--max-count=" .. tostring(count) }, false)

--max-count flag is somehow receiving a different number than config.values.status.recent_commit_count.
I'm not sure how this is happening, but it's driving me up a wall. Any idea @CKolkey @ten3roberts?

Hmm. That seems right to me. Whats the actual number being shown in CI?

CI is getting 51 back instead of 10 for that.

[PriceHiller]

What would be REALLY cool is to work towards how magit handles this:

(If you don't have emacs installed, I recommend grabbing DOOM emacs to use as a reference.)

^^ Thats the Log Margin popup https://magit.vc/manual/magit/Log-Margin.html

L opens this popup.

Using "toggle details" can turn on showing the author name:

I think it would be super cool to implement this as the config mechanism instead of have it be hard-coded config values. You can use the state module to write/read persistent values. And an easy way to do perfect right-aligned text is with virtual text - thats how I did in the reflog view.

It also seems like magit shows the recent commits across all branches, which would be really cool to copy. Then we can show the remote/branch for the commit too.. That doesn't need to be part of this change, just had never noticed that before.

That's neat, I used emacs for a while, but stuck to CLI git. My exposure to Magit is entirely via Neogit.

I'll see what it'll take to replicate that.

[CKolkey]

That's neat, I used emacs for a while, but stuck to CLI git. My exposure to Magit is entirely via Neogit.

I'll see what it'll take to replicate that.

Haha, no kidding. My only exposure to emacs is for referencing stuff to implement in Neogit.

It should be pretty simple to add the popup. You'll need:

popups/log_margin/init.lua
popups/log_margin/actions.lua

Just copy the pattern used by all the other popups. actions exports each function of the popup as a function. For testing, only the branch popup's actions are properly wrapped by the operations module. Thats a decent reference.

Otherwise, as you'll see, each action takes the popup as it's first/only argument, and the popup object has popup:get_arguments()
to see which config/options are enabled. Other than that, it should be pretty simple. @ten3roberts just updated the popups api so you should need to add fewer references to get this referenced in multiple places.

The init.lua just uses a builder to add all the config/options/flags/actions. -n is an option, -o is a config, and -g, -c, -d are switches. Don't worry about adding all of them now.

[PriceHiller]

Cool!

I guess I'll make this my next goal with Neogit -- nice stuff for the recent commits buffer.

This is gonna take a minute... well into the breach I go.

[PriceHiller]

Closing this in favor of a full fledged popup PR.

[CKolkey]

It's a breaking change, but changing the log popup to l and taking L for this is fine. I'd like to align with magit as much as is reasonable.