Merge pull request #890 from meeseeksmachine/auto-backport-of-pr-877-…

…on-jlab-2

Backport PR #877 on branch jlab-2 (Implement Git context menu in the file browser)

src/components/CommitBox.tsx

@@ -7,7 +7,7 @@ import {
   commitButtonClass
 } from '../style/CommitBox';
 import { CommandRegistry } from '@lumino/commands';
-import { SUBMIT_COMMIT_COMMAND } from '../commandsAndMenu';
+import { CommandIDs } from '../tokens';
 
 /**
  * Interface describing component properties.
@@ -136,7 +136,7 @@ export class CommitBox extends React.Component<
    */
   private _getSubmitKeystroke = (): string => {
     const binding = this.props.commands.keyBindings.find(
-      binding => binding.command === SUBMIT_COMMIT_COMMAND
+      binding => binding.command === CommandIDs.gitSubmitCommand
     );
     return binding.keys.join(' ');
   };
@@ -201,7 +201,7 @@ export class CommitBox extends React.Component<
     _: CommandRegistry,
     commandArgs: CommandRegistry.ICommandExecutedArgs
   ): void => {
-    if (commandArgs.id === SUBMIT_COMMIT_COMMAND && this._canCommit()) {
+    if (commandArgs.id === CommandIDs.gitSubmitCommand && this._canCommit()) {
       this._onCommitSubmit();
     }
   };

src/components/FileList.tsx

@@ -5,7 +5,7 @@ import { Menu } from '@lumino/widgets';
 import * as React from 'react';
 import AutoSizer from 'react-virtualized-auto-sizer';
 import { ListChildComponentProps } from 'react-window';
-import { CommandIDs } from '../commandsAndMenu';
+import { addMenuItems, CommandArguments } from '../commandsAndMenu';
 import { GitExtension } from '../model';
 import { hiddenButtonStyle } from '../style/ActionButtonStyle';
 import { fileListWrapperClass } from '../style/FileListStyle';
@@ -16,7 +16,7 @@ import {
   openIcon,
   removeIcon
 } from '../style/icons';
-import { Git } from '../tokens';
+import { ContextCommandIDs, Git } from '../tokens';
 import { ActionButton } from './ActionButton';
 import { isDiffSupported } from './diff/Diff';
 import { FileItem } from './FileItem';
@@ -45,6 +45,58 @@ export interface IFileListProps {
   settings: ISettingRegistry.ISettings;
 }
 
+export type ContextCommands = Record<Git.Status, ContextCommandIDs[]>;
+
+export const CONTEXT_COMMANDS: ContextCommands = {
+  'partially-staged': [
+    ContextCommandIDs.gitFileOpen,
+    ContextCommandIDs.gitFileUnstage,
+    ContextCommandIDs.gitFileDiff
+  ],
+  unstaged: [
+    ContextCommandIDs.gitFileOpen,
+    ContextCommandIDs.gitFileStage,
+    ContextCommandIDs.gitFileDiscard,
+    ContextCommandIDs.gitFileDiff
+  ],
+  untracked: [
+    ContextCommandIDs.gitFileOpen,
+    ContextCommandIDs.gitFileTrack,
+    ContextCommandIDs.gitIgnore,
+    ContextCommandIDs.gitIgnoreExtension,
+    ContextCommandIDs.gitFileDelete
+  ],
+  staged: [
+    ContextCommandIDs.gitFileOpen,
+    ContextCommandIDs.gitFileUnstage,
+    ContextCommandIDs.gitFileDiff
+  ]
+};
+
+const SIMPLE_CONTEXT_COMMANDS: ContextCommands = {
+  'partially-staged': [
+    ContextCommandIDs.gitFileOpen,
+    ContextCommandIDs.gitFileDiscard,
+    ContextCommandIDs.gitFileDiff
+  ],
+  staged: [
+    ContextCommandIDs.gitFileOpen,
+    ContextCommandIDs.gitFileDiscard,
+    ContextCommandIDs.gitFileDiff
+  ],
+  unstaged: [
+    ContextCommandIDs.gitFileOpen,
+    ContextCommandIDs.gitFileDiscard,
+    ContextCommandIDs.gitFileDiff
+  ],
+  untracked: [
+    ContextCommandIDs.gitFileOpen,
+    ContextCommandIDs.gitIgnore,
+    ContextCommandIDs.gitIgnoreExtension,
+    ContextCommandIDs.gitFileDelete
+  ]
+};
+
 export class FileList extends React.Component<IFileListProps, IFileListState> {
   constructor(props: IFileListProps) {
     super(props);
@@ -71,42 +123,9 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
     });
 
     const contextMenu = new Menu({ commands: this.props.commands });
-    const commands = [CommandIDs.gitFileOpen];
-    switch (selectedFile.status) {
-      case 'unstaged':
-        commands.push(
-          CommandIDs.gitFileStage,
-          CommandIDs.gitFileDiscard,
-          CommandIDs.gitFileDiff
-        );
-        break;
-      case 'untracked':
-        commands.push(
-          CommandIDs.gitFileTrack,
-          CommandIDs.gitIgnore,
-          CommandIDs.gitIgnoreExtension,
-          CommandIDs.gitFileDelete
-        );
-        break;
-      case 'staged':
-        commands.push(CommandIDs.gitFileUnstage, CommandIDs.gitFileDiff);
-        break;
-    }
+    const commands = CONTEXT_COMMANDS[selectedFile.status];
+    addMenuItems(commands, contextMenu, [selectedFile]);
 
-    commands.forEach(command => {
-      if (command === CommandIDs.gitFileDiff) {
-        contextMenu.addItem({
-          command,
-          args: {
-            filePath: selectedFile.to,
-            isText: !selectedFile.is_binary,
-            status: selectedFile.status
-          }
-        });
-      } else {
-        contextMenu.addItem({ command, args: selectedFile as any });
-      }
-    });
     contextMenu.open(event.clientX, event.clientY);
   };
 
@@ -123,34 +142,8 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
     event.preventDefault();
 
     const contextMenu = new Menu({ commands: this.props.commands });
-    const commands = [CommandIDs.gitFileOpen];
-    switch (selectedFile.status) {
-      case 'untracked':
-        commands.push(
-          CommandIDs.gitIgnore,
-          CommandIDs.gitIgnoreExtension,
-          CommandIDs.gitFileDelete
-        );
-        break;
-      default:
-        commands.push(CommandIDs.gitFileDiscard, CommandIDs.gitFileDiff);
-        break;
-    }
-
-    commands.forEach(command => {
-      if (command === CommandIDs.gitFileDiff) {
-        contextMenu.addItem({
-          command,
-          args: {
-            filePath: selectedFile.to,
-            isText: !selectedFile.is_binary,
-            status: selectedFile.status
-          }
-        });
-      } else {
-        contextMenu.addItem({ command, args: selectedFile as any });
-      }
-    });
+    const commands = SIMPLE_CONTEXT_COMMANDS[selectedFile.status];
+    addMenuItems(commands, contextMenu, [selectedFile]);
     contextMenu.open(event.clientX, event.clientY);
   };
 
@@ -216,7 +209,9 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
 
   /** Discard changes in a specific unstaged or staged file */
   discardChanges = async (file: Git.IStatusFile) => {
-    await this.props.commands.execute(CommandIDs.gitFileDiscard, file as any);
+    await this.props.commands.execute(ContextCommandIDs.gitFileDiscard, ({
+      files: [file]
+    } as CommandArguments.IGitContextAction) as any);
   };
 
   /** Add all untracked files */
@@ -334,7 +329,9 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
     const { data, index, style } = rowProps;
     const file = data[index] as Git.IStatusFile;
     const openFile = () => {
-      this.props.commands.execute(CommandIDs.gitFileOpen, file as any);
+      this.props.commands.execute(ContextCommandIDs.gitFileOpen, ({
+        files: [file]
+      } as CommandArguments.IGitContextAction) as any);
     };
     const diffButton = this._createDiffButton(file);
     return (
@@ -418,7 +415,9 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
     const { data, index, style } = rowProps;
     const file = data[index] as Git.IStatusFile;
     const openFile = () => {
-      this.props.commands.execute(CommandIDs.gitFileOpen, file as any);
+      this.props.commands.execute(ContextCommandIDs.gitFileOpen, ({
+        files: [file]
+      } as CommandArguments.IGitContextAction) as any);
     };
     const diffButton = this._createDiffButton(file);
     return (
@@ -528,10 +527,9 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
               icon={openIcon}
               title={'Open this file'}
               onClick={() => {
-                this.props.commands.execute(
-                  CommandIDs.gitFileOpen,
-                  file as any
-                );
+                this.props.commands.execute(ContextCommandIDs.gitFileOpen, ({
+                  files: [file]
+                } as CommandArguments.IGitContextAction) as any);
               }}
             />
             <ActionButton
@@ -549,7 +547,9 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
         model={this.props.model}
         onDoubleClick={() => {
           if (!doubleClickDiff) {
-            this.props.commands.execute(CommandIDs.gitFileOpen, file as any);
+            this.props.commands.execute(ContextCommandIDs.gitFileOpen, ({
+              files: [file]
+            } as CommandArguments.IGitContextAction) as any);
           }
         }}
         selected={this._isSelectedFile(file)}
@@ -601,7 +601,9 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
       .composite as boolean;
 
     const openFile = () => {
-      this.props.commands.execute(CommandIDs.gitFileOpen, file as any);
+      this.props.commands.execute(ContextCommandIDs.gitFileOpen, ({
+        files: [file]
+      } as CommandArguments.IGitContextAction) as any);
     };
 
     // Default value for actions and double click
@@ -737,11 +739,15 @@ export class FileList extends React.Component<IFileListProps, IFileListState> {
    */
   private async _openDiffView(file: Git.IStatusFile): Promise<void> {
     try {
-      await this.props.commands.execute(CommandIDs.gitFileDiff, {
-        filePath: file.to,
-        isText: !file.is_binary,
-        status: file.status
-      });
+      await this.props.commands.execute(ContextCommandIDs.gitFileDiff, ({
+        files: [
+          {
+            filePath: file.to,
+            isText: !file.is_binary,
+            status: file.status
+          }
+        ]
+      } as CommandArguments.IGitFileDiff) as any);
     } catch (reason) {
       console.error(`Failed to open diff view for ${file.to}.\n${reason}`);
     }

src/components/GitPanel.tsx

@@ -8,7 +8,6 @@ import { Signal } from '@lumino/signaling';
 import Tab from '@material-ui/core/Tab';
 import Tabs from '@material-ui/core/Tabs';
 import * as React from 'react';
-import { CommandIDs } from '../commandsAndMenu';
 import { Logger } from '../logger';
 import { GitExtension } from '../model';
 import {
@@ -20,7 +19,7 @@ import {
   tabsClass,
   warningTextClass
 } from '../style/GitPanel';
-import { Git, ILogMessage, Level } from '../tokens';
+import { CommandIDs, Git, ILogMessage, Level } from '../tokens';
 import { GitAuthorForm } from '../widgets/AuthorBox';
 import { CommitBox } from './CommitBox';
 import { FileList } from './FileList';

src/components/SinglePastCommitInfo.tsx

@@ -3,7 +3,7 @@ import { CommandRegistry } from '@lumino/commands';
 import * as React from 'react';
 import { FixedSizeList, ListChildComponentProps } from 'react-window';
 import { classes } from 'typestyle';
-import { CommandIDs } from '../commandsAndMenu';
+import { CommandArguments } from '../commandsAndMenu';
 import { LoggerContext } from '../logger';
 import { GitExtension } from '../model';
 import {
@@ -25,7 +25,7 @@ import {
   iconClass,
   insertionsIconClass
 } from '../style/SinglePastCommitInfo';
-import { Git } from '../tokens';
+import { ContextCommandIDs, Git } from '../tokens';
 import { ActionButton } from './ActionButton';
 import { isDiffSupported } from './diff/Diff';
 import { FilePath } from './FilePath';
@@ -337,18 +337,22 @@ export class SinglePastCommitInfo extends React.Component<
       event.stopPropagation();
 
       try {
-        self.props.commands.execute(CommandIDs.gitFileDiff, {
-          filePath: fpath,
-          isText: bool,
-          context: {
-            previousRef: {
-              gitRef: self.props.commit.pre_commit
-            },
-            currentRef: {
-              gitRef: self.props.commit.commit
+        self.props.commands.execute(ContextCommandIDs.gitFileDiff, ({
+          files: [
+            {
+              filePath: fpath,
+              isText: bool,
+              context: {
+                previousRef: {
+                  gitRef: self.props.commit.pre_commit
+                },
+                currentRef: {
+                  gitRef: self.props.commit.commit
+                }
+              }
             }
-          }
-        });
+          ]
+        } as CommandArguments.IGitFileDiff) as any);
       } catch (err) {
         console.error(`Failed to open diff view for ${fpath}.\n${err}`);
       }

src/components/Toolbar.tsx

@@ -8,7 +8,6 @@ import { CommandRegistry } from '@lumino/commands';
 import { Badge, Tab, Tabs } from '@material-ui/core';
 import * as React from 'react';
 import { classes } from 'typestyle';
-import { CommandIDs } from '../commandsAndMenu';
 import { Logger } from '../logger';
 import {
   selectedTabClass,
@@ -31,7 +30,7 @@ import {
   toolbarMenuWrapperClass,
   toolbarNavClass
 } from '../style/Toolbar';
-import { Git, IGitExtension, Level } from '../tokens';
+import { CommandIDs, Git, IGitExtension, Level } from '../tokens';
 import { ActionButton } from './ActionButton';
 import { BranchMenu } from './BranchMenu';
 import { TagMenu } from './TagMenu';

src/index.ts

@@ -11,7 +11,11 @@ import { IMainMenu } from '@jupyterlab/mainmenu';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { IStatusBar } from '@jupyterlab/statusbar';
-import { addCommands, createGitMenu } from './commandsAndMenu';
+import {
+  addCommands,
+  addFileBrowserContextMenu,
+  createGitMenu
+} from './commandsAndMenu';
 import { GitExtension } from './model';
 import { getServerSettings } from './server';
 import { gitIcon } from './style/icons';
@@ -169,6 +173,14 @@ async function activate(
 
     // Add the status bar widget
     addStatusBarWidget(statusBar, gitExtension, settings);
+
+    // Add the context menu items for the default file browser
+    addFileBrowserContextMenu(
+      gitExtension,
+      factory.tracker,
+      app.commands,
+      app.contextMenu
+    );
   }
 
   return gitExtension;