feat: commit component #1027
feat: commit component #1027
Conversation
By grepping in the bash, and not reading whole diff output to memory.
|
This looks quite interesting. I'm in favor of adding this component in general. There are a decent amount of changes in this pr it'll take me a while to review the whole thing. |
|
Hey, any chance of getting this merged? |
|
Just found this via search and bumping this, so it does not go lost amidst all the other open PRs. This is indeed would indeed be a great feature to have. |
|
@gzbd just gave your fork a try and so far, it looks good to me. Since your fork does not allow issues, and in the hope of taking some burden from shadmansaleh, some feedback on some minor things (only from a user perspective, haven't looked at the code)
|
|
@chrisgrieser thanks for the feedback. I'll work on this over the weekend |
| } | ||
|
|
||
| local default_options = { | ||
| icon = '', |
There was a problem hiding this comment.
I think if user sets icon option to empty string icon would go away
There was a problem hiding this comment.
Indeed, you are right. Thanks!
In that case, this is just a case of the icon not being documented in the component options.
| lualine_a = { | ||
| { | ||
| 'commit', | ||
| master_name = 'master', -- Default master branch name, some repositories use `main`. |
There was a problem hiding this comment.
you should mention you're setting a default value for icon option
README.md
Outdated
| unpushed_icon = '⇡ ', -- Icon shown for unpushed changes on current branch. | ||
| use_check_icon = true, -- Use checkmark icon, instead of `0`. | ||
| check_icon = '', -- Icon to display check mark instead of `0`. | ||
| show_only_diverged = false, -- Don't show `0` or check mark if up to date. |
| end | ||
|
|
||
| function M.get_master_name(cwd, callback) | ||
| M._run_job("git remote show origin | grep 'HEAD branch' | cut -d' ' -f5", cwd, function(exit_code, output, _) |
There was a problem hiding this comment.
why not take the output of the command than process it in lua instead of running grep and cut. that way we can drop the pipes and sh -c
| end) | ||
| end | ||
|
|
||
| function M.check_for_conflict(cwd, source, target, callback) |
There was a problem hiding this comment.
it feels like this might get expensive
There was a problem hiding this comment.
This might get expensive when comparing large diffs involving hundreds of commits. The diff operation is done by git itself and it's done in the memory (no disk writes), so I cannot speed this up. One thing that comes to my mind is to add a setting disabling this feature by the users if unwanted.
| end) | ||
| end | ||
|
|
||
| function M.commit_diff(cwd, source, target, callback) |
There was a problem hiding this comment.
Does this do same as git rev-list --count --left-right HEAD...@{upstream} ?
There was a problem hiding this comment.
Yes, I'll make a change to use this command as it produces less output.
|
|
||
| function M.check_for_conflict(cwd, source, target, callback) | ||
| local cmd = | ||
| string.format([[git merge-tree `git merge-base %s %s` %s %s | grep '<<<<<<<']], source, target, target, source) |
There was a problem hiding this comment.
same here pipes can be removed I think
|
One issue I noted with the Yesterday, github was intermittently down, resulting in various git operation failing when called in the terminal. In my nvim, the result was quite peculiar, since I got a lot of errors from various plugins like My guess what happened is that the edit: false alarm, it was actually the other way round, a bug in |
|
Hey, I applied some changes as requested. Can you take a look? |
|
@gzbd I totally forgot about this one. I was looking and saw this component lol. Do you remember if there was anything major that was to be done in this component. I still like this component and would love to merge it in. |
Hi,
This PR adds a new component called
commitwhich displays the difference in commits count between the current branch and the upstream or master branch. It's useful to get a visual indication in the editor that some commits are available in origin.This is what the component looks like, next to the branch component. First, with the red color, you can see that there are 2 commits in the master branch that are conflicting, then with the gray color, you see that no commits to pull are available, and lastly, you can see that one commit is not pushed to the current branch remote (no conflict with remote).
To get updates on new commits the component watches some files in the
.git/dir. Also, thegit fetchcommand is run from time to time to get new commits on the remote. Only the current buffer repo is actively watched. Watch on previously discovered repositories (when many buffers from different repositories are loaded) is suspended, and resumed onBufEnter. This approach makes git commands run in the repository (outside of the neovim) to be reflected in the editor.I took some code and a general approach from the
branchcomponent. I think that thefind_git_dirfunction could be shared between those two.I've been using this component for about a week and looks good. This component, probably will not work on Windows due to the use of
sh -cand pipes. I'm not sure if I did everything in the right way in Lua, if not please comment.