Implement Git context menu in the file browser

[krassowski]

Fixes #774

Changes:

• Added Git context menu in File Browser
• Reworked the context commands to accept multiple files (as multiple files can be selected in the file browser)
• Added icons to the commands (they also display in the context menu of the Git panel widget)
• The old context menu and new context menu share the same commands and the same status assignments (the "open" command is not shown in the file browser as redundant to the browser capabilities); EDIT: "delete" is no longer shown either (GIF was not updated)
• Fixed a typo (_getPathRespository)
• Formalize types:
  • for context commands (as distinct from other commands): ContextCommandIDs
  • for context commands' arguments (as those were already being cast in type-unsafe way and I needed to change them all): CommandArguments

The Git panel context menu got icons (updated):

[github-actions]

👈 Launch a binder notebook on branch krassowski/jupyterlab-git/add-browser-context-menu

[krassowski]

Nice binder badge action. I am not sure what rank should the Git menu have (should it be lower or higher?). I just randomly used 5 and it seems like a good position for me but might be sub-optimal.

[krassowski]

This is also a significant step towards #379.

[ianhi]

I really like this - thanks for working on this!

The Git panel context menu got icons:

❤️

The old context menu and new context menu share the same commands and the same status assignments (the "open" command is not shown in the file browser as redundant to the browser capabilities)

Perhaps the git menu shouldn't have delete as that is also redundant?

Also this made me realize that maybe for delete on untracked files we should use the same x as the file browser rather than the - that is used for unstage.

[krassowski]

I changed the icon for delete, I think that it was me who wrongly assigned it and it was not used like that before. I also agree that delete should not be shown in the file browser context menu - changed it now too.

Also now tested that it works with git repository which is not in the JupyterLab root:

See GIF

Outside of a git repository:

See GIF

Or within the git repository but when no action is available (which happens for files that are tracked but not changed, as jupyterlab-git does not implement git rm nor any other relevant command):

See GIF

[fcollonval]

Thanks for this awesome PR @krassowski

The change for the delete icon is welcomed indeed.

I am not sure what rank should the Git menu have (should it be lower or higher?)

I don't have any preferences neither. The current position seems ok for me too.

Some comments:

• In the Git panel context menu, it looks like the icon are not vertically center with the text (they are a bit up). Is it possible to correct that?
• I have an error when opening the diff for multiple files at once. Only one diff is shown correctly - note: I tested this only with plain text files not with notebooks
• If multiple files are selected, some being untracked and some being tracked, two entries appears in the context menu - Stage and Track. But if I click on Stage they all get added and/or staged. I think this is nice to do the action for all files - but it maybe good to have only one entry in the context menu.

[krassowski]

In the Git panel context menu, it looks like the icon are not vertically center with the text (they are a bit up). Is it possible to correct that?

I see that too. I was also looking at the trashIcon where the problem is even worse. It seems that the icons were fine-tuned for their use in the GitPanel rather than placed in the center and then fine tuned in the GitPanel via CSS. I do not know which makes more sense:

• to fine-tune position in menu via bindattrs/css
• to correct icons to be all the same size and centered and then adjust their use in GitPanel

Edit: looking at this again, it does not happen in the file browser context menu so maybe some styles are missing for the simple context menu on panel?

I have an error when opening the diff for multiple files at once. Only one diff is shown correctly - note: I tested this only with plain text files not with notebooks

Yes, I can reproduce that. I believe that it is not an effect of the changes that I made but some limitation of the diff renderer. I was also seeing this bug when I was opening multiple diffs manually in previous releases. My thinking is that either:

• the tab with diff needs to be focused
• the stream from server breaks when another diff gets open

But those are just guesses. Would be great to investigate and fix (possibly in another PR).

Edit: removed third part I misread.

[adammclaurin]

Does this also resolve #864?

[krassowski]

No, there is no context command for "show file history" just yet. Another main area widget with history browser would need to be implemented first I think...

But what this PR does is making it super easy to add such a command to the context menu once it gets contributed.

[fcollonval]

Would be great to investigate and fix (possibly in another PR).

Agree I opened #881

What is your opinion on the third point I raised:

If multiple files are selected, some being untracked and some being tracked, two entries appears in the context menu - Stage and Track. But if I click on Stage they all get added and/or staged. I think this is nice to do the action for all files - but it maybe good to have only one entry in the context menu.

[krassowski]

What is your opinion on the third point I raised:

If multiple files are selected, some being untracked and some being tracked, two entries appears in the context menu - Stage and Track. But if I click on Stage they all get added and/or staged. I think this is nice to do the action for all files - but it maybe good to have only one entry in the context menu.

Yes, the distinction between stage and track is artificial. But it appears to me that the current logic is neat and maintainable (aggregate the commands from context menus for specific files and show all unique entries). I can however, add extra logic which replaces the two with a tailored "Add" command.

[fcollonval]

But it appears to me that the current logic is neat and maintainable (aggregate the commands from context menus for specific files and show all unique entries). I can however, add extra logic which replaces the two with a tailored "Add" command.

Ok let keep it simple for now.

[krassowski]

I merged them in 3cb6109

[fcollonval]

I have a very small performance suggestion. Otherwise LGTM

[ianhi]

I agree, this is a great thing. One thing to consider in the future would be to add an icon for git ignore so the ignore options don't look out of place in the context menu.

[telamonian]

This looks great @krassowski!

My only nit is the track item. In all cases (ie track and add/stage) what you're really doing is staging the file, so it's confusing to call it anything other than just stage in all cases. I know I was confused for a second when I saw track pop up in your first gif.

[krassowski]

Track/Stage was collapsed into a single Add in the browser menu, the top gif was not updated There still is a distinction in the git panel context menus (as it was there before)

[fcollonval]

Thanks @krassowski

[fcollonval]

@meeseeksdev backport to jlab-2

[meeseeksmachine]

This pull request has been mentioned on Jupyter Community Forum. There might be relevant details there:

https://discourse.jupyter.org/t/what-does-ifilebrowserfactory-defaultbrowser-do/9702/2