Add git to command palette (#1243)

* Add git to command palette

* Add git to command palette

* Add git to command palette

* Add git to command palette

* Finish up the PR

* Deduplicate yjs

* Give another shot at fixing yjs

* Fix tests

* Lint the code

* Use debug mode

* Turn off debug

* Set up git identity for integration tests

---------

Co-authored-by: Frédéric Collonval <fcollonval@gmail.com>

Author: sabbirtkdr

.github/workflows/build.yml

@@ -141,6 +141,11 @@ jobs:
       run: jlpm playwright install chromium
       working-directory: ui-tests
 
+    - name: Set up git
+      run: |
+        git config --global user.name 'Test Bot'
+        git config --global user.email 'test-bot@example.com'
+
     - name: Execute integration tests
       working-directory: ui-tests
       run: |

jupyterlab_git/__init__.py

@@ -17,7 +17,7 @@
 
 
 def _jupyter_labextension_paths():
-    return [{"src": "labextension", "dest": "@jupyerlab/git"}]
+    return [{"src": "labextension", "dest": "@jupyterlab/git"}]
 
 
 class JupyterLabGit(Configurable):

package.json

@@ -134,7 +134,9 @@
         "stylelint-config-recommended": "^13.0.0",
         "stylelint-config-standard": "~34.0.0",
         "ts-jest": "^26.0.0",
-        "typescript": "~4.3.5"
+        "typescript": "~4.3.5",
+        "yarn-dedupe": "^0.2.3",
+        "yjs": "^13.5.40"
     },
     "peerDependencies": {
         "codemirror": "^5.0.0"

src/__tests__/commands.spec.tsx

@@ -80,6 +80,7 @@ describe('git-commands', () => {
               iconLabel: '',
               label: ''
             },
+            isChecked: null,
             value: undefined
           });
           const spyReset = jest.spyOn(model, 'reset');
@@ -146,6 +147,7 @@ describe('git-commands', () => {
               iconLabel: '',
               label: ''
             },
+            isChecked: null,
             value: {
               checked
             } as Git.ICheckboxFormValue

src/__tests__/plugin.spec.ts

@@ -6,11 +6,13 @@ import { ISettingRegistry, SettingRegistry } from '@jupyterlab/settingregistry';
 import { JupyterLab } from '@jupyterlab/application';
 import { showErrorMessage } from '@jupyterlab/apputils';
 import { URLExt } from '@jupyterlab/coreutils';
+import { Signal } from '@lumino/signaling';
 import {
   defaultMockedResponses,
   IMockedResponses,
   mockedRequestAPI
 } from './utils';
+import { IFileBrowserFactory } from '@jupyterlab/filebrowser';
 
 jest.mock('../git');
 jest.mock('@jupyterlab/application');
@@ -22,11 +24,17 @@ const plugin = plugins[0];
 describe('plugin', () => {
   const mockGit = git as jest.Mocked<typeof git>;
   let app: jest.Mocked<JupyterLab>;
+  let browserFactory: jest.Mocked<IFileBrowserFactory>;
   let mockResponses: IMockedResponses = {};
   let settingRegistry: jest.Mocked<ISettingRegistry>;
 
   beforeAll(() => {
     app = new JupyterLab() as jest.Mocked<JupyterLab>;
+    browserFactory = {
+      defaultBrowser: {
+        model: { pathChanged: new Signal(null), restored: Promise.resolve() }
+      }
+    } as unknown as jest.Mocked<IFileBrowserFactory>;
     settingRegistry = new SettingRegistry({
       connector: null
     }) as jest.Mocked<SettingRegistry>;
@@ -59,7 +67,7 @@ describe('plugin', () => {
       const extension = await plugin.activate(
         app,
         null,
-        null,
+        browserFactory,
         { tracker: { currentWidget: null } },
         null,
         settingRegistry
@@ -94,7 +102,7 @@ describe('plugin', () => {
       const extension = await plugin.activate(
         app,
         null,
-        null,
+        browserFactory,
         { tracker: { currentWidget: null } },
         null,
         settingRegistry
@@ -128,7 +136,7 @@ describe('plugin', () => {
       const extension = await plugin.activate(
         app,
         null,
-        null,
+        browserFactory,
         { tracker: { currentWidget: null } },
         null,
         settingRegistry
@@ -159,7 +167,7 @@ describe('plugin', () => {
       const extension = await plugin.activate(
         app,
         null,
-        null,
+        browserFactory,
         { tracker: { currentWidget: null } },
         null,
         settingRegistry

src/__tests__/test-components/BranchMenu.spec.tsx

@@ -246,6 +246,7 @@ describe('BranchMenu', () => {
             iconLabel: '',
             label: ''
           },
+          isChecked: null,
           value: undefined
         });
       });

src/__tests__/test-components/GitPanel.spec.tsx

@@ -121,6 +121,7 @@ describe('GitPanel', () => {
         iconLabel: '',
         label: ''
       },
+      isChecked: null,
       value: {
         name: commitUser['user.name'],
         email: commitUser['user.email']
@@ -207,6 +208,7 @@ describe('GitPanel', () => {
           ...dialogValue.button,
           accept: false
         },
+        isChecked: null,
         value: null
       });
 

src/cloneCommand.ts

@@ -5,7 +5,7 @@ import {
 import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 import { CommandIDs, IGitExtension, Level } from './tokens';
 import { IFileBrowserFactory } from '@jupyterlab/filebrowser';
-import { Dialog, showDialog } from '@jupyterlab/apputils';
+import { Dialog, ICommandPalette, showDialog } from '@jupyterlab/apputils';
 import { GitCloneForm } from './widgets/GitCloneForm';
 import { logger } from './logger';
 import {
@@ -19,14 +19,16 @@ import { addCloneButton } from './widgets/gitClone';
 
 export const gitCloneCommandPlugin: JupyterFrontEndPlugin<void> = {
   id: '@jupyterlab/git:clone',
-  requires: [ITranslator, IGitExtension, IFileBrowserFactory],
+  requires: [IGitExtension, IFileBrowserFactory],
+  optional: [ICommandPalette, ITranslator],
   activate: (
     app: JupyterFrontEnd,
-    translator: ITranslator,
     gitModel: IGitExtension,
-    fileBrowserFactory: IFileBrowserFactory
+    fileBrowserFactory: IFileBrowserFactory,
+    palette: ICommandPalette | null,
+    translator: ITranslator | null
   ) => {
-    translator = translator || nullTranslator;
+    translator = translator ?? nullTranslator;
     const trans = translator.load('jupyterlab_git');
     const fileBrowser = fileBrowserFactory.defaultBrowser;
     const fileBrowserModel = fileBrowser.model;
@@ -89,6 +91,12 @@ export const gitCloneCommandPlugin: JupyterFrontEndPlugin<void> = {
 
     // Add the context menu items for the default file browser
     addFileBrowserContextMenu(gitModel, fileBrowser, app.contextMenu, trans);
+
+    if (palette) {
+      // Add the commands to the command palette
+      const category = 'Git Operations';
+      palette.addItem({ command: CommandIDs.gitClone, category });
+    }
   },
   autoStart: true
 };

src/index.ts

@@ -3,7 +3,12 @@ import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
-import { Dialog, showErrorMessage, Toolbar } from '@jupyterlab/apputils';
+import {
+  Dialog,
+  ICommandPalette,
+  showErrorMessage,
+  Toolbar
+} from '@jupyterlab/apputils';
 import { IChangedArgs } from '@jupyterlab/coreutils';
 import { IDocumentManager } from '@jupyterlab/docmanager';
 import { FileBrowserModel, IFileBrowserFactory } from '@jupyterlab/filebrowser';
@@ -12,43 +17,41 @@ import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { IStatusBar } from '@jupyterlab/statusbar';
 import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+import { gitCloneCommandPlugin } from './cloneCommand';
 import {
   addCommands,
   addFileBrowserContextMenu,
   createGitMenu
 } from './commandsAndMenu';
+import { createImageDiff } from './components/diff/ImageDiff';
 import { createNotebookDiff } from './components/diff/NotebookDiff';
 import { addStatusBarWidget } from './components/StatusWidget';
 import { GitExtension } from './model';
 import { getServerSettings } from './server';
 import { gitIcon } from './style/icons';
-import { Git, IGitExtension } from './tokens';
+import { CommandIDs, Git, IGitExtension } from './tokens';
 import { addCloneButton } from './widgets/gitClone';
 import { GitWidget } from './widgets/GitWidget';
-import { gitCloneCommandPlugin } from './cloneCommand';
-import { createImageDiff } from './components/diff/ImageDiff';
 
 export { DiffModel } from './components/diff/model';
 export { NotebookDiff } from './components/diff/NotebookDiff';
 export { PlainTextDiff } from './components/diff/PlainTextDiff';
-export { Git, IGitExtension } from './tokens';
 export { logger, LoggerContext } from './logger';
+export { Git, IGitExtension } from './tokens';
 
 /**
  * The default running sessions extension.
  */
 const plugin: JupyterFrontEndPlugin<IGitExtension> = {
   id: '@jupyterlab/git:plugin',
   requires: [
-    IMainMenu,
     ILayoutRestorer,
     IFileBrowserFactory,
     IRenderMimeRegistry,
     ISettingRegistry,
-    IDocumentManager,
-    IStatusBar,
-    ITranslator
+    IDocumentManager
   ],
+  optional: [IMainMenu, IStatusBar, ICommandPalette, ITranslator],
   provides: IGitExtension,
   activate,
   autoStart: true
@@ -64,14 +67,15 @@ export default [plugin, gitCloneCommandPlugin];
  */
 async function activate(
   app: JupyterFrontEnd,
-  mainMenu: IMainMenu,
   restorer: ILayoutRestorer,
   factory: IFileBrowserFactory,
   renderMime: IRenderMimeRegistry,
   settingRegistry: ISettingRegistry,
   docmanager: IDocumentManager,
-  statusBar: IStatusBar,
-  translator?: ITranslator
+  mainMenu: IMainMenu | null,
+  statusBar: IStatusBar | null,
+  palette: ICommandPalette | null,
+  translator: ITranslator | null
 ): Promise<IGitExtension> {
   let gitExtension: GitExtension | null = null;
   let settings: ISettingRegistry.ISettings;
@@ -82,7 +86,7 @@ async function activate(
   // And it is unlikely that another browser than the default will be used.
   // Ref: https://github.com/jupyterlab/jupyterlab-git/issues/1014
   const fileBrowser = factory.defaultBrowser;
-  translator = translator || nullTranslator;
+  translator = translator ?? nullTranslator;
   const trans = translator.load('jupyterlab_git');
 
   // Attempt to load application settings
@@ -186,6 +190,24 @@ async function activate(
     gitPlugin.title.icon = gitIcon;
     gitPlugin.title.caption = 'Git';
 
+    if (palette) {
+      // Add the commands to the command palette
+      const category = 'Git Operations';
+      [
+        CommandIDs.gitToggleSimpleStaging,
+        CommandIDs.gitToggleDoubleClickDiff,
+        CommandIDs.gitOpenGitignore,
+        CommandIDs.gitShowDiff,
+        CommandIDs.gitInit,
+        CommandIDs.gitMerge,
+        CommandIDs.gitPush,
+        CommandIDs.gitPull,
+        CommandIDs.gitResetToRemote,
+        CommandIDs.gitManageRemote,
+        CommandIDs.gitTerminalCommand
+      ].forEach(command => palette.addItem({ command, category }));
+    }
+
     // Let the application restorer track the running panel for restoration of
     // application state (e.g. setting the running panel as the current side bar
     // widget).
@@ -196,7 +218,7 @@ async function activate(
     app.shell.add(gitPlugin, 'left', { rank: 200 });
 
     // Add a menu for the plugin
-    if (app.version.split('.').slice(0, 2).join('.') < '3.1') {
+    if (mainMenu && app.version.split('.').slice(0, 2).join('.') < '3.1') {
       // Support JLab 3.0
       mainMenu.addMenu(createGitMenu(app.commands, trans), { rank: 60 });
     }
@@ -205,7 +227,9 @@ async function activate(
     addCloneButton(gitExtension, fileBrowser, app.commands, trans);
 
     // Add the status bar widget
-    addStatusBarWidget(statusBar, gitExtension, settings, trans);
+    if (statusBar) {
+      addStatusBarWidget(statusBar, gitExtension, settings, trans);
+    }
 
     // Add the context menu items for the default file browser
     addFileBrowserContextMenu(

ui-tests/jupyter_server_test_config.py

@@ -4,8 +4,15 @@
 opens the server to the world and provide access to JupyterLab
 JavaScript objects through the global window variable.
 """
+import sys
 from tempfile import mkdtemp
 
+try:
+    import jupyter_archive
+except ImportError:
+    print("You must install `jupyter-archive` for the integration tests.")
+    sys.exit(1)
+
 c.ServerApp.port = 8888
 c.ServerApp.port_retries = 0
 c.ServerApp.open_browser = False