git-gui: allow opening currently selected file #499

gitgitgadget · 2019-12-27T19:39:56Z

On the Git mailing list, Pratyush Yadav wrote (reply to this):

Hi Zoli, Thanks for the patch. On 26/12/19 07:01PM, Zoli Szab� via GitGitGadget wrote: > From: =?UTF-8?q?Zoli=20Szab=C3=B3?= <[email protected]> > > ...in the default associated app (e.g. in a text editor / IDE). > > Many times there's the need to quickly open a source file (the one you're > looking at in Git GUI) in the predefined text editor / IDE. Of course, > the file can be searched for in your preferred file manager or directly > in the text editor, but having the option to directly open the current > file from Git GUI would be just faster. This change enables just that by: > - Diff header path context menu -> Open; Would it be a better idea to have this option in the diff body context menu (.vpane.lower.diff.body.ctxm) instead? The problem I see with the way its currently done is visibility/discovery. It is not very likely for a user to try and click the file name which doesn't give any indication that it is clickable. So how will someone who hasn't read this commit message know that they can use this neat feature. The diff body context menu is much more "visible" IMO. > - or double-clicking the diff header path. An alternative to the above suggestion would be to make this path underlined and blue in color (like a hyperlink in a web browser). This will give the indication that this is not just plain text. I like the latter idea more, but I don't mind either. > One "downside" of the approach is that executable files will be run > and not opened for editing. FWIW, I do not see it as a downside at all. The menu option is called "open" not "edit". So if you click it, you should expect the file to open. In case its a binary file, executing it is the correct outcome. In case its a text file, opening it in the editor is the correct outcome. > Signed-off-by: Zoli Szab� <[email protected]> > --- > git-gui.sh | 26 ++++++++++++++++++++++++-- > 1 file changed, 24 insertions(+), 2 deletions(-) > > diff --git a/git-gui.sh b/git-gui.sh > index c1be733e3e..705b97f7ab 100755 > --- a/git-gui.sh > +++ b/git-gui.sh > @@ -2248,8 +2248,8 @@ proc do_git_gui {} { > } > } > > -proc do_explore {} { > - global _gitworktree > +# Get the system-specific explorer app/command. > +proc get_explorer {} { > set explorer {} Not exactly related to this patch, but this line is redundant. No point in clearing 'explorer' only to set it in the very next if-else chain. > if {[is_Cygwin] || [is_Windows]} { > set explorer "explorer.exe" > @@ -2259,9 +2259,25 @@ proc do_explore {} { > # freedesktop.org-conforming system is our best shot > set explorer "xdg-open" > } > + return $explorer > +} > + > +proc do_explore {} { > + global _gitworktree > + set explorer [get_explorer] > eval exec $explorer [list [file nativename $_gitworktree]] & > } > > +# Trigger opening a file (relative to the working tree) by the default > +# associated app of the OS (e.g. a text editor or IDE). Nitpick: This comment doesn't really add a whole lot of information. The procedure name already make it pretty clear that it will open a file. And it is pretty easy to understand from reading the body of the procedure that it will be relative to the working tree. So, I think it can be removed altogether. But even if you think it should stay, please at least make it more concise. Maybe something like: Open file relative to the working tree by the default associated app. > +# FIXME: What about executables (will be run, not opened for editing)? Again, I think running the executables is the correct behaviour. So I don't think this needs any fixing. > +proc do_file_open {file} { > + global _gitworktree > + set explorer [get_explorer] > + set full_file_path [file join $_gitworktree $file] > + eval exec $explorer [list [file nativename $full_file_path]] & This executes $explorer, which is 'explorer.exe' on Windows. I'm not a heavy Windows user but AFAIK it is a file manager. This makes it quite different from 'xdg-open' which is used to open _any_ file/URL in the user's default application. So it also happens to open _directories_ in the default file explorer which was the original intention of this procedure. Have you tested it on Windows? Does 'explorer.exe' do the correct thing? Looking at MacOS's 'open' man page, I think it should also work like xdg-open and shouldn't be a problem. > +} > + > set is_quitting 0 > set ret_code 1 > > @@ -3530,8 +3546,14 @@ $ctxm add command \ > -type STRING \ > -- $current_diff_path > } > +$ctxm add command \ > + -label [mc Open] \ > + -command { > + do_file_open $current_diff_path > + } Nitpick: no need to make the command multi-line. So, change it to something like: -command {do_file_open $current_diff_path} > lappend diff_actions [list $ctxm entryconf [$ctxm index last] -state] > bind_button3 .vpane.lower.diff.header.path "tk_popup $ctxm %X %Y" > +bind .vpane.lower.diff.header.path <Double-1> {do_file_open $current_diff_path} > > # -- Diff Body > # Tested on Linux. Works fine. Looking forward to the re-roll. -- Regards, Pratyush Yadav

On the Git mailing list, Junio C Hamano wrote (reply to this):

Pratyush Yadav <[email protected]> writes: > Have you tested it on Windows? Does 'explorer.exe' do the correct thing? > > Looking at MacOS's 'open' man page, I think it should also work like > xdg-open and shouldn't be a problem. > ... > Tested on Linux. Works fine. Looking forward to the re-roll. > Subject: Re: [PATCH 1/1] git-gui: add possibility to open currently selected file The phrasing on the title is a bit awkward. "add possibility to do X" is better spelled "allow doing X", no?

On the Git mailing list, Zoli Szabó wrote (reply to this):

Hi Pratyush, Thanks for your thorough review. On 2019.12.27 21:34, Pratyush Yadav wrote: >> ...This change enables just that by: >> - Diff header path context menu -> Open; > > Would it be a better idea to have this option in the diff body context > menu (.vpane.lower.diff.body.ctxm) instead? The problem I see with the > way its currently done is visibility/discovery. It is not very likely > for a user to try and click the file name which doesn't give any > indication that it is clickable. So how will someone who hasn't read > this commit message know that they can use this neat feature. The diff > body context menu is much more "visible" IMO. > >> - or double-clicking the diff header path. > > An alternative to the above suggestion would be to make this path > underlined and blue in color (like a hyperlink in a web browser). This > will give the indication that this is not just plain text. > > I like the latter idea more, but I don't mind either. For me, the body context menu holds the diff-related options, I am not sure the "Open" fits in there. But I do like your suggestion of making the filename web browser-link-like. I'll try to implement that. >> One "downside" of the approach is that executable files will be run >> and not opened for editing. > > FWIW, I do not see it as a downside at all. The menu option is called > "open" not "edit". So if you click it, you should expect the file to > open. In case its a binary file, executing it is the correct outcome. In > case its a text file, opening it in the editor is the correct outcome. Alright then. >> +proc do_file_open {file} { >> + global _gitworktree >> + set explorer [get_explorer] >> + set full_file_path [file join $_gitworktree $file] >> + eval exec $explorer [list [file nativename $full_file_path]] & > > This executes $explorer, which is 'explorer.exe' on Windows. I'm not a > heavy Windows user but AFAIK it is a file manager. This makes it quite > different from 'xdg-open' which is used to open _any_ file/URL in the > user's default application. So it also happens to open _directories_ in > the default file explorer which was the original intention of this > procedure. > > Have you tested it on Windows? Does 'explorer.exe' do the correct thing? > > Looking at MacOS's 'open' man page, I think it should also work like > xdg-open and shouldn't be a problem. I am in fact working on this patch on Windows. explorer.exe works also for files and even brings up the "Open with..." dialog for not-recognized file types. > Tested on Linux. Works fine. Looking forward to the re-roll. Thanks for testing it on Linux. Since I am working on Windows, I just read about `xdg-open` and `open` and assumed everything should work OK. All other points I agree with you and will push a new version of the patch. Thanks, Zoli

On the Git mailing list, Zoli Szabó wrote (reply to this):

On 2019.12.28 00:32, Junio C Hamano wrote: > The phrasing on the title is a bit awkward. "add possibility to do > X" is better spelled "allow doing X", no? Thank you, Junio, for the hint. Updated the commit message accordingly (PATCH v2).

On the Git mailing list, Junio C Hamano wrote (reply to this):

Zoli SzabÃ³ <[email protected]> writes: > On 2019.12.28 00:32, Junio C Hamano wrote: > >> The phrasing on the title is a bit awkward. "add possibility to do >> X" is better spelled "allow doing X", no? > > Thank you, Junio, for the hint. Updated the commit message accordingly > (PATCH v2). Also, do not start the body of the proposed log message with half sentence. The title is supposed to be a full sentence.

On the Git mailing list, Zoli Szabó wrote (reply to this):

Adapted the commit message once again (PATCH v3). On 2019.12.30 01:14, Junio C Hamano wrote: > Zoli Szabó <[email protected]> writes: > >> On 2019.12.28 00:32, Junio C Hamano wrote: >> >>> The phrasing on the title is a bit awkward. "add possibility to do >>> X" is better spelled "allow doing X", no? >> >> Thank you, Junio, for the hint. Updated the commit message accordingly >> (PATCH v2). > > Also, do not start the body of the proposed log message with half > sentence. The title is supposed to be a full sentence. > > >

gitgitgadget · 2019-12-30T19:44:05Z

On the Git mailing list, Pratyush Yadav wrote (reply to this):

Hi Zoli, On 30/12/19 03:56PM, Zoli Szab� via GitGitGadget wrote: > From: =?UTF-8?q?Zoli=20Szab=C3=B3?= <[email protected]> > > Many times there's the need to quickly open a source file (the one you're > looking at in Git GUI) in the predefined text editor / IDE. Of course, > the file can be searched for in your preferred file manager or directly > in the text editor, but having the option to directly open the current > file from Git GUI would be just faster. This change enables just that by: > - clicking the diff header path (which is now highlighted as a hyperlink) > - or diff header path context menu -> Open; Semi-colon left in by mistake? > > Note: executable files will be run and not opened for editing. > > Signed-off-by: Zoli Szab� <[email protected]> > --- > git-gui.sh | 29 ++++++++++++++++++++++++----- > 1 file changed, 24 insertions(+), 5 deletions(-) > > diff --git a/git-gui.sh b/git-gui.sh > index c1be733e3e..8920e4ddb0 100755 > --- a/git-gui.sh > +++ b/git-gui.sh > @@ -2259,9 +2258,23 @@ proc do_explore {} { > +# Open file relative to the working tree by the default associated > app. > +proc do_file_open {file} { > + global _gitworktree > + set explorer [get_explorer] > + set full_file_path [file join $_gitworktree $file] > + eval exec $explorer [list [file nativename $full_file_path]] & IIUC, this line can be simplified to: exec $explorer [file nativename $full_file_path] & It works fine for me including on files with spaces in their names, but a test on Windows would be appreciated just to rule out any hidden surprises. No need to send a re-roll just for these two small things. I have updated the commit locally before pushing the new version out [0]. The rest of the patch looks good. Will merge. Thanks. > +} > + > set is_quitting 0 > set ret_code 1 > [0] https://github.com/prati0100/git-gui/tree/zs/open-current-file -- Regards, Pratyush Yadav

On the Git mailing list, Zoli Szabó wrote (reply to this):

On 2019.12.30 21:41, Pratyush Yadav wrote: > Hi Zoli, > > On 30/12/19 03:56PM, Zoli Szabó via GitGitGadget wrote: >> From: =?UTF-8?q?Zoli=20Szab=C3=B3?= <[email protected]> >> >> Many times there's the need to quickly open a source file (the one you're >> looking at in Git GUI) in the predefined text editor / IDE. Of course, >> the file can be searched for in your preferred file manager or directly >> in the text editor, but having the option to directly open the current >> file from Git GUI would be just faster. This change enables just that by: >> - clicking the diff header path (which is now highlighted as a hyperlink) >> - or diff header path context menu -> Open; > > Semi-colon left in by mistake? > Yes, that should have been a simple period (.), signaling the end of the sentence. >> + eval exec $explorer [list [file nativename $full_file_path]] & > > IIUC, this line can be simplified to: > > exec $explorer [file nativename $full_file_path] & > > It works fine for me including on files with spaces in their names, but > a test on Windows would be appreciated just to rule out any hidden > surprises. You're right. It can be simplified like you have proposed. Tested it and works correctly also on Windows. (Since I have copied that line from the existing `do_explore` proc, the same simplification can be done there too. (I did not realize this myself, since I am just learning some TCL in order to have this feature in Git GUI...)) > > No need to send a re-roll just for these two small things. I have > updated the commit locally before pushing the new version out [0]. The > rest of the patch looks good. Will merge. Thanks. > > [0] https://github.com/prati0100/git-gui/tree/zs/open-current-file > Thank you very much for your support! All the best, Zoli

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

git-gui: allow opening currently selected file #499

Uh oh!

Diff view

Diff view

There are no files selected for viewing

gitgitgadget bot Dec 27, 2019

Uh oh!

gitgitgadget bot Dec 27, 2019

Uh oh!

gitgitgadget bot Dec 29, 2019

Uh oh!

gitgitgadget bot Dec 29, 2019

Uh oh!

gitgitgadget bot Dec 29, 2019

Uh oh!

gitgitgadget bot Dec 30, 2019

Uh oh!

gitgitgadget bot Dec 30, 2019

Uh oh!

gitgitgadget bot Dec 30, 2019

Uh oh!

-Original file line number
+Diff line change
@@ Expand Up / @@ -2248,9 +2248,8 @@ proc do_git_gui {} { @@
     	}
     }
-    proc do_explore {} {
-    	global _gitworktree
-    	set explorer {}
+    # Get the system-specific explorer app/command.
+    proc get_explorer {} {
     	if {[is_Cygwin] || [is_Windows]} {
     		set explorer "explorer.exe"
     	} elseif {[is_MacOSX]} {
@@ Expand All / @@ -2259,7 +2258,21 @@ proc do_explore {} { @@
     		# freedesktop.org-conforming system is our best shot
     		set explorer "xdg-open"
     	}
-    	eval exec $explorer [list [file nativename $_gitworktree]] &
+    	return $explorer
+    }
+    proc do_explore {} {
+    	global _gitworktree
+    	set explorer [get_explorer]
+    	exec $explorer [file nativename $_gitworktree] &
+    }
+    # Open file relative to the working tree by the default associated app.
+    proc do_file_open {file} {
+    	global _gitworktree
+    	set explorer [get_explorer]
+    	set full_file_path [file join $_gitworktree $file]
+    	exec $explorer [file nativename $full_file_path] &
     }
     set is_quitting 0
@@ Expand Down Expand Up / @@ -3513,9 +3526,11 @@ tlabel .vpane.lower.diff.header.file \ @@
     	-justify left
     tlabel .vpane.lower.diff.header.path \
     	-background gold \
-    	-foreground black \
+    	-foreground blue \
     	-anchor w \
-    	-justify left
+    	-justify left \
+    	-font [eval font create [font configure font_ui] -underline 1] \
+    	-cursor hand2
     pack .vpane.lower.diff.header.status -side left
     pack .vpane.lower.diff.header.file -side left
     pack .vpane.lower.diff.header.path -fill x
@@ Expand All / @@ -3530,8 +3545,12 @@ $ctxm add command \ @@
     			-type STRING \
     			-- $current_diff_path
     	}
+    $ctxm add command \
+    	-label [mc Open] \
+    	-command {do_file_open $current_diff_path}
     lappend diff_actions [list $ctxm entryconf [$ctxm index last] -state]
     bind_button3 .vpane.lower.diff.header.path "tk_popup $ctxm %X %Y"
+    bind .vpane.lower.diff.header.path <Button-1> {do_file_open $current_diff_path}
     # -- Diff Body
     #
@@ Expand Down @@

git-gui: allow opening currently selected file #499

Are you sure you want to change the base?

Uh oh!

git-gui: allow opening currently selected file #499

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

gitgitgadget bot Dec 27, 2019

Choose a reason for hiding this comment

Uh oh!

gitgitgadget bot Dec 27, 2019

Choose a reason for hiding this comment

Uh oh!

gitgitgadget bot Dec 29, 2019

Choose a reason for hiding this comment

Uh oh!

gitgitgadget bot Dec 29, 2019

Choose a reason for hiding this comment

Uh oh!

gitgitgadget bot Dec 29, 2019

Choose a reason for hiding this comment

Uh oh!

gitgitgadget bot Dec 30, 2019

Choose a reason for hiding this comment

Uh oh!

gitgitgadget bot Dec 30, 2019

Choose a reason for hiding this comment

Uh oh!

gitgitgadget bot Dec 30, 2019

Choose a reason for hiding this comment

Uh oh!