merge upstream

Author: bollwyvl

.github/ISSUE_TEMPLATE/bug_report.md

@@ -37,6 +37,7 @@ https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html
 - Operating System and version:
 - Browser and version:
 - JupyterLab version:
+- Language server and version:
 
 <details><summary>Required: installed server extensions</summary>
 <pre>
@@ -53,7 +54,7 @@ You may want to sanitize the paths in the output.
 </pre>
 </details>
 
-<!--The more content you provide, the more we can help!-->
+<!--The more content you provide, the more we can help! Please fill in the below:-->
 
 <details><summary>Troubleshoot Output</summary>
 <pre>

.github/workflows/job.test.yml

@@ -42,7 +42,7 @@ jobs:
       matrix:
         os: [ubuntu]
         nodejs: ['>=14,<15.0.0a0']
-        lab: ['>=3.0.0,<4.0.0a0']
+        lab: ['>=3.1.0,<4.0.0a0']
         r: ['>=4']
     steps:
       - uses: actions/checkout@v2
@@ -127,7 +127,7 @@ jobs:
       matrix:
         os: [ubuntu]
         nodejs: ['>=14,<15.0.0a0']
-        lab: ['>=3.0.0,<4.0.0a0']
+        lab: ['>=3.1.0,<4.0.0a0']
         r: ['>=4']
     steps:
       - uses: actions/checkout@v2
@@ -229,7 +229,7 @@ jobs:
             # Node 12 end-of-life: April 2022
             nodejs: '>=12,<13.0.0.a0'
             r: '<4'
-            lab: '>=3.0.0,<3.1'
+            lab: '>=3.1.0,<3.2'
           - python: '3.10'
             # Node 16 end-of-life: April 2024
             nodejs: '>=16,<17.0.0.a0'
@@ -372,10 +372,10 @@ jobs:
         include:
           - python: '3.7'
             dist: 'jupyter*lsp*.tar.gz'
-            lab: '>=3,<3.1'
+            lab: '>=3.1,<3.2'
           - python: '3.8'
             dist: 'jupyter*lsp*.whl'
-            lab: '>=3,<3.1'
+            lab: '>=3.1,<3.2'
           - python: '3.9'
             dist: 'jupyter*lsp*.tar.gz'
             lab: '>=3.2,<3.3'
@@ -430,7 +430,7 @@ jobs:
         nodejs: ['14']
         include:
           - python: '3.7'
-            lab: '>=3,<3.1'
+            lab: '>=3.1,<3.2'
           - python: '3.10'
             lab: '>=3.2,<4'
     steps:

CHANGELOG.md

@@ -1,5 +1,36 @@
 ## Changelog
 
+### `@krassowski/jupyterlab-lsp 3.10.0` (2022-01-01)
+
+- features:
+  - enable pre-filtering of completion matches by default ([#735])
+  - add support for diagnostic tags: Deprecated, Unnecessary ([#736], [#737])
+- bug fixes:
+  - squash warnings and errors in web console ([#732])
+  - fix signature blur and fix formatting when no arguments are present ([#734])
+  - fixed with enabling of strict null checks:
+    - previously changing kernels always led to restarting of LSP connection, even if the kernel language did not change; now the connection will be retained if possible
+    - `markdownRenderer` is no longer implicitly required
+    - diagnostics sorting with missing values for `source` and `severity` was improved and missing values will be consistently shown at the end
+    - diagnostics placeholder was split into `Diagnostics are not available` and `No issues detected, great job!` which will now show up properly
+- maintenance:
+  - enable strict null checks and other strict settings ([#733])
+  - specify client capabilities in features instead of hard-coding them ([#738])
+  - bump minimum required JupyterLab version to 3.1 (`>=3.1.0,<4.0.0a0`)
+
+[#732]: https://github.com/jupyter-lsp/jupyterlab-lsp/pull/732
+[#733]: https://github.com/jupyter-lsp/jupyterlab-lsp/pull/733
+[#734]: https://github.com/jupyter-lsp/jupyterlab-lsp/pull/734
+[#735]: https://github.com/jupyter-lsp/jupyterlab-lsp/pull/735
+[#736]: https://github.com/jupyter-lsp/jupyterlab-lsp/pull/736
+[#737]: https://github.com/jupyter-lsp/jupyterlab-lsp/pull/737
+[#738]: https://github.com/jupyter-lsp/jupyterlab-lsp/pull/738
+
+### `@krassowski/code-jumpers 1.2.0` (2022-01-01)
+
+- maintenance:
+  - updates to API with respect to `null`/`undefined` values in course strict null checks activation ([#733])
+
 ### `@krassowski/jupyterlab-lsp 3.9.3` (2021-12-19)
 
 - bug fixes:

CONTRIBUTING.md

@@ -35,7 +35,7 @@ Development requires, at a minimum:
 - `python >=3.7,<3.11.0a0`
   - Python 3.7 and 3.10 are fully tested on CI
   - Python 3.7 to 3.10 and PyPy 3 are verified to at least install and import
-- `jupyterlab >=3.0.0,<4.0.0a0`
+- `jupyterlab >=3.1.0,<4.0.0a0`
 
 It is recommended to use a virtual environment (e.g. `virtualenv` or `conda env`)
 for development.

README.md

@@ -28,9 +28,9 @@ over the underlined code to see a more detailed message
 
 ![inspections](https://raw.githubusercontent.com/jupyter-lsp/jupyterlab-lsp/master/examples/screenshots/inspections.png)
 
-### Jump to Definition
+### Jump to Definition and References
 
-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
+Use the context menu entry, or <kbd>Alt</kbd> + :computer_mouse: to jump to definitions/references (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/jupyter-lsp/jupyterlab-lsp/master/examples/screenshots/jump_to_definition.png)
 
@@ -90,7 +90,7 @@ Use context menu on rows in the panel to filter out diagnostics or copy their me
 
 You will need to have both of the following installed:
 
-- JupyterLab >=3.0.0,<4.0.0a0
+- JupyterLab >=3.1.0,<4.0.0a0
 - Python 3.7+
 
 In addition, if you wish to use javascript, html, markdown or any other NodeJS-based language server you will need to have appropriate NodeJS version installed.

atest/04_Interface/DiagnosticsPanel.robot

@@ -8,13 +8,13 @@ Test Teardown       Clean Up
 Force Tags          ui:notebook    aspect:ls:features
 
 *** Variables ***
-${EXPECTED_COUNT}           4
-${DIAGNOSTIC}               W291 trailing whitespace (pycodestyle)
-${DIAGNOSTIC MESSAGE}       trailing whitespace
 ${DIAGNOSTIC MESSAGE R}     Closing curly-braces should always be on their own line
-${R CELL}                   %%R\n{}
-${MENU COLUMNS}             xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "columns")]
+${DIAGNOSTIC MESSAGE}       trailing whitespace
+${DIAGNOSTIC}               W291 trailing whitespace (pycodestyle)
+${EXPECTED_COUNT}           4
 ${LAB MENU}                 css:.lm-Menu
+${MENU COLUMNS}    xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "columns")]
+${R CELL}         %%R\n{}
 
 *** Test Cases ***
 Diagnostics Panel Opens
@@ -129,6 +129,7 @@ Open Context Menu Over W291
     Table Cell Should Equal    W291    row=-1    column=2
     Open Context Menu Over    css:.lsp-diagnostics-listing tbody > tr:last-child
 
+<<<<<<< HEAD
 Expand Menu Entry
     [Arguments]    ${label}
     ${entry} =    Set Variable    xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "${label}")]
@@ -151,6 +152,8 @@ Select Menu Entry
     Click Element    ${entry}
     Wait Until Page Does Not Contain Element    ${entry}    timeout=10s
 
+=======
+>>>>>>> upsteam/master
 Open Notebook And Panel
     [Arguments]    ${notebook}
     Setup Notebook    Python    ${notebook}

atest/05_Features/Completion.robot

@@ -14,14 +14,12 @@ ${KERNEL_BUSY_INDICATOR}    css:.jp-NotebookPanel-toolbar div[title="Kernel Busy
 
 *** Test Cases ***
 Works When Kernel Is Idle
-    [Documentation]    The suggestions from kernel and LSP should get integrated.
-    Configure JupyterLab Plugin    {"kernelResponseTimeout": -1, "waitForBusyKernel": false}
-    ...    plugin id=${COMPLETION PLUGIN ID}
+    [Documentation]    The suggestions from kernel and LSP should get integrated; operates in case insensitive mode
+    Configure JupyterLab Plugin    {"kernelResponseTimeout": -1, "waitForBusyKernel": false, "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     Enter Cell Editor    1    line=2
     Capture Page Screenshot    01-entered-cell.png
     Trigger Completer
     Capture Page Screenshot    02-completions-shown.png
-    # lowercase and uppercase suggestions:
     Completer Should Suggest    TabError
     # this comes from LSP:
     Completer Should Suggest    test
@@ -32,9 +30,19 @@ Works When Kernel Is Idle
     ${content} =    Get Cell Editor Content    1
     Should Contain    ${content}    TabError
 
+Filters Completions In Case Sensitive Mode
+    Configure JupyterLab Plugin    {"caseSensitive": true}    plugin id=${COMPLETION PLUGIN ID}
+    [Documentation]    Completions filtering is case-sensitive when caseSensitive is true
+    Enter Cell Editor    1    line=2
+    Trigger Completer
+    Completer Should Suggest    test
+    Completer Should Not Suggest    TabError
+
 Can Prioritize Kernel Completions
-    Configure JupyterLab Plugin    {"kernelCompletionsFirst": true, "kernelResponseTimeout": -1}
-    ...    plugin id=${COMPLETION PLUGIN ID}
+    # note: disabling pre-filtering to get ranking without match scoring
+    Configure JupyterLab Plugin
+    ...     {"kernelCompletionsFirst": true, "kernelResponseTimeout": -1, "preFilterMatches": false}
+    ...     plugin id=${COMPLETION PLUGIN ID}
     Enter Cell Editor    1    line=2
     Trigger Completer
     Completer Should Suggest    %%timeit
@@ -43,8 +51,10 @@ Can Prioritize Kernel Completions
     Should Be True    ${kernel_position} < ${lsp_position}
 
 Can Prioritize LSP Completions
-    Configure JupyterLab Plugin    {"kernelCompletionsFirst": false, "kernelResponseTimeout": -1}
-    ...    plugin id=${COMPLETION PLUGIN ID}
+    # note: disabling pre-filtering to get ranking without match scoring
+    Configure JupyterLab Plugin
+    ...     {"kernelCompletionsFirst": false, "kernelResponseTimeout": -1, "preFilterMatches": false}
+    ...     plugin id=${COMPLETION PLUGIN ID}
     Enter Cell Editor    1    line=2
     Trigger Completer
     Completer Should Suggest    %%timeit
@@ -167,6 +177,7 @@ Does Not Autocomplete If Multiple Options
     Completer Should Suggest    copy
 
 User Can Select Lowercase After Starting Uppercase
+    Configure JupyterLab Plugin    {"caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     # `from time import Tim<tab>` → `from time import time`
     Enter Cell Editor    5    line=1
     Trigger Completer
@@ -220,7 +231,7 @@ Triggers Completer On Dot
     Completer Should Suggest    append
 
 Material Theme Works
-    Configure JupyterLab Plugin    {"theme": "material"}    plugin id=${COMPLETION PLUGIN ID}
+    Configure JupyterLab Plugin    {"theme": "material", "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     Capture Page Screenshot    01-configured.png
     Enter Cell Editor    1    line=2
     Trigger Completer
@@ -231,7 +242,7 @@ Material Theme Works
     Completer Should Include Icon    lsp:material-class-light
 
 VSCode Theme Works
-    Configure JupyterLab Plugin    {"theme": "vscode"}    plugin id=${COMPLETION PLUGIN ID}
+    Configure JupyterLab Plugin    {"theme": "vscode", "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     Capture Page Screenshot    01-configured.png
     Enter Cell Editor    1    line=2
     Trigger Completer
@@ -244,7 +255,7 @@ VSCode Dark Theme Works
     Lab Command    Use Theme: JupyterLab Dark
     Wait For Splash
     Capture Page Screenshot    00-theme-changed.png
-    Configure JupyterLab Plugin    {"theme": "vscode"}    plugin id=${COMPLETION PLUGIN ID}
+    Configure JupyterLab Plugin    {"theme": "vscode", "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     Capture Page Screenshot    01-configured.png
     Open ${file} in ${MENU NOTEBOOK}
     Wait Until Fully Initialized
@@ -257,7 +268,7 @@ VSCode Dark Theme Works
     Wait For Splash
 
 Works Without A Theme
-    Configure JupyterLab Plugin    {"theme": null}    plugin id=${COMPLETION PLUGIN ID}
+    Configure JupyterLab Plugin    {"theme": null, "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     Capture Page Screenshot    01-configured.png
     Enter Cell Editor    1    line=2
     Trigger Completer
@@ -266,7 +277,7 @@ Works Without A Theme
     Wait Until Page Contains Element    ${COMPLETER_BOX} .jp-Completer-monogram
 
 Works With Incorrect Theme
-    Configure JupyterLab Plugin    {"theme": "a-non-existing-theme"}    plugin id=${COMPLETION PLUGIN ID}
+    Configure JupyterLab Plugin    {"theme": "a-non-existing-theme", "caseSensitive": false}    plugin id=${COMPLETION PLUGIN ID}
     Capture Page Screenshot    01-configured.png
     Enter Cell Editor    1    line=2
     Trigger Completer

atest/05_Features/Diagnostics.robot

@@ -0,0 +1,14 @@
+*** Settings ***
+Suite Setup       Setup Suite For Screenshots    diagnostics
+Force Tags        feature:diagnostics
+Test Setup        Setup Notebook    Python    Diagnostic.ipynb
+Test Teardown     Clean Up After Working With File    Diagnostic.ipynb
+Resource          ../Keywords.robot
+# note: diagnostics are also tested in 01_Editor and 04_Interface/DiagnosticsPanel.robot
+
+*** Test Cases ***
+Diagnostics with deprecated tag have strike-through decoration
+    Wait Until Page Contains Element    css:.cm-lsp-diagnostic[title*="is deprecated"]    timeout=25s
+    Wait Until Page Contains Element    css:.cm-lsp-diagnostic[title*="Unreachable code"]    timeout=5s
+    Page Should Contain Element    css:.cm-lsp-diagnostic-tag-Deprecated
+    Page Should Contain Element    css:.cm-lsp-diagnostic-tag-Unnecessary

atest/05_Features/Jump.robot

@@ -6,31 +6,60 @@ Suite Setup     Setup Suite For Screenshots    gh-403
 Force Tags      feature:jump-to-definition    gh:403
 
 *** Variables ***
-${FOLDER WITH SPACE}    a földer
+${FOLDER WITH SPACE}    a föl@der
 
 *** Test Cases ***
-Python Jumps between Files
+Python Jumps Between Files
     Copy Files to Folder With Spaces    jump_a.py    jump_b.py
-    ${def} =    Set Variable    a_function_definition
     Open ${FOLDER WITH SPACE}/jump_b.py in ${MENU EDITOR}
     Wait Until Fully Initialized
-    ${sel} =    Set Variable    xpath:(//span[contains(@class, 'cm-variable')][contains(text(), '${def}')])[last()]
+    ${sel} =   Select Token Occurrence    a_function_definition
     Jump To Definition    ${sel}
     Wait Until Page Contains    ANOTHER_CONSTANT
     Capture Page Screenshot    10-jumped.png
     Clean Up After Working With File    jump_b.py
 
+Jumps To References With Modifier Click
+    [Setup]    Prepare File for Editing    Python    editor    jump_references.py
+    Configure JupyterLab Plugin    {"modifierKey": "Accel"}    plugin id=${JUMP PLUGIN ID}
+    Wait Until Fully Initialized
+    ${token} =    Select Token Occurrence     func      type=def
+    Click Element    ${token}
+    ${original} =    Measure Cursor Position
+    Ctrl Click Element     ${token}
+    Wait Until Page Contains     Choose the jump target
+    ${references_count} =  Get Element Count    css:.jp-Dialog select option
+    Should Be True    ${references_count} == ${3}
+    Select From List By Index     css:.jp-Dialog select    2
+    Click Element    css:.jp-Dialog-button.jp-mod-accept
+    Wait Until Keyword Succeeds    10 x    1 s    Cursor Should Jump    ${original}
+    Clean Up After Working With File    jump_references.py
+
+Jumps To References From Context Menu
+    [Setup]    Prepare File for Editing    Python    editor    jump_references.py
+    Wait Until Fully Initialized
+    ${token} =    Select Token Occurrence     func      type=def
+    Click Element    ${token}
+    ${original} =    Measure Cursor Position
+    Open Context Menu Over   ${token}
+    Select Menu Entry    Jump to references
+    Wait Until Page Contains     Choose the jump target
+    ${references_count} =  Get Element Count    css:.jp-Dialog select option
+    Should Be True    ${references_count} == ${3}
+    Select From List By Index     css:.jp-Dialog select    2
+    Click Element    css:.jp-Dialog-button.jp-mod-accept
+    Wait Until Keyword Succeeds    10 x    1 s    Cursor Should Jump    ${original}
+    Clean Up After Working With File    jump_references.py
+
 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()]
+    ${sel} =    Select Token Occurrence    a_variable
     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}
+    Ctrl Click Element     ${sel}
     Capture Page Screenshot    02-jumped.png
     Wait Until Keyword Succeeds    10 x    1 s    Cursor Should Jump    ${original}
     ${new} =    Measure Cursor Position
@@ -49,3 +78,16 @@ Copy Files to Folder With Spaces
     FOR    ${file}    IN    @{files}
         Copy File    examples${/}${file}    ${NOTEBOOK DIR}${/}${FOLDER WITH SPACE}${/}${file}
     END
+
+Select Token Occurrence
+    [Arguments]    ${token}    ${type}=variable    ${which}=last
+    [Return]     xpath:(//span[contains(@class, 'cm-${type}')][contains(text(), '${token}')])[${which}()]
+
+Ctrl Click Element
+    [Arguments]      ${element}
+    ${key} =    Evaluate    'COMMAND' if platform.system() == 'Darwin' else 'CTRL'    platform
+    Click Element    ${element}    modifier=${key}
+
+Should Have Expected Count
+    [Arguments]    ${expected_count}
+    ${count} =    Count Diagnostics In Panel