Show the number of lines changed per file in working file tree view #4015

johannaschwarz · 2024-10-26T16:05:33Z

PR Description
Implements Issue Ability to see # of line changes in the diff window #3643
Adds the number of line changes to the end of each file line in the Files view.
Also adds the possibility for the user to enable and disable this feature through the UserConfig.

Please check if the PR fulfills these requirements

Cheatsheets are up-to-date (run go generate ./...)
Code has been formatted (see here)
Tests have been added/updated (see here for the integration test guide)
Text is internationalised (see here)
If a new UserConfig entry was added, make sure it can be hot-reloaded (see here)
Docs have been updated if necessary
You've read through your own file changes for silly mistakes etc

jesseduffield

This is really great. I support enabling this by default. I'm even open to not making it configurable. I've asked on twitter if anybody would want to disable it: https://x.com/DuffieldJesse/status/1855137711667167267

I've left some comments.

Keen to get your thoughts on this @stefanhaller @mark2185

pkg/commands/git_commands/config.go

jesseduffield · 2024-11-09T06:50:35Z

pkg/commands/git_commands/file_loader.go

@@ -100,6 +155,16 @@ type FileStatus struct {
 	PreviousName string
 }

+func (fileLoader *FileLoader) gitDiffNumStat() (string, error) {


Three things:

Just confirming that this can't be bundled into the git status command?

How expensive is this command to run? If it's expensive, we may need to run it asynchronously

I've noticed that this doesn't include untracked files. Is there a way to include those?

I did research on this and could not find any way to use git status for this.

I tested this for 18 files changed with about 6000 insertions and 3000 deletions:

on my M1 Pro the git diff --numstat command takes 62 milliseconds.

in comparison: the git status command takes 46 milliseconds.

What do you think performance-wise? Is it fast enough to run synchronously?

According to my research it is not possible to include untracked files in a git diff command. I don't think it is super important to include these, but it would probably be possible to determine the number of added lines another way for untracked files.

pkg/gui/presentation/files.go

stefanhaller · 2024-11-09T07:32:31Z

When I first briefly looked at it two weeks ago, my gut reaction was:

yes, looks nice, might be useful in some cases
it adds noise to the UI. Lazygit's UI is already quite noisy in some ways; I've observed new users not finding their way around it easily because it displays so much stuff
I'm worried about performance.

I haven't had time to come back to it since then, and have a closer look or even try it out myself, but currently my feeling is that I would keep it off by default. I'll see if I find some time this weekend to try it out, maybe this will change my mind. 😄

opus131 · 2024-11-09T15:00:36Z

Fantastic addition! Maybe also aggregate the counts for collapsed folders?

To address the concern regarding UI noise: maybe on by default with an option to disable it? OR even better, a keybinding to toggle the visibility.

VS Code has keybindings to toggle inlay-hints and code-lenses, and it's great to quickly show/hide extra-info on demand via a single keystroke.

mark2185 · 2024-11-09T15:21:14Z

I kinda agree with Stefan, I think I'd keep it off for the Staging panel, but I'd definitely like to have it for the commit panel when a commit is "focused" with Enter.

stefanhaller · 2024-11-10T09:38:24Z

I tried it for a bit now, and I have to say that I (personally) don't like it. The line changes information doesn't provide any value for me, I don't need to see it; but it makes the view considerably more noisy, so I'd definitely turn it off. So it does need to be configurable.

As to whether the option should be on or off by default, I don't have a strong opinion; I'd tend to make it off by default, like we do for the base branch divergence information in the branches view.

Also, there's a visual appearance problem related to the colors: the green/red coloring looks great for files that are either unstaged (white) or partially staged (yellow), but for staged files (green) there's not enough visual distinction between the file name and the +x. This is especially a problem when all files are staged. I don't have a constructive suggestion how this could be improved, just flagging it as a problem.

jesseduffield · 2024-11-11T10:53:53Z

Let's make it off-by-default. See this twitter thread for some user feedback.

Also, there's a visual appearance problem related to the colors: the green/red coloring looks great for files that are either unstaged (white) or partially staged (yellow), but for staged files (green) there's not enough visual distinction between the file name and the +x. This is especially a problem when all files are staged. I don't have a constructive suggestion how this could be improved, just flagging it as a problem.

I think this is a minor thing which doesn't need fixing.

johannaschwarz · 2024-11-11T12:41:13Z

Alright, let's do it that way. I also feel there are valid points for keeping it off by default.

I appreciate your input! I'll incorporate your feedback when I find the time.

Another point: @mark2185 mentioned the feature would be useful when focusing on a commit. This is not part of my current implementation. Should I add it?

stefanhaller · 2024-11-11T12:45:09Z

Another point: @mark2185 mentioned the feature would be useful when focusing on a commit. This is not part of my current implementation. Should I add it?

I think this would be good, I could see this as being more useful than in the Files panel. I think it should be a separate config option, people might want to turn it on for Commit Files but off for Files. And it could be done in a separate PR, of course.

johannaschwarz · 2024-11-30T11:51:38Z

@jesseduffield any chance you can have another look? 😄

stefanhaller

Ah sorry, I didn't realize this was ready for another review.

This is great work, looks very good to me. I found a few nits to pick (see below), but nothing major.

My biggest issue is the commit history, which is a bit of a mess tbh. First of all, please don't merge master into a feature branch; rebase onto master instead. And then, I like commits that are self-contained and atomic, so that the chain of commits tells a logical story. In this case, there might be one commit that adds the model, config, and file loader, and then a second commit that makes use of it in the UI. But you might also squash everything into just one commit, I guess.

pkg/commands/git_commands/file_loader.go

stefanhaller · 2024-11-30T13:30:40Z

docs/Config.md

@@ -164,6 +164,9 @@ gui:
  # This can be toggled from within Lazygit with the '~' key, but that will not change the default.
  showFileTree: true

+  # If true, show the number of lines changed per file in the Files view
+  showNumberOfLineChangesFilesView: false


Should we add "in" here, i.e. showNumberOfLineChangesInFilesView?

(I was also wondering if we should shorten this to showNumstatInFilesView, given that --numstat is the git option that is being used. But maybe that's too awkward in camel case.)

I changed it to showNumstatInFilesView. I like the shorter Version.

pkg/gui/presentation/files.go

pkg/gui/presentation/files_test.go

johannaschwarz · 2024-11-30T16:14:44Z

Thanks for your detailed input, I appreciate it!

My biggest issue is the commit history, which is a bit of a mess tbh. First of all, please don't merge master into a feature branch; rebase onto master instead. And then, I like commits that are self-contained and atomic, so that the chain of commits tells a logical story. In this case, there might be one commit that adds the model, config, and file loader, and then a second commit that makes use of it in the UI. But you might also squash everything into just one commit, I guess.

That's a valid point and I will do it this way in future commits. For this PR I will just squash it into a single commit.

stefanhaller · 2024-11-30T16:58:32Z

For this PR I will just squash it into a single commit.

Fine with me, please do.

@jesseduffield Do you also want to have another look at this? I'm very happy with the PR, I think it's ready to merge (with one tiny fixup still to be done).

One thing we didn't really decide yet is whether we keep the synchronous call to git diff --numstat. I would hope we can, since it makes things so much simpler. (And the code doesn't run when the option is disabled.)

jesseduffield

LGTM. Happy with the extra synchronous calls given the only apply when the setting is disabled

When enabled, it adds "+n -m" after each file in the Files panel to show how many lines were added and deleted, as with `git diff --numstat` on the command line.

This is a great feature that was implemented in jesseduffield/lazygit#4015 ❤️

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [jesseduffield/lazygit](https://github.com/jesseduffield/lazygit) | minor | `v0.44.1` -> `v0.45.2` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>jesseduffield/lazygit (jesseduffield/lazygit)</summary> ### [`v0.45.2`](https://github.com/jesseduffield/lazygit/releases/tag/v0.45.2) [Compare Source](jesseduffield/lazygit@v0.45.0...v0.45.2)  #### What's Changed ##### Enhancements 🔥 - Add ability to configure branch color patterns using regex by [@mtrajano](https://github.com/mtrajano) in jesseduffield/lazygit#4130 - Collapse/uncollapse all files in tree by [@mtrajano](https://github.com/mtrajano) in jesseduffield/lazygit#4131 - Improve undo action to restore files upon undoing a commit by [@gabriellanata](https://github.com/gabriellanata) in jesseduffield/lazygit#4167 ##### Fixes 🔧 - Bump gocui (and tcell) by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4166 ##### Maintenance ⚙️ - Cut a new release automatically each month by [@jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4146 - Bump tcell to fix broken deployment by [@jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4178 #### New Contributors - [@mtrajano](https://github.com/mtrajano) made their first contribution in jesseduffield/lazygit#4130 - [@gabriellanata](https://github.com/gabriellanata) made their first contribution in jesseduffield/lazygit#4167 **Full Changelog**: jesseduffield/lazygit@v0.45.0...v0.45.2 ### [`v0.45.0`](https://github.com/jesseduffield/lazygit/releases/tag/v0.45.0) [Compare Source](jesseduffield/lazygit@v0.44.1...v0.45.0)  Lots of great improvements in this one! Thanks to all the contributors who helped make this release happen. Apologies for the long waits between releases. As of jesseduffield/lazygit#4146 we're now (almost) guaranteed to do monthly releases. #### What's Changed ##### Enhancements 🔥 - Better branch delete confirmation by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#3915 - Add a menu item to delete both local and remote branch at once by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#3916 - Auto-render hyperlinks by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#3914 - Allow pasting commits multiple times by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#3983 - Add config option to disable switching tabs with panel jump keys (and disable by default) by [@hgreenstein](https://github.com/hgreenstein) in jesseduffield/lazygit#3927 - We jumped the gun on this change in the last release: having the number key both select a panel and switch tabs was bad for muscle memory so it's that behaviour is now disabled by default. - Add new filter to only show tracked files in Files panel by [@veremenko-y](https://github.com/veremenko-y) in jesseduffield/lazygit#4024 - Allow DiffContextSize to be decreased to zero by [@LuxxxLucy](https://github.com/LuxxxLucy) in jesseduffield/lazygit#4050 - Allow user to select remote and branch when creating a MR by [@moha-gh](https://github.com/moha-gh) in jesseduffield/lazygit#1889 - Delete range selection of branches by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4073 - Show the number of lines changed per file in working file tree view by [@johannaschwarz](https://github.com/johannaschwarz) in jesseduffield/lazygit#4015 - Drop merge commits by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4094 - Wrap lines in staging view by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4098 - Allow to switch branches in Commit View ([#4115](jesseduffield/lazygit#4115)) by [@seflue](https://github.com/seflue) in jesseduffield/lazygit#4117 - Allow on prem Azure DevOps Server pull request by [@waynebowie99](https://github.com/waynebowie99) in jesseduffield/lazygit#3954 - Add screen-mode command line argument by [@alewis001](https://github.com/alewis001) in jesseduffield/lazygit#4103 - Default to half-screen mode when opening with certain CLI args by [@jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4141 - Show the alt-enter keybinding at bottom of commit description view by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4136 - Add number of commits to cherry-pick confirmation prompt by [@brandondong](https://github.com/brandondong) in jesseduffield/lazygit#4158 ##### Fixes 🔧 - Fix copying commit author to clipboard by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#3936 - Fix merge conflict resolution when file doesn't end with a LF by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#3976 - Fix file icons by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#3975 - Fix non-sticky range select after clicking in staging view by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#3998 - Fix scroll position when entering staging view by clicking in the main view by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#3992 - Fix mouse wheel scrolling of custom patch view by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4089 - Improve editing a commit by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4090 - Use custom context size in range diff by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4082 - commits panel: add missing default sort order by [@phanirithvij](https://github.com/phanirithvij) in jesseduffield/lazygit#4097 - Fix issues with opening links and files using WSL by [@bottino](https://github.com/bottino) in jesseduffield/lazygit#3850 - Fix moving a commit across a branch boundary in a stack of branches by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4096 - Don't preserve commit message when it's unchanged from initial message by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4110 - Fix hang when returning from shell command by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4126 - Prevent killing of unrelated processes on windows by [@jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4137 - Add worktree option to fast forwarding operation by [@john-mutuma](https://github.com/john-mutuma) in jesseduffield/lazygit#4051 - Don't show keybindings option in bottom line when panel is open by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4143 - Fix reset/rebase to upstream by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4151 - Avoid blank line at end of view by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4152 - Adjust line number for working copy when editing a line by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4119 - Fix `micro` editor preset by [@kytta](https://github.com/kytta) in jesseduffield/lazygit#4156 - Use interactive shell for running shell commands only if shell is bash or zsh by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4159 ##### Maintenance ⚙️ - Add performance improvements section to release notes by [@jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#3922 - ci: update `upload-artifact` and `download-artifact` actions to v4 by [@Juneezee](https://github.com/Juneezee) in jesseduffield/lazygit#4063 - Let schema/config.json end with a line feed by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4092 - Saner view geometry by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4085 - Cleanup background fetch by [@stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4084 - remove duplicate secondary MouseWheelUp keybind by [@samueldominguez](https://github.com/samueldominguez) in jesseduffield/lazygit#4120 - enhancement: Use HEX colors on file icons instead of C256 colors by [@hasecilu](https://github.com/hasecilu) in jesseduffield/lazygit#4029 - chore: use errors.New to replace fmt.Errorf with no parameters by [@RiceChuan](https://github.com/RiceChuan) in jesseduffield/lazygit#4107 - Fix typos by [@NathanBaulch](https://github.com/NathanBaulch) in jesseduffield/lazygit#3920 - Bump crypto and net packages by [@jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4144 - Tweak file icons by [@jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4145 - Standardise on 'screen mode' naming convention by [@jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4142 ##### Docs 📖 - Fix installation for Ubuntu in README.md by [@shaobosong](https://github.com/shaobosong) in jesseduffield/lazygit#4031 - Fixes to lazygit Ubuntu install instructions in README.md by [@wrecklass](https://github.com/wrecklass) in jesseduffield/lazygit#3970 - Fix typos by [@skoch13](https://github.com/skoch13) in jesseduffield/lazygit#4121 - Add vision and design principles doc by [@jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4053 - docs: Stylize and correct the NixOS section in README.md by [@wadsaek](https://github.com/wadsaek) in jesseduffield/lazygit#4135 - Update chinese translation for pull requests by [@jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4140 - Set repology table to 3 columns by [@hasecilu](https://github.com/hasecilu) in jesseduffield/lazygit#4138 - Update instructions for using OSC52 with tmux by [@EliasA5](https://github.com/EliasA5) in jesseduffield/lazygit#3597 - Update docs to describe use of custom commands without keybindings by [@a-jentleman](https://github.com/a-jentleman) in jesseduffield/lazygit#3846 - documentation - describe os.openLink by [@smangels](https://github.com/smangels) in jesseduffield/lazygit#3094 - Clarify commit message prefix mechanics by [@zeromask1337](https://github.com/zeromask1337) in jesseduffield/lazygit#4114 #### New Contributors - [@shaobosong](https://github.com/shaobosong) made their first contribution in jesseduffield/lazygit#4031 - [@hgreenstein](https://github.com/hgreenstein) made their first contribution in jesseduffield/lazygit#3927 - [@wrecklass](https://github.com/wrecklass) made their first contribution in jesseduffield/lazygit#3970 - [@veremenko-y](https://github.com/veremenko-y) made their first contribution in jesseduffield/lazygit#4024 - [@LuxxxLucy](https://github.com/LuxxxLucy) made their first contribution in jesseduffield/lazygit#4050 - [@phanirithvij](https://github.com/phanirithvij) made their first contribution in jesseduffield/lazygit#4097 - [@bottino](https://github.com/bottino) made their first contribution in jesseduffield/lazygit#3850 - [@johannaschwarz](https://github.com/johannaschwarz) made their first contribution in jesseduffield/lazygit#4015 - [@samueldominguez](https://github.com/samueldominguez) made their first contribution in jesseduffield/lazygit#4120 - [@skoch13](https://github.com/skoch13) made their first contribution in jesseduffield/lazygit#4121 - [@wadsaek](https://github.com/wadsaek) made their first contribution in jesseduffield/lazygit#4135 - [@seflue](https://github.com/seflue) made their first contribution in jesseduffield/lazygit#4117 - [@waynebowie99](https://github.com/waynebowie99) made their first contribution in jesseduffield/lazygit#3954 - [@EliasA5](https://github.com/EliasA5) made their first contribution in jesseduffield/lazygit#3597 - [@alewis001](https://github.com/alewis001) made their first contribution in jesseduffield/lazygit#4103 - [@a-jentleman](https://github.com/a-jentleman) made their first contribution in jesseduffield/lazygit#3846 - [@john-mutuma](https://github.com/john-mutuma) made their first contribution in jesseduffield/lazygit#4051 - [@RiceChuan](https://github.com/RiceChuan) made their first contribution in jesseduffield/lazygit#4107 - [@NathanBaulch](https://github.com/NathanBaulch) made their first contribution in jesseduffield/lazygit#3920 **Full Changelog**: jesseduffield/lazygit@v0.44.1...v0.45.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

jesseduffield reviewed Nov 9, 2024

View reviewed changes

johannaschwarz requested a review from jesseduffield November 14, 2024 16:43

johannaschwarz force-pushed the line-changes branch from fde21da to 913d026 Compare November 14, 2024 19:54

stefanhaller reviewed Nov 30, 2024

View reviewed changes

stefanhaller added the enhancement New feature or request label Nov 30, 2024

johannaschwarz force-pushed the line-changes branch from 46abec9 to ae774f0 Compare November 30, 2024 16:57

johannaschwarz requested a review from stefanhaller November 30, 2024 17:18

johannaschwarz force-pushed the line-changes branch from ae774f0 to db0dfe0 Compare November 30, 2024 17:39

jesseduffield approved these changes Dec 8, 2024

View reviewed changes

Add user config gui.showNumstatInFilesView

f455f99

When enabled, it adds "+n -m" after each file in the Files panel to show how many lines were added and deleted, as with `git diff --numstat` on the command line.

stefanhaller force-pushed the line-changes branch from db0dfe0 to f455f99 Compare December 8, 2024 11:10

stefanhaller merged commit 4a7cf60 into jesseduffield:master Dec 8, 2024
15 of 16 checks passed

stefanhaller mentioned this pull request Dec 8, 2024

Ability to see # of line changes in the diff window #3643

Closed

mikavilpas added a commit to mikavilpas/dotfiles that referenced this pull request Dec 8, 2024

feat(lazygit): show num of changed lines in the files view

91f7e0e

This is a great feature that was implemented in jesseduffield/lazygit#4015 ❤️

johannaschwarz deleted the line-changes branch December 12, 2024 13:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show the number of lines changed per file in working file tree view #4015

Show the number of lines changed per file in working file tree view #4015

johannaschwarz commented Oct 26, 2024

jesseduffield left a comment

jesseduffield Nov 9, 2024

johannaschwarz Nov 14, 2024

stefanhaller commented Nov 9, 2024

opus131 commented Nov 9, 2024

mark2185 commented Nov 9, 2024

stefanhaller commented Nov 10, 2024

jesseduffield commented Nov 11, 2024

johannaschwarz commented Nov 11, 2024

stefanhaller commented Nov 11, 2024

johannaschwarz commented Nov 30, 2024

stefanhaller left a comment

stefanhaller Nov 30, 2024

johannaschwarz Nov 30, 2024

johannaschwarz commented Nov 30, 2024

stefanhaller commented Nov 30, 2024

jesseduffield left a comment

Show the number of lines changed per file in working file tree view #4015

Show the number of lines changed per file in working file tree view #4015

Conversation

johannaschwarz commented Oct 26, 2024

jesseduffield left a comment

Choose a reason for hiding this comment

jesseduffield Nov 9, 2024

Choose a reason for hiding this comment

johannaschwarz Nov 14, 2024

Choose a reason for hiding this comment

stefanhaller commented Nov 9, 2024

opus131 commented Nov 9, 2024

mark2185 commented Nov 9, 2024

stefanhaller commented Nov 10, 2024

jesseduffield commented Nov 11, 2024

johannaschwarz commented Nov 11, 2024

stefanhaller commented Nov 11, 2024

johannaschwarz commented Nov 30, 2024

stefanhaller left a comment

Choose a reason for hiding this comment

stefanhaller Nov 30, 2024

Choose a reason for hiding this comment

johannaschwarz Nov 30, 2024

Choose a reason for hiding this comment

johannaschwarz commented Nov 30, 2024

stefanhaller commented Nov 30, 2024

jesseduffield left a comment

Choose a reason for hiding this comment