Skip to content

Commit 39c042e

Browse files
authored
Merge pull request #457 from krassowski/v3.0.0
Release 3.0.0
2 parents c9ba03b + 89ab55a commit 39c042e

File tree

5 files changed

+30
-20
lines changed

5 files changed

+30
-20
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
## CHANGELOG
22

3-
### `@krassowski/jupyterlab-lsp 3.0.0` (2021-01-XX)
3+
### `@krassowski/jupyterlab-lsp 3.0.0` (2021-01-06)
44

55
- features
66

77
- support for JupyterLab 3.0 ([#452], [#402])
88

9-
### `jupyter-lsp 1.0.0` (2021-XX-XX)
9+
### `jupyter-lsp 1.0.0` (2021-01-06)
1010

1111
- features
1212

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ jlpm bootstrap
8585
jupyter labextension develop python_packages/jupyterlab_lsp/ --overwrite
8686
```
8787

88+
> Note: on Windows you may need to enable Developer Mode first, as discussed in [jupyterlab#9564](https://github.com/jupyterlab/jupyterlab/issues/9564)
89+
8890
### Frontend Development
8991

9092
To rebuild the schemas, packages, and the JupyterLab app:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Use context menu on rows in the panel to filter out diagnostics or copy their me
7575

7676
## Prerequisites
7777

78-
You will need to have all of the following installed:
78+
You will need to have both of the following installed:
7979

8080
- JupyterLab >=3.0.0,<4.0.0a0
8181
- Python 3.6+

docs/Installation.ipynb

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@
8282
"source": [
8383
"### Fast Paths\n",
8484
"\n",
85-
"Here are two approches based on Jupyter documentation. If these do not meet your\n",
86-
"needs, try [The Harder Way](#The-Harder-Way)."
85+
"Here are two approaches based on Jupyter documentation. If these do not meet\n",
86+
"your needs, try [The Harder Way](#The-Harder-Way)."
8787
]
8888
},
8989
{
@@ -98,12 +98,11 @@
9898
"#### conda (minimal python)\n",
9999
"\n",
100100
"```bash\n",
101-
"conda create -c conda-forge -n lsp 'python {REQUIRED_PYTHON}' 'jupyterlab={JUPYTERLAB_VERSION}' 'jupyter-lsp-python={JUPYTER_LSP_VERSION}'\n",
101+
"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",
102102
"# jupyter-lsp-python includes both the server extension (jupyter-lsp) and pyls third-party server (python-language-server)\n",
103103
"# if you swap it with another pre-made bundle, jupyter-lsp-r, you will get the server extension and r-languageserver;\n",
104-
"# alternatively, use jupyter-lsp and manually install a language server of your choice (see the table below).\n",
104+
"# alternatively, manually install a language server of your choice (see the table below).\n",
105105
"conda activate lsp\n",
106-
"jupyter labextension install '@krassowski/jupyterlab-lsp@{JUPYTERLAB_LSP_VERSION}'\n",
107106
"```\n",
108107
"\n",
109108
"Then run\n",
@@ -124,7 +123,10 @@
124123
"This approach is based roughly on the\n",
125124
"[Jupyter docker-stacks documentation](https://github.com/jupyter/docker-stacks/tree/master/examples/docker-compose/notebook),\n",
126125
"which should be consulted for more about connecting volumes, passwords, and\n",
127-
"other advanced features:"
126+
"other advanced features:\n",
127+
"\n",
128+
"> Note: docker instructions were **not** updated for JupyterLab 3.0 and\n",
129+
"> extension 3.0. Please consider submitting a PR to fix it."
128130
]
129131
},
130132
{
@@ -242,15 +244,13 @@
242244
"##### conda\n",
243245
"\n",
244246
"```bash\n",
245-
"conda install jupyter-lsp={JUPYTER_LSP_VERSION}\n",
246-
"jupyter labextension install @krassowski/jupyterlab-lsp@{JUPYTERLAB_LSP_VERSION}\n",
247+
"conda install jupyterlab-lsp={JUPYTERLAB_LSP_VERSION}\n",
247248
"```\n",
248249
"\n",
249250
"##### pip\n",
250251
"\n",
251252
"```bash\n",
252-
"pip install jupyter-lsp=={JUPYTER_LSP_VERSION}\n",
253-
"jupyter labextension install @krassowski/jupyterlab-lsp@{JUPYTERLAB_LSP_VERSION}\n",
253+
"pip install jupyterlab-lsp={JUPYTERLAB_LSP_VERSION}\n",
254254
"```"
255255
]
256256
},

scripts/integrity.py

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@
6565
PY_FRONT_PATH = PY_PATH / "jupyterlab_lsp"
6666

6767
# py stuff
68-
PY_NAME = "jupyter-lsp"
68+
PY_SERVER_NAME = "jupyter-lsp"
69+
PY_FRONT_NAME = "jupyterlab-lsp"
6970

7071

7172
# CI stuff
@@ -167,7 +168,7 @@ def test_jlab_versions(path):
167168
@pytest.mark.parametrize(
168169
"pkg,version",
169170
[
170-
[PY_NAME, Version(PY_SERVER_VERSION).base_version],
171+
[PY_SERVER_NAME, Version(PY_SERVER_VERSION).base_version],
171172
[JS_LSP_NAME, JS_LSP_VERSION],
172173
[JS_CJS_NAME, JS_CJS_VERSION],
173174
],
@@ -180,15 +181,22 @@ def test_changelog_versions(pkg, version):
180181
@pytest.mark.parametrize(
181182
"pkg,sep,version,expected",
182183
[
183-
[PY_NAME, "=", PY_SERVER_VERSION, 2],
184-
[PY_NAME, "==", PY_SERVER_VERSION, 1],
185-
[PY_NAME + "-python", "=", PY_SERVER_VERSION, 1],
186-
[JS_LSP_NAME, "@", JS_LSP_VERSION, 4],
184+
[PY_SERVER_NAME, "=", PY_SERVER_VERSION, 1], # TODO: update docker instructions
185+
[
186+
PY_SERVER_NAME,
187+
"==",
188+
PY_SERVER_VERSION,
189+
0,
190+
], # zero because jupyterlab-lsp is good enough
191+
[PY_SERVER_NAME + "-python", "=", PY_SERVER_VERSION, 1],
192+
[JS_LSP_NAME, "@", JS_LSP_VERSION, 1], # TODO: update docker instructions
193+
[PY_FRONT_NAME, "=", JS_LSP_VERSION, 3],
187194
],
188195
)
189196
def test_installation_versions(the_installation_notebook, pkg, sep, version, expected):
190197
"""are the first-party versions consistent with the package metadata?"""
191-
assert the_installation_notebook.count(f"{pkg}{sep}{version}") == expected
198+
spec = f"{pkg}{sep}{version}"
199+
assert the_installation_notebook.count(spec) == expected, spec
192200

193201

194202
@pytest.mark.parametrize(

0 commit comments

Comments
 (0)