Merge pull request #938 from ackalker/ackalker/issue937

Installed bash_language_server not detected / not usable

Author: krassowski

atest/01_Editor.robot

@@ -9,7 +9,10 @@ Test Tags       ui:editor    aspect:ls:features
 
 *** Test Cases ***
 Bash
-    Editor Shows Features for Language    Bash    example.sh    Diagnostics=Failed to parse expression
+    Editor Shows Features for Language
+    ...    Bash
+    ...    example.sh
+    ...    Diagnostics=Double quote to prevent globbing and word splitting.
     ...    Jump to Definition=fib
 
 CSS

atest/03_Notebook.robot

@@ -49,12 +49,12 @@ Moving Cells Around
 Foreign Extractors
     ${file} =    Set Variable    Foreign extractors.ipynb
     Configure JupyterLab Plugin
-    ...    {"language_servers": {"texlab": {"serverSettings": {"chktex.onOpenAndSave": true}}, "bash-langauge-server": {"bashIde.highlightParsingErrors": true}}, "pylsp": {"priority": 1000}}
+    ...    {"language_servers": {"texlab": {"serverSettings": {"chktex.onOpenAndSave": true}}, "bash-langauge-server": {"bashIde.enableSourceErrorDiagnostics": true}}, "pylsp": {"priority": 1000}}
     Capture Page Screenshot    10-configured.png
     Reset Application State
     Setup Notebook    Python    ${file}
     @{diagnostics} =    Create List
-    ...    Failed to parse expression    # bash, configured by spec.env
+    ...    Double quote to prevent globbing and word splitting    # bash, configured by spec.env
     ...    ame 'valid'    # python, mypy and pyflakes will fight over `(N|n)ame 'valid'`, just hope for the best
     ...    Trailing whitespace is superfluous.    # r
     ...    `frob` is misspelt    # markdown

atest/examples/Foreign extractors.ipynb

@@ -64,7 +64,7 @@
    "outputs": [],
    "source": [
     "%%bash\n",
-    "echo $"
+    "echo $MY_VAR"
    ]
   },
   {
@@ -105,7 +105,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -119,7 +119,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.9"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

package.json

@@ -3,7 +3,7 @@
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.46.0",
     "@typescript-eslint/parser": "^5.46.0",
-    "bash-language-server": "^3.0.0",
+    "bash-language-server": "^4.9.2",
     "dictionary-en": "^3.0.0",
     "dockerfile-language-server-nodejs": "^0.7.1",
     "eslint": "^8.29.0",

packages/jupyterlab-lsp/schema/plugin.json

@@ -31,12 +31,17 @@
   "properties": {
     "language_servers": {
       "title": "Language Server",
-      "description": "Language-server specific configuration, keyed by implementation, e.g: \n\npyls: {\n  serverSettings: {\n    pyls: {\n      plugins: {\n        pydocstyle: {\n          enabled: true\n        },\n        pyflakes: {\n          enabled: false\n        },\n        flake8: {\n          enabled: true\n        }\n      }\n    }\n  }\n}\n\nAlternatively, using VSCode's naming convention:\n\npyls: {\n  serverSettings: {\n    \"pyls.plugins.pydocstyle.enabled\": true,\n    \"pyls.plugins.pyflakes.enabled\": false,\n    \"pyls.plugins.flake8.enabled\": true\n  }\n}",
+      "description": "Language-server specific configuration, keyed by implementation, e.g: \n\npyls: {\n  serverSettings: {\n    pyls: {\n      plugins: {\n        pydocstyle: {\n          enabled: true\n        },\n        pyflakes: {\n          enabled: false\n        },\n        flake8: {\n          enabled: true\n        }\n      }\n    }\n  }\n}\n\nAlternatively, using dotted naming convention:\n\npyls: {\n  serverSettings: {\n    \"pyls.plugins.pydocstyle.enabled\": true,\n    \"pyls.plugins.pyflakes.enabled\": false,\n    \"pyls.plugins.flake8.enabled\": true\n  }\n}",
       "default": {
         "pyright": {
           "serverSettings": {
             "python.analysis.useLibraryCodeForTypes": true
           }
+        },
+        "bash-language-server": {
+          "serverSettings": {
+            "bashIde.enableSourceErrorDiagnostics": true
+          }
         }
       },
       "patternProperties": {

python_packages/jupyter_lsp/jupyter_lsp/specs/bash_language_server.py

@@ -1,18 +1,20 @@
+from ..types import LanguageServerManagerAPI
 from .config import load_config_schema
 from .utils import NodeModuleSpec
 
 
 class BashLanguageServer(NodeModuleSpec):
     node_module = key = "bash-language-server"
-    script = ["bin", "main.js"]
+    script = ["out", "cli.js"]
+    fallback_script = ["bin", "main.js"]
     args = ["start"]
     languages = ["bash", "sh"]
     spec = dict(
         display_name=key,
         mime_types=["text/x-sh", "application/x-sh"],
         urls=dict(
-            home="https://github.com/mads-hartmann/{}".format(key),
-            issues="https://github.com/mads-hartmann/{}/issues".format(key),
+            home="https://github.com/bash-lsp/{}".format(key),
+            issues="https://github.com/bash-lsp/{}/issues".format(key),
         ),
         install=dict(
             npm="npm install --save-dev {}".format(key),
@@ -21,3 +23,11 @@ class BashLanguageServer(NodeModuleSpec):
         ),
         config_schema=load_config_schema(key),
     )
+
+    def solve(self, mgr: LanguageServerManagerAPI):
+        new_path = mgr.find_node_module(self.node_module, *self.script)
+        if new_path:
+            return new_path
+        return mgr.find_node_module(
+            self.node_module, *self.fallback_script
+        )  # pragma: no cover

python_packages/jupyter_lsp/jupyter_lsp/specs/config/README.md

@@ -2,10 +2,10 @@
 
 These are configuration schemas extracted from canonical upstreams:
 
-- [bash-language-server](https://github.com/mads-hartmann/bash-language-server/blob/master/vscode-client/package.json)
-- [pyls](https://github.com/palantir/python-language-server/blob/develop/vscode-client/package.json)
+- [bash-language-server](https://github.com/bash-lsp/bash-language-server/blob/master/vscode-client/package.json)
+- [pylsp](https://github.com/python-lsp/python-lsp-server/blob/develop/pylsp/config/schema.json)
 - [dockerfile-language-server-nodejs](https://github.com/microsoft/vscode-docker/blob/master/package.json)
 - [yaml-language-server](https://github.com/redhat-developer/vscode-yaml/blob/master/package.json)
 
 > All of the configurations are sent to the Language Server, but only some of them
-> are actually acted upon, but we don't which is which, yet.
+> are actually acted upon, but we don't know which is which, yet.

python_packages/jupyter_lsp/jupyter_lsp/specs/config/bash-language-server.schema.json

@@ -2,20 +2,47 @@
   "type": "object",
   "title": "Bash IDE configuration",
   "properties": {
+    "bashIde.backgroundAnalysisMaxFiles": {
+      "type": "number",
+      "default": 500,
+      "description": "Maximum number of files to analyze in the background. Set to 0 to disable background analysis.",
+      "minimum": 0
+    },
+    "bashIde.enableSourceErrorDiagnostics": {
+      "type": "boolean",
+      "default": false,
+      "description": "Enable diagnostics for source errors. Ignored if includeAllWorkspaceSymbols is true."
+    },
+    "bashIde.explainshellEndpoint": {
+      "type": "string",
+      "default": "",
+      "description": "Configure explainshell server endpoint in order to get hover documentation on flags and options."
+    },
     "bashIde.globPattern": {
       "type": "string",
       "default": "**/*@(.sh|.inc|.bash|.command)",
-      "description": "Glob pattern for finding and parsing shell script files."
+      "description": "Glob pattern for finding and parsing shell script files in the workspace. Used by the background analysis features across files."
     },
-    "bashIde.highlightParsingErrors": {
+    "bashIde.includeAllWorkspaceSymbols": {
       "type": "boolean",
       "default": false,
-      "description": "Controls if parsing errors will be highlighted as problems."
+      "description": "Controls how symbols (e.g. variables and functions) are included and used for completion and documentation. If false (default and recommended), then we only include symbols from sourced files (i.e. using non dynamic statements like 'source file.sh' or '. file.sh' or following ShellCheck directives). If true, then all symbols from the workspace are included."
     },
-    "bashIde.explainshellEndpoint": {
+    "bashIde.logLevel": {
+      "type": "string",
+      "default": "info",
+      "enum": ["debug", "info", "warning", "error"],
+      "description": "Controls the log level of the language server."
+    },
+    "bashIde.shellcheckPath": {
+      "type": "string",
+      "default": "shellcheck",
+      "description": "Controls the executable used for ShellCheck linting information. An empty string will disable linting."
+    },
+    "bashIde.shellcheckArguments": {
       "type": "string",
       "default": "",
-      "description": "Configure explainshell server in order to get hover documentation on flags and options."
+      "description": "Additional ShellCheck arguments. Note that we already add the following arguments: --shell, --format, --external-sources."
     }
   }
 }

requirements/github-actions.yml

@@ -27,6 +27,8 @@ dependencies:
   - r-languageserver
   - r-stringi >=1.4.6
   - rpy2
+  # bash-language-server
+  - shellcheck
   # tex
   - tectonic
   - texlab