Merge pull request #245 from trajamsmith/server-config

Language server configuration using the Advanced Settings Editor

Author: krassowski

README.md

@@ -194,11 +194,57 @@ jupyter labextension install @krassowski/[email protected]
 
 ### Configuring the servers
 
-We plan to provide a configuration GUI at some time ([#25](https://github.com/krassowski/jupyterlab-lsp/issues/25)), but in the meantime, you can use the instructions for the specific servers as described on their websites (see the [table of language servers][language-servers] for links).
+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:
+
+```json
+{
+  "language_servers": {
+    "pyls": {
+      "serverSettings": {
+        "pyls.plugins.pydocstyle.enabled": true,
+        "pyls.plugins.pyflakes.enabled": false,
+        "pyls.plugins.flake8.enabled": true
+      }
+    },
+    "r-languageserver": {
+      "serverSettings": {
+        "r.lsp.debug": false,
+        "r.lsp.diagnostics": false
+      }
+    }
+  }
+}
+```
+
+The `serverSettings` key specifies the configurations sent to the language servers. These can be written using stringified dot accessors like above (in the VSCode style), or as nested JSON objects, e.g.:
+
+```json
+{
+  "language_servers": {
+    "pyls": {
+      "serverSettings": {
+        "pyls": {
+          "plugins": {
+            "pydocstyle": {
+              "enabled": true
+            },
+            "pyflakes": {
+              "enabled": false
+            },
+            "flake8": {
+              "enabled": true
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
 
-#### I want to hide specific diagnostics/inspections/warnings
+#### Other configuration methods
 
-For example, the Python server that we support by default ([pyls](https://github.com/palantir/python-language-server)) has a [configuration section](https://github.com/palantir/python-language-server#configuration) in their documentation which refers to the providers of specific features, including `pycodestyle` for inspections/diagnostics.
+Some language servers, such as `pyls`, provide other configuration methods _in addition_ to language-server configuration messages (accessed using the Advanced Settings Editor). For example, `pyls` allows users to configure the server using a local configuration file. You can change the inspection/diagnostics for server plugins like `pycodestyle` there.
 
 The exact configuration details will vary between operating systems (please see the [configuration section of pycodestyle documentation](https://pycodestyle.readthedocs.io/en/latest/intro.html#configuration)), but as an example, on Linux you would simply need to create a file called `~/.config/pycodestyle`, which may look like that:
 

atest/01_Editor.robot

@@ -32,6 +32,9 @@ Less
     ${def} =    Set Variable    xpath:(//span[contains(@class, 'cm-variable-2')][contains(text(), '@width')])[last()]
     Editor Shows Features for Language    Less    example.less    Diagnostics=Do not use empty rulesets    Jump to Definition=${def}
 
+Markdown
+    Editor Shows Features for Language    Markdown    example.md    Diagnostics=`Color` is misspelt
+
 Python
     ${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}
@@ -58,12 +61,7 @@ YAML
 *** Keywords ***
 Editor Shows Features for Language
     [Arguments]    ${Language}    ${file}    &{features}
-    Set Tags    language:${Language.lower()}
-    Set Screenshot Directory    ${OUTPUT DIR}${/}screenshots${/}editor${/}${Language.lower()}
-    Copy File    examples${/}${file}    ${OUTPUT DIR}${/}home${/}${file}
-    Try to Close All Tabs
-    Open ${file} in ${MENU EDITOR}
-    Capture Page Screenshot    00-opened.png
+    Prepare File for Editing    ${Language}    editor    ${file}
     FOR    ${f}    IN    @{features}
         Run Keyword If    "${f}" == "Diagnostics"    Editor Should Show Diagnostics    ${features["${f}"]}
         ...    ELSE IF    "${f}" == "Jump to Definition"    Editor Should Jump To Definition    ${features["${f}"]}
@@ -106,10 +104,6 @@ Measure Cursor Position
     ${position} =    Wait Until Keyword Succeeds    20 x    0.05s    Get Vertical Position    ${CM CURSOR}
     [Return]    ${position}
 
-Get Editor Content
-    ${content}    Execute JavaScript    return document.querySelector('.CodeMirror').CodeMirror.getValue()
-    [Return]    ${content}
-
 Editor Content Changed
     [Arguments]    ${old_content}
     ${new_content}    Get Editor Content

atest/02_Settings.robot

@@ -5,10 +5,5 @@ Resource          Keywords.robot
 *** Test Cases ***
 Settings
     [Setup]    Reset Application State
-    Lab Command    Advanced Settings Editor
-    Capture Page Screenshot    01-settings-all.png
-    ${sel} =    Set Variable    css:[data-id="@krassowski/jupyterlab-lsp:plugin"]
-    Wait Until Page Contains Element    ${sel}
-    Click Element    ${sel}
-    Wait Until Page Contains    System Defaults
-    Capture Page Screenshot    02-settings-lsp.png
+    Open in Advanced Settings    ${LSP PLUGIN ID}
+    Capture Page Screenshot    01-settings-lsp.png

atest/07_Configuration.robot

@@ -0,0 +1,62 @@
+*** Settings ***
+Documentation     Configuration of language servers
+Suite Setup       Setup Suite For Screenshots    config
+Force Tags        feature:config
+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}}}}
+    ...    undefined name 'foo' (pyflakes)
+    ...    undefined name 'foo' (flake8)
+
+YAML
+    [Documentation]    EXPECT FAIL Composer YAML files don't allow a "greetings" key
+    Settings Should Change Editor Diagnostics    YAML    example.yaml    yaml-language-server
+    ...    {"yaml.schemas": {"http://json.schemastore.org/composer": "*"}}
+    ...    duplicate key
+    ...    Property greetings is not allowed.
+
+Markdown
+    [Documentation]    different englishes spell colou?r differently
+    Settings Should Change Editor Diagnostics    Markdown    example.md    unified-language-server
+    ...    {"unified-language-server":{"remark-parse":{"plugins":[["#remark-retext","#parse-latin"],["#retext-spell","#dictionary-en"]]}}}
+    ...    `Color` is misspelt
+    ...    `Colour` is misspelt
+
+*** Keywords ***
+Clean Up After Working with File and Settings
+    [Arguments]    ${file}
+    Clean Up After Working With File    ${file}
+    Reset Plugin Settings
+
+Settings Should Change Editor Diagnostics
+    [Arguments]    ${language}    ${file}    ${server}    ${settings}    ${before}    ${after}
+    ${before diagnostic} =    Set Variable    ${CSS DIAGNOSTIC}\[title^="${before}"]
+    ${after diagnostic} =    Set Variable    ${CSS DIAGNOSTIC}\[title^="${after}"]
+    ${tab} =    Set Variable    ${JLAB XP DOCK TAB}\[contains(., '${file}')]
+    ${close icon} =    Set Variable    *[contains(@class, 'm-TabBar-tabCloseIcon')]
+    Prepare File for Editing    ${language}    config    ${file}
+    Open in Advanced Settings    ${LSP PLUGIN ID}
+    Drag and Drop By Offset    ${tab}    0    100
+    Wait Until Fully Initialized
+    Open Diagnostics Panel
+    Drag and Drop By Offset    ${JLAB XP DOCK TAB}\[contains(., 'Diagnostics Panel')]    600    -200
+    Click Element    ${JLAB XP DOCK TAB}\[contains(., 'Launcher')]/${close icon}
+    Wait Until Page Contains Element    ${before diagnostic}    timeout=30s
+    Page Should Not Contain    ${after diagnostic}
+    Capture Page Screenshot    01-default-diagnostics-and-settings.png
+    Set Editor Content    {"language_servers": {"${server}": {"serverSettings": ${settings}}}}    ${CSS USER SETTINGS}
+    Wait Until Page Contains    No errors found
+    Capture Page Screenshot    01-default-diagnostics-and-settings.png
+    Click Element    css:button[title\='Save User Settings']
+    Click Element    ${JLAB XP DOCK TAB}\[contains(., 'Settings')]/${close icon}
+    Drag and Drop By Offset    ${tab}    0    100
+    Lab Command    Save ${language} File
+    Ensure Sidebar Is Closed
+    Capture Page Screenshot    02-settings-changed.png
+    Wait Until Page Contains Element    ${after diagnostic}    timeout=30s
+    Capture Page Screenshot    03-configured-diagnostic-found.png
+    [Teardown]    Clean Up After Working with File and Settings    ${file}

atest/Keywords.robot

@@ -55,6 +55,9 @@ Initialize User Settings
     Set Suite Variable    ${SETTINGS DIR}    ${OUTPUT DIR}${/}user-settings    children=${True}
     Create File    ${SETTINGS DIR}${/}@jupyterlab${/}codemirror-extension${/}commands.jupyterlab-settings    {"styleActiveLine": true}
 
+Reset Plugin Settings
+    Create File    ${SETTINGS DIR}${/}${LSP PLUGIN SETTINGS FILE}    {}
+
 Tear Down Everything
     Close All Browsers
     Evaluate    __import__("urllib.request").request.urlopen("${URL}api/shutdown?token=${TOKEN}", data=[])
@@ -246,3 +249,29 @@ Open Context Menu Over
     Wait Until Keyword Succeeds    10 x    0.1 s    Mouse Over    ${sel}
     Wait Until Keyword Succeeds    10 x    0.1 s    Click Element    ${sel}
     Wait Until Keyword Succeeds    10 x    0.1 s    Open Context Menu    ${sel}
+
+Prepare File for Editing
+    [Arguments]    ${Language}    ${Screenshots}    ${file}
+    Set Tags    language:${Language.lower()}
+    Set Screenshot Directory    ${OUTPUT DIR}${/}screenshots${/}${Screenshots}${/}${Language.lower()}
+    Copy File    examples${/}${file}    ${OUTPUT DIR}${/}home${/}${file}
+    Try to Close All Tabs
+    Open ${file} in ${MENU EDITOR}
+    Capture Page Screenshot    00-opened.png
+
+Open in Advanced Settings
+    [Arguments]    ${plugin id}
+    Lab Command    Advanced Settings Editor
+    ${sel} =    Set Variable    css:[data-id="${plugin id}"]
+    Wait Until Page Contains Element    ${sel}
+    Click Element    ${sel}
+    Wait Until Page Contains    System Defaults
+
+Set Editor Content
+    [Arguments]    ${text}    ${css}=${EMPTY}
+    Execute JavaScript    return document.querySelector('${css} .CodeMirror').CodeMirror.setValue(`${text}`)
+
+Get Editor Content
+    [Arguments]    ${css}=${EMPTY}
+    ${content} =    Execute JavaScript    return document.querySelector('${css} .CodeMirror').CodeMirror.getValue()
+    [Return]    ${content}

atest/Variables.robot

@@ -31,3 +31,9 @@ ${MENU SETTINGS}    xpath://div[contains(@class, 'lm-MenuBar-itemLabel')][contai
 ${MENU EDITOR THEME}    xpath://div[contains(@class, 'lm-Menu-itemLabel')][contains(text(), "Text Editor Theme")]
 ${CM CURSOR}      css:.CodeMirror-cursor
 ${CM CURSORS}     css:.CodeMirror-cursors:not([style='visibility: hidden'])
+# settings
+${LSP PLUGIN ID}    @krassowski/jupyterlab-lsp:plugin
+${LSP PLUGIN SETTINGS FILE}    @krassowski${/}jupyterlab-lsp${/}plugin.jupyterlab-settings
+${CSS USER SETTINGS}    .jp-SettingsRawEditor-user
+# diagnostics
+${CSS DIAGNOSTIC}    css:.cm-lsp-diagnostic

atest/examples/composer-schema.yaml

@@ -0,0 +1,4 @@
+name: 0
+foo:
+    bar:
+    bar:

atest/examples/example.md

@@ -0,0 +1,7 @@
+## Colour
+
+Color [link][] ![link][]
+
+  - list item
+
+[link]: http://example.com

atest/examples/example.yaml

@@ -1,3 +1,4 @@
 greetings:
     hello:
-    hello:
+    hello:
+well:

docs/Architecture.ipynb

@@ -22,6 +22,7 @@
     "import IPython\n",
     "\n",
     "\n",
+    "\n",
     "@IPython.core.magic.register_line_cell_magic\n",
     "def dot(line, cell=None):\n",
     "    src = graphviz.Source(pathlib.Path(line).read_text() if line else cell)._repr_svg_()\n",
@@ -170,4 +171,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}