Merge pull request #2 from krassowski/master

Update Master

Author: FlyingSamson

.github/workflows/job.test.yml

@@ -214,15 +214,16 @@ jobs:
         include:
           # if using 3.6, use an old node
           - python: 3.6
-            # Node 10 end-of-life: April 2021
-            nodejs: '>=10,<11.0.0.a0'
-          # if using 3.7, use newer node, etc...
-          - python: 3.7
             # Node 12 end-of-life: April 2022
             nodejs: '>=12,<13.0.0.a0'
-          - python: 3.8
+          # if using 3.7, use newer node, etc...
+          - python: 3.7
             # Node 14 end-of-life: April 2023
             nodejs: '>=14,<15.0.0.a0'
+          - python: 3.8
+            # TODO: switch to Node 16 once gets merged https://github.com/conda-forge/nodejs-feedstock/pull/189
+            # Node 15 end-of-life: June 2021
+            nodejs: '>=15,<16.0.0.a0'
           # TODO: remove when mambaforge just works on setup-miniconda
           - os: ubuntu
             mambaforge: Linux-x86_64.sh

CHANGELOG.md

@@ -1,6 +1,45 @@
-## CHANGELOG
+## Changelog
 
-### `@krassowski/jupyterlab-lsp 3.5.1` (unreleased)
+### `@krassowski/jupyterlab-lsp 3.7.0` (unreleased)
+
+- features:
+
+  - add ability to deactivate Kernel completions or LSP completion through the settings ([#586], thanks @Carreau)
+  - allow to set a priority for LSP server, allowing to choose which server to use when multiple servers are installed ([#588])
+  - add auto-detection of pyright server ([#587], thanks @yuntan)
+
+- bug fixes:
+
+  - workaround url-parse issue causing problems when using JupyterLab 3.0.15 ([#599])
+
+- other changes:
+  - drop Node 10 (EOL 2 weeks ago) testing on CI, add Node 15 ([#587])
+
+[#586]: https://github.com/krassowski/jupyterlab-lsp/pull/586
+[#587]: https://github.com/krassowski/jupyterlab-lsp/pull/587
+[#588]: https://github.com/krassowski/jupyterlab-lsp/pull/588
+[#599]: https://github.com/krassowski/jupyterlab-lsp/pull/599
+
+### `jupyter-lsp 1.2.0` (2021-04-26)
+
+- features:
+
+  - add support for python-lsp-server, a community fork of pyls ([#584] and [#582], thanks @maresb)
+
+- bug fixes:
+  - fix encoding on Windows for non-conda installs ([#580], thanks @stonebig)
+
+[#580]: https://github.com/krassowski/jupyterlab-lsp/pull/580
+[#582]: https://github.com/krassowski/jupyterlab-lsp/pull/582
+[#584]: https://github.com/krassowski/jupyterlab-lsp/pull/584
+
+### `@krassowski/code-jumpers 1.1.0` (2021-04-26)
+
+- features:
+
+  - added translation support ([#557], thanks @JessicaBarh)
+
+### `@krassowski/jupyterlab-lsp 3.6.0` (2021-04-26)
 
 - features:
 
@@ -15,7 +54,7 @@
 [#570]: https://github.com/krassowski/jupyterlab-lsp/pull/570
 [#576]: https://github.com/krassowski/jupyterlab-lsp/pull/576
 
-### `@krassowski/jupyterlab-lsp 3.5.0` (2020-03-22)
+### `@krassowski/jupyterlab-lsp 3.5.0` (2021-03-22)
 
 - features:
 
@@ -42,7 +81,7 @@
 [#560]: https://github.com/krassowski/jupyterlab-lsp/pull/560
 [#562]: https://github.com/krassowski/jupyterlab-lsp/pull/562
 
-### `jupyter-lsp 1.1.4` (2020-02-21)
+### `jupyter-lsp 1.1.4` (2021-02-21)
 
 - bug fixes:
 
@@ -53,15 +92,15 @@
 
 [#535]: https://github.com/krassowski/jupyterlab-lsp/pull/535
 
-### `@krassowski/jupyterlab-lsp 3.4.1` (2020-02-16)
+### `@krassowski/jupyterlab-lsp 3.4.1` (2021-02-16)
 
 - bug fixes:
 
   - fixed installation of the source version of the extension (causing build error if classic was not installed) ([#526])
 
 [#526]: https://github.com/krassowski/jupyterlab-lsp/pull/526
 
-### `@krassowski/jupyterlab-lsp 3.4.0` (2020-02-14)
+### `@krassowski/jupyterlab-lsp 3.4.0` (2021-02-14)
 
 - features:
 
@@ -86,7 +125,7 @@
 [#523]: https://github.com/krassowski/jupyterlab-lsp/pull/523
 [#524]: https://github.com/krassowski/jupyterlab-lsp/pull/524
 
-### `@krassowski/jupyterlab-lsp 3.3.1` (2020-02-07)
+### `@krassowski/jupyterlab-lsp 3.3.1` (2021-02-07)
 
 - bug fixes:
 

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-## Contribute to jupyterlab-lsp and jupyter-lsp :heart:
+## Contributing
 
 `jupyter-lsp` and `jupyterlab-lsp` are [open source][license] software, and
 all contributions conforming to good sense, good taste, and the
@@ -19,9 +19,11 @@ You can contribute to the project through:
 - improving testing
 - reviewing pull requests
 
+Thank you for all your contributions :heart:
+
 [license]: https://github.com/krassowski/jupyterlab-lsp/blob/master/LICENSE
-[extending]: ./docs/Extending.ipynb
-[roadmap]: ./docs/Roadmap.ipynb
+[extending]: ./docs/Extending.html
+[roadmap]: ./docs/Roadmap.html
 [jupyterlab-lsp]: https://github.com/krassowski/jupyterlab-lsp.git
 [code-of-conduct]: https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md
 
@@ -328,7 +330,7 @@ python scripts/lint.py
 
 ### Specs
 
-While language servers can be configured by the user using a simple JSON or Python [configuration file](./Configuring.ipynb#language_servers),
+While language servers can be configured by the user using a simple JSON or Python [configuration file](./Configuring.html#language-servers),
 it is preferable to provide users with an option that does not require manual configuration. The language server specifications (specs)
 wrap the configuration (as would be defined by the user) into a Python class or function that can be either:
 
@@ -357,7 +359,7 @@ A spec is a Python callable (a function, or a class with `__call__` method) that
 
 The above example is only intended as an illustration and not as an up-to-date guide.
 For details on the dictionary contents, see the [schema][] definition and [built-in specs][].
-Basic concepts (meaning of the `argv` and `languages` arguments) are also explained in the [configuration files](./Configuring.ipynb#language_servers) documentation.
+Basic concepts (meaning of the `argv` and `languages` arguments) are also explained in the [configuration files](./Configuring.html#language-servers) documentation.
 
 When contributing a specification we recommend to make use of the helper classes and other [utilities][] that take care of the common use-cases:
 

README.md

@@ -6,7 +6,7 @@
 
 > _This project is still maturing, but you are welcome to check it out, leave feedback and/or a PR_
 
-Quick Links: **[Installation](#installation) | [Configuring](./docs/Configuring.ipynb) | [Updating](#updating) | [Changelog](./CHANGELOG.md) | [Roadmap](./docs/Roadmap.ipynb) | [Contributing](./CONTRIBUTING.md) | [Extending](./docs/Extending.ipynb)**
+Quick Links: **[Installation](#installation) | [Configuring](./docs/Configuring.ipynb) | [Changelog](./CHANGELOG.md) | [Roadmap](./docs/Roadmap.ipynb) | [Contributing](./CONTRIBUTING.md) | [Extending](./docs/Extending.ipynb)**
 
 ## Features
 
@@ -66,6 +66,10 @@ from the Language Server (in notebook).
 If the kernel is too slow to respond promptly only the Language Server suggestions will be shown (default threshold: 0.6s).
 You can configure the completer to not attempt to fetch the kernel completions if the kernel is busy (skipping the 0.6s timeout).
 
+You can deactivate the kernel suggestions by adding `"Kernel"` to the `disableCompletionsFrom` in the `completion` section
+of _Advanced Settings_. Alternatively if you _only_ want kernel completions you can add `"LSP"` to the same
+setting; Or add both if you like to code in hardcore mode and get no completions, or if another provider has been added.
+
 ### Rename
 
 Rename variables, functions and more, in both: notebooks and the file editor.
@@ -119,19 +123,19 @@ Use of a python `virtualenv` or a conda env is also recommended.
    > or `jupyter-lsp-r` to install both the server extension and the language server.
 
 1. install LSP servers for languages of your choice; for example, for Python
-   ([pyls](https://github.com/palantir/python-language-server)) and
+   ([pylsp](https://github.com/python-lsp/python-lsp-server)) and
    R ([languageserver](https://github.com/REditorSupport/languageserver)) servers:
 
    ```bash
    # note: you may want to use our fork of python-language-server instead (see below)
-   pip install 'python-language-server[all]'
+   pip install 'python-lsp-server[all]'
    R -e 'install.packages("languageserver")'
    ```
 
    or from `conda-forge`
 
    ```bash
-   conda install -c conda-forge python-language-server r-languageserver
+   conda install -c conda-forge python-lsp-server r-languageserver
    ```
 
    Please see our full list of
@@ -188,6 +192,8 @@ Use of a python `virtualenv` or a conda env is also recommended.
 
 Server configurations can be edited using the Advanced Settings editor in JupyterLab (_Settings > Advanced Settings Editor_). For settings specific to each server, please see the [table of language servers][language-servers]. Example settings might include:
 
+> Note: for the new (currently recommended) python-lsp-server replace `pyls` occurrences with `pyslp`
+
 ```json
 {
   "language_servers": {

atest/01_Editor.robot

@@ -43,9 +43,13 @@ Less
 Markdown
     Editor Shows Features for Language    Markdown    example.md    Diagnostics=`Color` is misspelt
 
-Python
+Python (pylsp)
     ${def} =    Set Variable    xpath:(//span[contains(@class, 'cm-variable')][contains(text(), 'fib')])[last()]
-    Editor Shows Features for Language    Python    example.py    Diagnostics=multiple spaces after keyword    Jump to Definition=${def}    Rename=${def}
+    Editor Shows Features for Server    pylsp    Python    example.py    Diagnostics=undefined name 'result' (pyflakes)    Jump to Definition=${def}    Rename=${def}
+
+Python (pyright)
+    ${def} =    Set Variable    xpath:(//span[contains(@class, 'cm-variable')][contains(text(), 'fib')])[last()]
+    Editor Shows Features for Server    pyright    Python    example.py    Diagnostics=is not defined (Pyright)    Jump to Definition=${def}
 
 R
     ${def} =    Set Variable    xpath:(//span[contains(@class, 'cm-variable')][contains(text(), 'fib')])[last()]
@@ -70,6 +74,12 @@ YAML
     Editor Shows Features for Language    YAML    example.yaml    Diagnostics=duplicate key
 
 *** Keywords ***
+Editor Shows Features for Server
+    [Arguments]    ${server}    ${Language}    ${file}    &{features}
+    Configure JupyterLab Plugin
+    ...    {"language_servers": {"${server}": {"priority": 10000}}}
+    Editor Shows Features for Language    ${Language}    ${file}    &{features}
+
 Editor Shows Features for Language
     [Arguments]    ${Language}    ${file}    &{features}
     Prepare File for Editing    ${Language}    editor    ${file}

atest/03_Notebook.robot

@@ -47,7 +47,7 @@ Moving Cells Around
 Foreign Extractors
     ${file} =    Set Variable    Foreign extractors.ipynb
     Configure JupyterLab Plugin
-    ...    {"language_servers": {"texlab": {"serverSettings": {"latex.lint.onChange": true}}, "bash-langauge-server": {"bashIde.highlightParsingErrors": true}}}
+    ...    {"language_servers": {"texlab": {"serverSettings": {"latex.lint.onChange": true}}, "bash-langauge-server": {"bashIde.highlightParsingErrors": true}}, "pylsp": {"priority": 1000}}
     Capture Page Screenshot    10-configured.png
     Reset Application State
     Setup Notebook    Python    ${file}

atest/05_Features/Completion.robot

@@ -187,7 +187,7 @@ Completion Works For Tokens Separated By Space
     Wait Until Keyword Succeeds    40x    0.5s    Cell Editor Should Equal    13    from statistics import
 
 Kernel And LSP Completions Merge Prefix Conflicts Are Resolved
-    [Documentation]    Reconciliate Python kernel returning prefixed completions and LSP (pyls) not-prefixed ones
+    [Documentation]    Reconciliate Python kernel returning prefixed completions and LSP (pylsp) not-prefixed ones
     Configure JupyterLab Plugin    {"kernelResponseTimeout": -1, "waitForBusyKernel": false}    plugin id=${COMPLETION PLUGIN ID}
     # For more details see: https://github.com/krassowski/jupyterlab-lsp/issues/30#issuecomment-576003987
     # `import os.pat<tab>` → `import os.pathsep`
@@ -267,7 +267,7 @@ Completes Correctly With R Double And Triple Colon
     Completer Should Suggest    .print.via.format
     Select Completer Suggestion    .print.via.format
     Wait Until Keyword Succeeds    40x    0.5s    File Editor Line Should Equal    1    tools::.print.via.format
-    # tripple colon
+    # triple colon
     Place Cursor In File Editor At    4    11
     Trigger Completer
     Completer Should Suggest    .packageName
@@ -289,6 +289,8 @@ Shows Documentation With CompletionItem Resolve
     Wait Until Fully Initialized
     Trigger Completer
     Completer Should Suggest    print.data.frame
+    # if data.frame is not active, activate it (it should be in top 10 on any platform)
+    Activate Completer Suggestion    print.data.frame    max_steps_down=10
     Completer Should Include Documentation    Print a data frame.
     # should remain visible after typing:
     Press Keys    None    efa
@@ -342,6 +344,21 @@ File Editor Line Should Equal
     ${line} =    Get Line    ${content}    ${line}
     Should Be Equal    ${line}    ${value}
 
+Activate Completer Suggestion
+    [Arguments]    ${text}    ${max_steps_down}=100
+    ${suggestion} =    Set Variable    css:.jp-Completer-item[data-value="${text}"]
+    Wait Until Page Contains Element    ${suggestion}
+    ${active_suggestion} =    Set Variable    css:.jp-mod-active.jp-Completer-item[data-value="${text}"]
+    FOR    ${i}    IN RANGE    ${max_steps_down}
+        Capture Page Screenshot    ${i}-completions.png
+        ${matching_active_elements} =    Get Element Count    ${active_suggestion}
+        LOG    ${matching_active_elements}
+        Exit For Loop If    ${matching_active_elements} == 1
+        Press Keys    None    DOWN
+        Sleep    0.1s
+    END
+    Wait Until Page Contains Element    ${active_suggestion}
+
 Select Completer Suggestion
     [Arguments]    ${text}
     ${suggestion} =    Set Variable    css:.jp-Completer-item[data-value="${text}"]

atest/07_Configuration.robot

@@ -7,8 +7,8 @@ Resource          ./Keywords.robot
 *** Test Cases ***
 Python
     [Documentation]    pyflakes is enabled by default, but flake8 is not
-    Settings Should Change Editor Diagnostics    Python    style.py    pyls
-    ...    {"pyls": {"plugins": {"flake8": {"enabled": true},"pyflakes": {"enabled": false}}}}
+    Settings Should Change Editor Diagnostics    Python    style.py    pylsp
+    ...    {"pylsp": {"plugins": {"flake8": {"enabled": true},"pyflakes": {"enabled": false}}}}
     ...    undefined name 'foo' (pyflakes)
     ...    undefined name 'foo' (flake8)
 

atest/Keywords.robot

@@ -375,6 +375,7 @@ Configure JupyterLab Plugin
     Set Editor Content    ${settings json}    ${CSS USER SETTINGS}
     Wait Until Page Contains    No errors found
     Click Element    css:button[title\='Save User Settings']
+    Wait Until Page Contains    No errors found
     Click Element    ${JLAB XP CLOSE SETTINGS}
 
 Clean Up After Working with File and Settings

atest/Variables.robot

@@ -54,5 +54,5 @@ ${JLAB XP CLOSE SETTINGS}    ${JLAB XP DOCK TAB}\[contains(., 'Settings')]/*[con
 ${CSS DIAGNOSTIC}    css:.cm-lsp-diagnostic
 # log messages
 @{KNOWN BAD ERRORS}
-...               pyls_jsonrpc.endpoint - Failed to handle notification
-...               pyls_jsonrpc.endpoint - Failed to handle request
+...               pylsp_jsonrpc.endpoint - Failed to handle notification
+...               pylsp_jsonrpc.endpoint - Failed to handle request