Make it easier to add Cells (microsoft#6558)

* added code lens option and code snippet to add a new cell, in order to make it easier * added news entry * only add the 'Add Cell' code lens on the last cell, add cell when you press Alt+Enter, update codewatcher.unit.test.ts to expect more code lenses * removed addcellbelow from the default settings, changed the command for the keybing 'alt+enter', user can now make 'Add Cell' code lens appear anywhere he likes, but it will always appear as the last code lens in the last cell, updated codewatcher unit test to reflect the changes in code lens * added code snippets to add markdown cells, added instruction comments at the begining of imported jupyter files, and added a keybinding for alt+enter with a command that matches the behaviour in jupyter. * localized a constant string, used cellMatcher in the codewatcher command, and returned codewatcher unit test to its original expected Code Lenses amount * changed a label, also updated the codewatcher unit test with correct amount of code lenses

Author: David Kutugata

news/1 Enhancements/6367.md

@@ -0,0 +1 @@
+Added Code Lens and Snippet to add new cell.

package.json

@@ -104,6 +104,11 @@
  "command": "python.datascience.runcurrentcell",
  "key": "ctrl+enter",
  "when": "editorTextFocus && !editorHasSelection && python.datascience.hascodecells && python.datascience.featureenabled"
+ },
+ {
+ "command": "python.datascience.runcurrentcellandaddbelow",
+ "key": "alt+enter",
+ "when": "editorTextFocus && !editorHasSelection && python.datascience.hascodecells && python.datascience.featureenabled"
  }
  ],
  "commands": [

package.nls.json

@@ -302,6 +302,7 @@
  "DataScience.jupyterDataRateExceeded": "Cannot view variable because data rate exceeded. Please restart your server with a higher data rate limit. For example, --NotebookApp.iopub_data_rate_limit=10000000000.0",
  "DataScience.addCellBelowCommandTitle": "Add cell",
  "DataScience.debugCellCommandTitle": "Debug cell",
+ "DataScience.runCurrentCellAndAddBelow":"Run current and add cell below",
  "DataScience.variableExplorerDisabledDuringDebugging": "Variables are not available while debugging.",
  "DataScience.jupyterDebuggerNotInstalledError" : "Pip module ptvsd is required for debugging cells. You will need to install it to debug cells.",
  "DataScience.jupyterDebuggerPortNotAvailableError" : "Port {0} cannot be opened for debugging. Please specify a different port in the remoteDebuggerPort setting.",
@@ -312,5 +313,6 @@
  "DataScience.jupyterDebuggerInstallPtvsdUpdate" : "The version of ptvsd installed does not support debugging cells. Update ptvsd to newest version and continue to debug cell?",
  "DataScience.jupyterDebuggerInstallPtvsdYes" : "Yes",
  "DataScience.jupyterDebuggerInstallPtvsdNo" : "No",
- "DataScience.cellStopOnErrorFormatMessage" : "{0} cells were canceled due to an error in the previous cell."
+ "DataScience.cellStopOnErrorFormatMessage" : "{0} cells were canceled due to an error in the previous cell.",
+ "DataScience.instructionComments": "# To add a new cell, type '#%%'\n# To add a new markdown cell, type '#%% [markdown]'\n"
 }

snippets/python.json

@@ -187,7 +187,7 @@
  "prefix": "__main__",
  "body": [
  "if __name__ == \"__main__\":",
- " ${1:pass}",
+ " ${1:pass}"
  ],
  "description": "Code snippet for a `if __name__ == \"__main__\": ...` block"
  },
@@ -240,4 +240,14 @@
  "body": "import pudb; pudb.set_trace()",
  "description": "Code snippet for pudb debug"
  },
+ "add/new/cell": {
+ "prefix": "add/new/cell",
+ "body": "#%%",
+ "description": "Code snippet to add a new cell"
+ },
+ "mark/markdown": {
+ "prefix": "mark/markdown",
+ "body": "#%% [markdown]",
+ "description": "Code snippet to add a new markdown cell"
+ }
 }

src/client/common/application/commands.ts

@@ -112,4 +112,5 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu
  [DSCommands.ExportFileAsNotebook]: [undefined | Uri, undefined | CommandSource];
  [DSCommands.RunFileInInteractiveWindows]: [string];
  [DSCommands.DebugCell]: [string, number, number, number, number];
+ [DSCommands.RunCurrentCellAndAddBelow]: [string];
 }

src/client/common/utils/localize.ts

@@ -228,6 +228,7 @@ export namespace DataScience {
  export const jupyterDataRateExceeded = localize('DataScience.jupyterDataRateExceeded', 'Cannot view variable because data rate exceeded. Please restart your server with a higher data rate limit. For example, --NotebookApp.iopub_data_rate_limit=10000000000.0');
  export const addCellBelowCommandTitle = localize('DataScience.addCellBelowCommandTitle', 'Add cell');
  export const debugCellCommandTitle = localize('DataScience.debugCellCommandTitle', 'Debug cell');
+ export const runCurrentCellAndAddBelow = localize('DataScience.runCurrentCellAndAddBelow', 'Run current and add cell below');
  export const variableExplorerDisabledDuringDebugging = localize('DataScience.variableExplorerDisabledDuringDebugging', 'Variables are not available while debugging.');
  export const jupyterDebuggerNotInstalledError = localize('DataScience.jupyterDebuggerNotInstalledError', 'Pip module ptvsd is required for debugging cells. You will need to install it to debug cells.');
  export const jupyterDebuggerPortNotAvailableError = localize('DataScience.jupyterDebuggerPortNotAvailableError', 'Port {0} cannot be opened for debugging. Please specify a different port in the remoteDebuggerPort setting.');
@@ -239,6 +240,7 @@ export namespace DataScience {
  export const jupyterDebuggerInstallPtvsdYes = localize('DataScience.jupyterDebuggerInstallPtvsdYes', 'Yes');
  export const jupyterDebuggerInstallPtvsdNo = localize('DataScience.jupyterDebuggerInstallPtvsdNo', 'No');
  export const cellStopOnErrorFormatMessage = localize('DataScience.cellStopOnErrorFormatMessage', '{0} cells were canceled due to an error in the previous cell.');
+ export const instructionComments = localize('DataScience.instructionComments', '# To add a new cell, type "#%%"\n# To add a new markdown cell, type "#%% [markdown]"\n');
 }
 
 export namespace DebugConfigStrings {