Add cell navigation commands as well as a default set of keyboard bindings for most new interactive window cell commands (#13334)

greazer · Jim Griesmer · web-flow · commit c08ef0be557e · 2020-08-07T14:06:04.000-07:00
* Add Goto Prev/Next Cell

* Add goto previous cell

* Remove unneeded changes

* Add default keybindings for cell commands

* Goto should be Go to

Co-authored-by: Jim Griesmer &lt;jimg@live.com&gt;
diff --git a/package.json b/package.json
@@ -229,6 +229,66 @@
                 "linux": "ctrl+shift+-",
                 "when": "editorTextFocus && inputFocus && notebookEditorFocused && notebookViewType == jupyter-notebook",
                 "command": "notebook.cell.split"
+            },
+            {
+                "command": "python.datascience.insertCellBelowPosition",
+                "key": "ctrl+; s",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+            },
+            {
+                "command": "python.datascience.insertCellBelow",
+                "key": "ctrl+; b",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+            },
+            {
+                "command": "python.datascience.insertCellAbove",
+                "key": "ctrl+; a",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+            },
+            {
+                "command": "python.datascience.deleteCells",
+                "key": "ctrl+; x",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+            },
+                        {
+                "command": "python.datascience.extendSelectionByCellAbove",
+                "key": "ctrl+alt+shift+[",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+            },
+            {
+                "command": "python.datascience.extendSelectionByCellBelow",
+                "key": "ctrl+alt+shift+]",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+            },
+            {
+                "command": "python.datascience.moveCellsUp",
+                "key": "ctrl+; u",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+            },
+            {
+                "command": "python.datascience.moveCellsDown",
+                "key": "ctrl+; d",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+            },
+            {
+                "command": "python.datascience.changeCellToMarkdown",
+                "key": "ctrl+; m",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+            },
+            {
+                "command": "python.datascience.changeCellToCode",
+                "key": "ctrl+; c",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+            },
+            {
+                "command": "python.datascience.gotoNextCellInFile",
+                "key": "ctrl+alt+]",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+            },
+            {
+                "command": "python.datascience.gotoPrevCellInFile",
+                "key": "ctrl+alt+[",
+                "when": "editorTextFocus && python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
             }
         ],
         "commands": [
@@ -588,6 +648,16 @@
                 "title": "%python.command.python.datascience.changeCellToCode.title%",
                 "category": "Python"
             },
+            {
+                "command": "python.datascience.gotoNextCellInFile",
+                "title": "%python.command.python.datascience.gotoNextCellInFile.title%",
+                "category": "Python"
+            },
+            {
+                "command": "python.datascience.gotoPrevCellInFile",
+                "title": "%python.command.python.datascience.gotoPrevCellInFile.title%",
+                "category": "Python"
+            },
             {
                 "command": "python.datascience.runcurrentcelladvance",
                 "title": "%python.command.python.datascience.runcurrentcelladvance.title%",
@@ -1148,6 +1218,18 @@
                     "category": "Python",
                     "when": "python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
                 },
+                {
+                    "command": "python.datascience.gotoNextCellInFile",
+                    "title": "%python.command.python.datascience.gotoNextCellInFile.title%",
+                    "category": "Python",
+                    "when": "python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+                },
+                {
+                    "command": "python.datascience.gotoPrevCellInFile",
+                    "title": "%python.command.python.datascience.gotoPrevCellInFile.title%",
+                    "category": "Python",
+                    "when": "python.datascience.hascodecells && python.datascience.featureenabled && !notebookEditorFocused"
+                },
                 {
                     "command": "python.datascience.runcurrentcell",
                     "title": "%python.command.python.datascience.runcurrentcell.title%",
diff --git a/package.nls.json b/package.nls.json
@@ -85,6 +85,8 @@
     "python.command.python.datascience.moveCellsDown.title": "Move Selected Cells Down",
     "python.command.python.datascience.changeCellToMarkdown.title": "Change Cell to Markdown",
     "python.command.python.datascience.changeCellToCode.title": "Change Cell to Code",
+    "python.command.python.datascience.gotoNextCellInFile.title": "Go to Next Cell",
+    "python.command.python.datascience.gotoPrevCellInFile.title": "Go to Previous Cell",
     "python.command.python.datascience.showhistorypane.title": "Show Python Interactive Window",
     "python.command.python.datascience.createnewinteractive.title": "Create Python Interactive Window",
     "python.command.python.datascience.selectjupyteruri.title": "Specify local or remote Jupyter server for connections",
diff --git a/src/client/common/application/commands.ts b/src/client/common/application/commands.ts
@@ -184,6 +184,8 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu
     [DSCommands.MoveCellsDown]: [];
     [DSCommands.ChangeCellToMarkdown]: [];
     [DSCommands.ChangeCellToCode]: [];
+    [DSCommands.GotoNextCellInFile]: [];
+    [DSCommands.GotoPrevCellInFile]: [];
     [DSCommands.ScrollToCell]: [Uri, string];
     [DSCommands.ViewJupyterOutput]: [];
     [DSCommands.ExportAsPythonScript]: [INotebookModel];
diff --git a/src/client/datascience/commands/commandRegistry.ts b/src/client/datascience/commands/commandRegistry.ts
@@ -77,6 +77,8 @@ export class CommandRegistry implements IDisposable {
         this.registerCommand(Commands.MoveCellsDown, this.moveCellsDown);
         this.registerCommand(Commands.ChangeCellToMarkdown, this.changeCellToMarkdown);
         this.registerCommand(Commands.ChangeCellToCode, this.changeCellToCode);
+        this.registerCommand(Commands.GotoNextCellInFile, this.gotoNextCellInFile);
+        this.registerCommand(Commands.GotoPrevCellInFile, this.gotoPrevCellInFile);
         this.registerCommand(Commands.RunAllCellsAbovePalette, this.runAllCellsAboveFromCursor);
         this.registerCommand(Commands.RunCellAndAllBelowPalette, this.runCellAndAllBelowFromCursor);
         this.registerCommand(Commands.RunToLine, this.runToLine);
@@ -366,6 +368,14 @@ export class CommandRegistry implements IDisposable {
         this.getCurrentCodeWatcher()?.changeCellToCode();
     }
 
+    private async gotoNextCellInFile(): Promise<void> {
+        this.getCurrentCodeWatcher()?.gotoNextCell();
+    }
+
+    private async gotoPrevCellInFile(): Promise<void> {
+        this.getCurrentCodeWatcher()?.gotoPreviousCell();
+    }
+
     private async runAllCellsAboveFromCursor(): Promise<void> {
         const currentCodeLens = this.getCurrentCodeLens();
         if (currentCodeLens) {
diff --git a/src/client/datascience/constants.ts b/src/client/datascience/constants.ts
@@ -92,6 +92,8 @@ export namespace Commands {
     export const MoveCellsDown = 'python.datascience.moveCellsDown';
     export const ChangeCellToMarkdown = 'python.datascience.changeCellToMarkdown';
     export const ChangeCellToCode = 'python.datascience.changeCellToCode';
+    export const GotoNextCellInFile = 'python.datascience.gotoNextCellInFile';
+    export const GotoPrevCellInFile = 'python.datascience.gotoPrevCellInFile';
     export const ScrollToCell = 'python.datascience.scrolltocell';
     export const CreateNewNotebook = 'python.datascience.createnewnotebook';
     export const ViewJupyterOutput = 'python.datascience.viewJupyterOutput';
@@ -189,6 +191,8 @@ export enum Telemetry {
     MoveCellsDown = 'DATASCIENCE.RUN_MOVE_CELLS_DOWN',
     ChangeCellToMarkdown = 'DATASCIENCE.RUN_CHANGE_CELL_TO_MARKDOWN',
     ChangeCellToCode = 'DATASCIENCE.RUN_CHANGE_CELL_TO_CODE',
+    GotoNextCellInFile = 'DATASCIENCE.GOTO_NEXT_CELL_IN_FILE',
+    GotoPrevCellInFile = 'DATASCIENCE.GOTO_PREV_CELL_IN_FILE',
     RunSelectionOrLine = 'DATASCIENCE.RUN_SELECTION_OR_LINE',
     RunToLine = 'DATASCIENCE.RUN_TO_LINE',
     RunFromLine = 'DATASCIENCE.RUN_FROM_LINE',
diff --git a/src/client/datascience/editor-integration/codewatcher.ts b/src/client/datascience/editor-integration/codewatcher.ts
@@ -654,6 +654,40 @@ export class CodeWatcher implements ICodeWatcher {
         });
     }
 
+    @captureTelemetry(Telemetry.GotoNextCellInFile)
+    public gotoNextCell() {
+        const editor = this.documentManager.activeTextEditor;
+        if (!editor || !editor.selection) {
+            return;
+        }
+
+        const currentSelection = editor.selection;
+
+        const currentRunCellLens = this.getCurrentCellLens(currentSelection.start);
+        const nextRunCellLens = this.getNextCellLens(currentSelection.start);
+
+        if (currentRunCellLens && nextRunCellLens) {
+            this.advanceToRange(nextRunCellLens.range);
+        }
+    }
+
+    @captureTelemetry(Telemetry.GotoPrevCellInFile)
+    public gotoPreviousCell() {
+        const editor = this.documentManager.activeTextEditor;
+        if (!editor || !editor.selection) {
+            return;
+        }
+
+        const currentSelection = editor.selection;
+
+        const currentRunCellLens = this.getCurrentCellLens(currentSelection.start);
+        const prevRunCellLens = this.getPreviousCellLens(currentSelection.start);
+
+        if (currentRunCellLens && prevRunCellLens) {
+            this.advanceToRange(prevRunCellLens.range);
+        }
+    }
+
     private applyToCells(callback: (editor: TextEditor, cell: ICellRange, cellIndex: number) => void) {
         const editor = this.documentManager.activeTextEditor;
         const startEndCellIndex = this.getStartEndCellIndex(editor?.selection);
@@ -1053,6 +1087,18 @@ export class CodeWatcher implements ICodeWatcher {
         return undefined;
     }
 
+    private getPreviousCellLens(pos: Position): CodeLens | undefined {
+        const currentIndex = this.codeLenses.findIndex(
+            (l) => l.range.contains(pos) && l.command !== undefined && l.command.command === Commands.RunCell
+        );
+        if (currentIndex >= 1) {
+            return this.codeLenses.find(
+                (l: CodeLens, i: number) => l.command !== undefined && i < currentIndex && i + 1 === currentIndex
+            );
+        }
+        return undefined;
+    }
+
     private async runFileInteractiveInternal(debug: boolean) {
         if (this.document) {
             const code = this.document.getText();
diff --git a/src/client/datascience/types.ts b/src/client/datascience/types.ts
@@ -682,6 +682,8 @@ export interface ICodeWatcher {
     changeCellToMarkdown(): void;
     changeCellToCode(): void;
     debugCurrentCell(): Promise<void>;
+    gotoNextCell(): void;
+    gotoPreviousCell(): void;
 }
 
 export const ICodeLensFactory = Symbol('ICodeLensFactory');
diff --git a/src/client/telemetry/index.ts b/src/client/telemetry/index.ts
@@ -1747,6 +1747,8 @@ export interface IEventNamePropertyMapping {
     [Telemetry.MoveCellsDown]: never | undefined;
     [Telemetry.ChangeCellToMarkdown]: never | undefined;
     [Telemetry.ChangeCellToCode]: never | undefined;
+    [Telemetry.GotoNextCellInFile]: never | undefined;
+    [Telemetry.GotoPrevCellInFile]: never | undefined;
     /**
      * Misc
      */

Original file line number	Diff line number	Diff line change
`@@ -682,6 +682,8 @@ export interface ICodeWatcher {`
`682`	`682`	`changeCellToMarkdown(): void;`
`683`	`683`	`changeCellToCode(): void;`
`684`	`684`	`debugCurrentCell(): Promise<void>;`
	`685`	`+ gotoNextCell(): void;`
	`686`	`+ gotoPreviousCell(): void;`
`685`	`687`	`}`
`686`	`688`
`687`	`689`	`export const ICodeLensFactory = Symbol('ICodeLensFactory');`