Merge pull request #826 from cccs-jc/patch-2

Create Third Party Language Servers.md

Author: krassowski

docs/Language Servers.ipynb

@@ -133,12 +133,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Notebook-optimized Language Servers\n",
+    "### Servers tested with Notebooks\n",
     "\n",
-    "These servers have support for notebooks and file editors. The `pylsp`, and\n",
-    "`r-languageserver`, and `robotframework_ls` implementatoons are well-tested,\n",
-    "while `jedi` and `Julia` servers are experimental. If you choose to install\n",
-    "multiple language servers for the same language, the one with the highest\n",
+    "While most servers should work with notebooks and standalone files, some\n",
+    "require additional adjustments. The following language servers are tested\n",
+    "against `jupyterlab-lsp` and any issues when using them in notebooks\n",
+    "will be prioritised.\n",
+    "\n",
+    "If you choose to install multiple language servers for the same language, the one with the highest\n",
     "`priority` (which can be set in the _Advanced Settings Editor_) will be used."
    ]
   },
@@ -173,26 +175,24 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The Scala language server (`metals`) is not currently auto-detected, but can be\n",
-    "configured as demonstrated in the\n",
-    "[configuration example](./Configuring.html#example-scala-language-server-metals-integration)."
+    "If you plan to add a custom language server for the use with notebooks, please\n",
+    "note that a complete set of information should be provided by the kernel, as\n",
+    "described in\n",
+    "[making custom servers work with notebooks](./Configuring.html#making-custom-servers-work-with-notebooks)."
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "If you plan to add a custom language server for the use with notebooks, please\n",
-    "note that a complete set of information should be provided by the kernel, as\n",
-    "described in\n",
-    "[making custom servers work with notebooks](./Configuring.html#making-custom-servers-work-with-notebooks)."
+    "### Servers tested with file editor"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### NodeJS-based Language Servers\n",
+    "#### Servers requiring Node.js\n",
     "\n",
     "These servers have mostly been tested with file editors."
    ]
@@ -220,7 +220,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "NodeJS (preferrably even-numbered an _Active_ or _Maintenance Long Term Support_\n",
+    "NodeJS (preferably even-numbered an _Active_ or _Maintenance Long Term Support_\n",
     "release) is a prerequisite for installation of any of the above language\n",
     "servers; you can get it with:\n",
     "\n",
@@ -239,11 +239,11 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Example: Getting All the NodeJS-based Language Servers\n",
+    "##### Example: getting all the Node.js-based language servers\n",
     "\n",
     "A number of language servers are built on the\n",
     "[reference implementation](https://github.com/microsoft/vscode-languageserver-node),\n",
-    "powered by NodeJS. The most reliable place to install these is in a\n",
+    "powered by Node.js. The most reliable place to install these is in a\n",
     "`node_modules` in the directory where you launch `jupyter lab`.\n",
     "\n",
     "For example, to install all the servers which are tested as part of\n",
@@ -289,7 +289,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Other scientific languages\n",
+    "#### Standalone servers\n",
     "\n",
     "These servers have been mostly tested with file editor."
    ]
@@ -315,7 +315,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Example: Getting a $\\LaTeX$ stack\n",
+    "##### Example: Getting a $\\LaTeX$ stack\n",
     "\n",
     "```bash\n",
     "conda install --channel conda-forge tectonic texlab chktex\n",
@@ -330,6 +330,49 @@
     "- `chktex`, a `.tex` style checker"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Community-supported servers"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Servers and extensions listed below are not included in the testing suite of `jupyterlab-lsp`; the support may be provided by community members or a third-party:"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "| Languages                 | Implementation                            | Comment       |\n",
+    "|---------------------------|-------------------------------------------|---------------|\n",
+    "|   Spark SQL               | [CybercentreCanada/jupyterlab-sql-editor] |               |\n",
+    "|   GraphQL, SPARQL, Turtle | [jupyrdf/graph-lsp]                       |               |\n",
+    "|   JSON                    | [jupyter-lsp/json-lsp]                    | (1)           |\n",
+    "|   YAML                    | [jupyter-lsp/yaml-lsp]                    | (1)           |\n",
+    "|   Scala                   | [scalameta/metals]                        | (2)           |\n",
+    "\n",
+    "\n",
+    "[jupyrdf/graph-lsp]: https://github.com/jupyrdf/graph-lsp\n",
+    "[CybercentreCanada/jupyterlab-sql-editor]: https://github.com/CybercentreCanada/jupyterlab-sql-editor\n",
+    "[jupyter-lsp/json-lsp]: https://github.com/jupyter-lsp/json-lsp\n",
+    "[jupyter-lsp/yaml-lsp]: https://github.com/jupyter-lsp/yaml-lsp\n",
+    "[scalameta/metals]: https://github.com/scalameta/metals"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "- (1) convenience wrappers for installation with `pip`, require Node.js.\n",
+    "- (2) `metals` is not currently auto-detected, but can be configured as demonstrated in the\n",
+    "[configuration example](./Configuring.html#example-scala-language-server-metals-integration)."
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -389,7 +432,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.0"
+   "version": "3.10.4"
   }
  },
  "nbformat": 4,