Merge pull request #423 from krassowski/refactor-jump-to-definition

Refactor jump-to functionality, remove unused code

Author: krassowski

.github/workflows/job.test.yml

@@ -22,7 +22,7 @@ env:
 
   LINKED_EXTENSIONS: >-
     packages/lsp-ws-connection
-    packages/jupyterlab-go-to-definition
+    packages/code-jumpers
     packages/completion-theme
     packages/theme-vscode
     packages/theme-material
@@ -148,7 +148,7 @@ jobs:
         run: jlpm test
 
       #  js_cov_packages:
-      #    - jupyterlab-go-to-definition
+      #    - code-jumpers
       #    - jupyterlab-lsp
 
       #- task: PublishTestResults@2

CHANGELOG.md

@@ -4,13 +4,18 @@
 
 - features
 
-  - The virtual document folder can be configure with `JP_LSP_VIRTUAL_DIR` or
-    `LanguageServerManager.virtual_documents_dir`. Its default value is kept
+  - the virtual documents' folder can be configured with `JP_LSP_VIRTUAL_DIR` or
+    `LanguageServerManager.virtual_documents_dir`; its default value is kept
     unchanged: _contents.root_dir_ / `.virtual_documents` ([#416])
 
 [#416]: https://github.com/krassowski/jupyterlab-lsp/issues/416
 
-### `@krassowski/jupyterlab-lsp 2.0.9` (???)
+### `@krassowski/jupyterlab-lsp 2.1.0` (???)
+
+- features
+
+  - added "click to jump" functionality (by default using <kbd>Ctrl</kbd> modifier) ([#423])
+  - added "jump back" command, by default activated with <kbd>Ctrl</kbd> + <kbd>o</kbd> ([#423])
 
 - bug fixes
 
@@ -23,14 +28,17 @@
 [#403]: https://github.com/krassowski/jupyterlab-lsp/issues/403
 [#421]: https://github.com/krassowski/jupyterlab-lsp/issues/421
 
-### `@krassowski/jupyterlab_go_to_definition 2.0.0` (???)
+### `@krassowski/code-jumpers 1.0.0` (???)
 
-- features
-
-  - breaking change: renames `uri` to `contents_path` to help avoid programmer issues
+- breaking changes
+  - split away from `@krassowski/jupyterlab_go_to_definition`, renamed to `@krassowski/code-jumpers` ([#423]):
+    - removed unused code
+    - refactored history operations to track files and always use global location data
+  - renamed `uri` to `contents_path` to help avoid programmer issues
     with characters requiring URI encoding ([#406])
 
 [#406]: https://github.com/krassowski/jupyterlab-lsp/pull/406
+[#423]: https://github.com/krassowski/jupyterlab-lsp/pull/423
 
 ### `@krassowski/jupyterlab-lsp 2.0.8` (2020-10-25)
 
@@ -123,15 +131,15 @@
   - rename operation status reporting got improved ([#318])
   - replaced the generic status icons with code check icon (coloured differently according to the status) ([#318])
   - added icons for all the features and their commands ([#318])
-  - refactored the codebase with a new architecture which allows dynamic feature, document widget adapter, and code editor registration ([#318])
+  - refactored the codebase with a new architecture which allows dynamic features, document widget adapter, and code editor registration ([#318])
   - the document in the connections list in the statusbar popover are now represented by easy-to-understand DocumentLocator (breadcrumbs) widget rather than an internal id ([bacc006])
   - syntax highlighting mode is adjusted to the language with the majority of the code in an editor ([#319])
   - copy diagnostics message and filter diagnostics from context menu of Diagnostic Panel ([#330])
 
 - bug fixes
 
-  - path-autocompletion issues were resolved upstream an this release adopts these changes
-  - missing caret and document connection icons were restored in the statusbar popover ([#318])
+  - path-autocompletion issues were resolved upstream and this release adopts these changes
+  - the missing caret and document connection icons were restored in the statusbar popover ([#318])
   - pressing "Cancel" rename during rename now correctly aborts the rename operation ([#318])
   - when a language server for a foreign document is not available an explanation is displayed (rather than the "Connecting..." status as before) ([4e5b2ad])
   - when jump target is not found a message is now shown instead of raising an exception ([00448d0])

README.md

@@ -27,7 +27,7 @@ over the underlined code to see a more detailed message
 
 ### Jump to Definition
 
-Use the context menu entries to jump to definitions
+Use the context menu entry, or <kbd>Alt</kbd> + :computer_mouse: to jump to definitions (you can change it to <kbd>Ctrl</kbd>/<kbd>⌘</kbd> in settings); use <kbd>Alt</kbd> + <kbd>o</kbd> to jump back
 
 ![jump](https://raw.githubusercontent.com/krassowski/jupyterlab-lsp/master/examples/screenshots/jump_to_definition.png)
 

atest/05_Features/Jump.robot

@@ -17,6 +17,29 @@ Python Jumps between Files
     Wait Until Page Contains    ANOTHER_CONSTANT
     Capture Page Screenshot    10-jumped.png
 
+Ctrl Click And Jumping Back Works
+    [Setup]    Prepare File for Editing    Python    editor    jump.py
+    Configure JupyterLab Plugin    {"modifierKey": "Accel"}    plugin id=${JUMP PLUGIN ID}
+    Wait Until Fully Initialized
+    ${usage} =    Set Variable    a_variable
+    ${sel} =    Set Variable    xpath:(//span[contains(@class, 'cm-variable')][contains(text(), '${usage}')])[last()]
+    Click Element    ${sel}
+    ${original} =    Measure Cursor Position
+    Capture Page Screenshot    01-ready-to-jump.png
+    ${key} =    Evaluate    'COMMAND' if platform.system() == 'Darwin' else 'CTRL'    platform
+    Click Element    ${sel}    modifier=${key}
+    Capture Page Screenshot    02-jumped.png
+    Wait Until Keyword Succeeds    10 x    1 s    Cursor Should Jump    ${original}
+    ${new} =    Measure Cursor Position
+    Press Keys    None    ALT+o
+    Wait Until Keyword Succeeds    10 x    1 s    Cursor Should Jump    ${new}
+    ${back} =    Measure Cursor Position
+    Should Be Equal    ${original}    ${back}
+    Configure JupyterLab Plugin    {"modifierKey": "Alt"}    plugin id=${JUMP PLUGIN ID}
+    Click Element    ${sel}    modifier=ALT
+    Wait Until Keyword Succeeds    10 x    1 s    Cursor Should Jump    ${original}
+    [Teardown]    Clean Up After Working With File    jump.py
+
 *** Keywords ***
 Copy Files to Folder With Spaces
     [Arguments]    @{files}

atest/Variables.robot

@@ -45,6 +45,7 @@ ${CM CURSORS}     css:.jp-MainAreaWidget:not(.lm-mod-hidden) .CodeMirror-cursors
 # settings
 ${LSP PLUGIN ID}    @krassowski/jupyterlab-lsp:plugin
 ${COMPLETION PLUGIN ID}    @krassowski/jupyterlab-lsp:completion
+${JUMP PLUGIN ID}    @krassowski/jupyterlab-lsp:jump_to
 ${DIAGNOSTICS PLUGIN ID}    @krassowski/jupyterlab-lsp:diagnostics
 ${CSS USER SETTINGS}    .jp-SettingsRawEditor-user
 ${JLAB XP CLOSE SETTINGS}    ${JLAB XP DOCK TAB}\[contains(., 'Settings')]/*[contains(@class, 'm-TabBar-tabCloseIcon')]

atest/examples/jump.py

@@ -0,0 +1,4 @@
+a_variable = 1
+
+
+a_variable

examples/screenshots/jump_to_definition.png

@@ -38,13 +38,14 @@
   "private": true,
   "scripts": {
     "bootstrap": "jlpm --no-optional --prefer-offline && lerna bootstrap && jlpm lint && jlpm clean && jlpm build",
-    "build": "jlpm build:schema && jlpm build:completion-theme && jlpm build:theme-material && jlpm build:theme-vscode && jlpm build:meta && jlpm build:ws",
+    "build": "jlpm build:schema && jlpm build:completion-theme && jlpm build:theme-material && jlpm build:theme-vscode && jlpm build:jump && jlpm build:meta && jlpm build:ws",
     "build:schema": "lerna run build:schema --stream",
     "build:meta": "lerna run build --stream --scope @krassowski/jupyterlab-lsp-metapackage",
     "build:completion-theme": "lerna run build --stream --scope @krassowski/completion-theme",
     "build:theme-vscode": "lerna run build --stream --scope @krassowski/theme-vscode",
     "build:theme-material": "lerna run build --stream --scope @krassowski/theme-material",
     "build:ws": "lerna run build --stream --scope lsp-ws-connection",
+    "build:jump": "lerna run build --stream --scope @krassowski/code-jumpers",
     "watch": "lerna run --parallel watch",
     "bundle": "lerna run --parallel bundle",
     "clean": "lerna run --parallel clean",

package.json

@@ -0,0 +1,3 @@
+# Code Jumpers
+
+Implementation underlying the jump to definition functionality in [JupyterLab-LSP](https://github.com/krassowski/jupyterlab-lsp).