Merge pull request #457 from krassowski/v3.0.0

Release 3.0.0

Author: krassowski

CHANGELOG.md

@@ -1,12 +1,12 @@
 ## CHANGELOG
 
-### `@krassowski/jupyterlab-lsp 3.0.0` (2021-01-XX)
+### `@krassowski/jupyterlab-lsp 3.0.0` (2021-01-06)
 
 - features
 
   - support for JupyterLab 3.0 ([#452], [#402])
 
-### `jupyter-lsp 1.0.0` (2021-XX-XX)
+### `jupyter-lsp 1.0.0` (2021-01-06)
 
 - features
 

CONTRIBUTING.md

@@ -85,6 +85,8 @@ jlpm bootstrap
 jupyter labextension develop python_packages/jupyterlab_lsp/ --overwrite
 ```
 
+> Note: on Windows you may need to enable Developer Mode first, as discussed in [jupyterlab#9564](https://github.com/jupyterlab/jupyterlab/issues/9564)
+
 ### Frontend Development
 
 To rebuild the schemas, packages, and the JupyterLab app:

README.md

@@ -75,7 +75,7 @@ Use context menu on rows in the panel to filter out diagnostics or copy their me
 
 ## Prerequisites
 
-You will need to have all of the following installed:
+You will need to have both of the following installed:
 
 - JupyterLab >=3.0.0,<4.0.0a0
 - Python 3.6+

docs/Installation.ipynb

@@ -82,8 +82,8 @@
    "source": [
     "### Fast Paths\n",
     "\n",
-    "Here are two approches based on Jupyter documentation. If these do not meet your\n",
-    "needs, try [The Harder Way](#The-Harder-Way)."
+    "Here are two approaches based on Jupyter documentation. If these do not meet\n",
+    "your needs, try [The Harder Way](#The-Harder-Way)."
    ]
   },
   {
@@ -98,12 +98,11 @@
     "#### conda (minimal python)\n",
     "\n",
     "```bash\n",
-    "conda create -c conda-forge -n lsp 'python {REQUIRED_PYTHON}' 'jupyterlab={JUPYTERLAB_VERSION}' 'jupyter-lsp-python={JUPYTER_LSP_VERSION}'\n",
+    "conda create -c conda-forge -n lsp 'python {REQUIRED_PYTHON}' 'jupyterlab={JUPYTERLAB_VERSION}' 'jupyterlab-lsp={JUPYTERLAB_LSP_VERSION}' 'jupyter-lsp-python={JUPYTER_LSP_VERSION}'\n",
     "# jupyter-lsp-python includes both the server extension (jupyter-lsp) and pyls third-party server (python-language-server)\n",
     "# if you swap it with another pre-made bundle, jupyter-lsp-r, you will get the server extension and r-languageserver;\n",
-    "# alternatively, use jupyter-lsp and manually install a language server of your choice (see the table below).\n",
+    "# alternatively, manually install a language server of your choice (see the table below).\n",
     "conda activate lsp\n",
-    "jupyter labextension install '@krassowski/jupyterlab-lsp@{JUPYTERLAB_LSP_VERSION}'\n",
     "```\n",
     "\n",
     "Then run\n",
@@ -124,7 +123,10 @@
     "This approach is based roughly on the\n",
     "[Jupyter docker-stacks documentation](https://github.com/jupyter/docker-stacks/tree/master/examples/docker-compose/notebook),\n",
     "which should be consulted for more about connecting volumes, passwords, and\n",
-    "other advanced features:"
+    "other advanced features:\n",
+    "\n",
+    "> Note: docker instructions were **not** updated for JupyterLab 3.0 and\n",
+    "> extension 3.0. Please consider submitting a PR to fix it."
    ]
   },
   {
@@ -242,15 +244,13 @@
     "##### conda\n",
     "\n",
     "```bash\n",
-    "conda install jupyter-lsp={JUPYTER_LSP_VERSION}\n",
-    "jupyter labextension install @krassowski/jupyterlab-lsp@{JUPYTERLAB_LSP_VERSION}\n",
+    "conda install jupyterlab-lsp={JUPYTERLAB_LSP_VERSION}\n",
     "```\n",
     "\n",
     "##### pip\n",
     "\n",
     "```bash\n",
-    "pip install jupyter-lsp=={JUPYTER_LSP_VERSION}\n",
-    "jupyter labextension install @krassowski/jupyterlab-lsp@{JUPYTERLAB_LSP_VERSION}\n",
+    "pip install jupyterlab-lsp={JUPYTERLAB_LSP_VERSION}\n",
     "```"
    ]
   },

scripts/integrity.py

@@ -65,7 +65,8 @@
 PY_FRONT_PATH = PY_PATH / "jupyterlab_lsp"
 
 # py stuff
-PY_NAME = "jupyter-lsp"
+PY_SERVER_NAME = "jupyter-lsp"
+PY_FRONT_NAME = "jupyterlab-lsp"
 
 
 # CI stuff
@@ -167,7 +168,7 @@ def test_jlab_versions(path):
 @pytest.mark.parametrize(
     "pkg,version",
     [
-        [PY_NAME, Version(PY_SERVER_VERSION).base_version],
+        [PY_SERVER_NAME, Version(PY_SERVER_VERSION).base_version],
         [JS_LSP_NAME, JS_LSP_VERSION],
         [JS_CJS_NAME, JS_CJS_VERSION],
     ],
@@ -180,15 +181,22 @@ def test_changelog_versions(pkg, version):
 @pytest.mark.parametrize(
     "pkg,sep,version,expected",
     [
-        [PY_NAME, "=", PY_SERVER_VERSION, 2],
-        [PY_NAME, "==", PY_SERVER_VERSION, 1],
-        [PY_NAME + "-python", "=", PY_SERVER_VERSION, 1],
-        [JS_LSP_NAME, "@", JS_LSP_VERSION, 4],
+        [PY_SERVER_NAME, "=", PY_SERVER_VERSION, 1],  # TODO: update docker instructions
+        [
+            PY_SERVER_NAME,
+            "==",
+            PY_SERVER_VERSION,
+            0,
+        ],  # zero because jupyterlab-lsp is good enough
+        [PY_SERVER_NAME + "-python", "=", PY_SERVER_VERSION, 1],
+        [JS_LSP_NAME, "@", JS_LSP_VERSION, 1],  # TODO: update docker instructions
+        [PY_FRONT_NAME, "=", JS_LSP_VERSION, 3],
     ],
 )
 def test_installation_versions(the_installation_notebook, pkg, sep, version, expected):
     """are the first-party versions consistent with the package metadata?"""
-    assert the_installation_notebook.count(f"{pkg}{sep}{version}") == expected
+    spec = f"{pkg}{sep}{version}"
+    assert the_installation_notebook.count(spec) == expected, spec
 
 
 @pytest.mark.parametrize(