Skip to content

Commit 495bc5c

Browse files
committed
Update CONTRIBUTING.md: add jupyter develop for symlinking,
add missing npm-run-all package that is used for jlpm watch
1 parent 664c973 commit 495bc5c

File tree

3 files changed

+50
-6
lines changed

3 files changed

+50
-6
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,28 +60,29 @@ Once your environment is created and activated, on Linux/OSX you can run:
6060
bash binder/postBuild
6161
```
6262

63-
This performs all of the basic setup steps, and is used for the binder demo.
63+
This performs all the basic setup steps, and is used for the binder demo.
6464

6565
#### The Hard Way
6666

6767
Install `jupyter-lsp` from source in your virtual environment:
6868

6969
```bash
70-
python -m pip install -e . --ignore-installed --no-deps -vv
70+
python -m pip install -e python_packages/jupter_lsp --ignore-installed --no-deps -vv
7171
```
7272

7373
Enable the server extension:
7474

7575
```bash
76-
jupyter serverextension enable --sys-prefix --py jupyter_lsp
76+
jupyter server extension enable --sys-prefix --py jupyter_lsp
7777
```
7878

7979
Install `npm` dependencies, build TypeScript packages, and link
8080
to JupyterLab for development:
8181

8282
```bash
8383
jlpm bootstrap
84-
pip install .
84+
# if you installed `jupyterlab_lsp` before uninstall it before running the next line
85+
jupyter labextension develop python_packages/jupyterlab_lsp/ --overwrite
8586
```
8687

8788
### Frontend Development
@@ -100,6 +101,9 @@ jlpm watch # leave this running...
100101
jupyter lab --watch # ...in another terminal
101102
```
102103

104+
Now after each change to TypesScript files wait until both watchers finish compilation,
105+
and then refresh the JupyterLab in your browser.
106+
103107
> Note: the backend schema is not included in `watch`, and is only refreshed by `build`
104108
105109
To check and fix code style:
@@ -226,7 +230,7 @@ python scripts/atest.py --test "Works With Kernel Running"
226230

227231
##### Run test with a tag
228232

229-
Tags are preferrable to file names and test name matching in many settings, as
233+
Tags are preferable to file names and test name matching in many settings, as
230234
they are aggregated nicely between runs.
231235

232236
```bash

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
"javascript-typescript-langserver": "^2.11.3",
1717
"jest-github-actions-reporter": "^1.0.2",
1818
"lerna": "^3.13.2",
19+
"npm-run-all": "^4.1.5",
1920
"precise-commits": "^1.0.2",
2021
"prettier": "^2.1.2",
2122
"sql-language-server": "^0.11.4",

yarn.lock

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1736,7 +1736,7 @@
17361736
version "2.0.0"
17371737

17381738
"@krassowski/jupyterlab-lsp@file:packages/jupyterlab-lsp":
1739-
version "2.1.2"
1739+
version "3.0.0"
17401740
dependencies:
17411741
"@krassowski/code-jumpers" "~1.0.0"
17421742
"@krassowski/completion-theme" "~2.0.0"
@@ -9509,6 +9509,11 @@ memory-fs@^0.5.0:
95099509
errno "^0.1.3"
95109510
readable-stream "^2.0.1"
95119511

9512+
memorystream@^0.3.1:
9513+
version "0.3.1"
9514+
resolved "https://registry.yarnpkg.com/memorystream/-/memorystream-0.3.1.tgz#86d7090b30ce455d63fbae12dda51a47ddcaf9b2"
9515+
integrity sha1-htcJCzDORV1j+64S3aUaR93K+bI=
9516+
95129517
meow@^3.3.0:
95139518
version "3.7.0"
95149519
resolved "https://registry.yarnpkg.com/meow/-/meow-3.7.0.tgz#72cb668b425228290abbfa856892587308a801fb"
@@ -10233,6 +10238,21 @@ npm-pick-manifest@^3.0.0:
1023310238
npm-package-arg "^6.0.0"
1023410239
semver "^5.4.1"
1023510240

10241+
npm-run-all@^4.1.5:
10242+
version "4.1.5"
10243+
resolved "https://registry.yarnpkg.com/npm-run-all/-/npm-run-all-4.1.5.tgz#04476202a15ee0e2e214080861bff12a51d98fba"
10244+
integrity sha512-Oo82gJDAVcaMdi3nuoKFavkIHBRVqQ1qvMb+9LHk/cF4P6B2m8aP04hGf7oL6wZ9BuGwX1onlLhpuoofSyoQDQ==
10245+
dependencies:
10246+
ansi-styles "^3.2.1"
10247+
chalk "^2.4.1"
10248+
cross-spawn "^6.0.5"
10249+
memorystream "^0.3.1"
10250+
minimatch "^3.0.4"
10251+
pidtree "^0.3.0"
10252+
read-pkg "^3.0.0"
10253+
shell-quote "^1.6.1"
10254+
string.prototype.padend "^3.0.0"
10255+
1023610256
npm-run-path@^2.0.0:
1023710257
version "2.0.2"
1023810258
resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-2.0.2.tgz#35a9232dfa35d7067b4cb2ddf2357b1871536c5f"
@@ -10996,6 +11016,11 @@ picomatch@^2.0.4, picomatch@^2.0.5, picomatch@^2.2.1:
1099611016
resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.2.2.tgz#21f333e9b6b8eaff02468f5146ea406d345f4dad"
1099711017
integrity sha512-q0M/9eZHzmr0AulXyPwNfZjtwZ/RBZlbN3K3CErVrk50T2ASYI7Bye0EvekFY3IP1Nt2DHu0re+V2ZHIpMkuWg==
1099811018

11019+
pidtree@^0.3.0:
11020+
version "0.3.1"
11021+
resolved "https://registry.yarnpkg.com/pidtree/-/pidtree-0.3.1.tgz#ef09ac2cc0533df1f3250ccf2c4d366b0d12114a"
11022+
integrity sha512-qQbW94hLHEqCg7nhby4yRC7G2+jYHY4Rguc2bjw7Uug4GIJuu1tvf2uHaZv5Q8zdt+WKJ6qK1FOI6amaWUo5FA==
11023+
1099911024
pify@^2.0.0, pify@^2.3.0:
1100011025
version "2.3.0"
1100111026
resolved "https://registry.yarnpkg.com/pify/-/pify-2.3.0.tgz#ed141a6ac043a849ea588498e7dca8b15330e90c"
@@ -12894,6 +12919,11 @@ shebang-regex@^3.0.0:
1289412919
resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172"
1289512920
integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==
1289612921

12922+
shell-quote@^1.6.1:
12923+
version "1.7.2"
12924+
resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.7.2.tgz#67a7d02c76c9da24f99d20808fcaded0e0e04be2"
12925+
integrity sha512-mRz/m/JVscCrkMyPqHc/bczi3OQHkLTqXHEFu0zDhK/qfv3UcOA4SVmRCLmos4bhjr9ekVQubj/R7waKapmiQg==
12926+
1289712927
shelljs@^0.8.2:
1289812928
version "0.8.4"
1289912929
resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.8.4.tgz#de7684feeb767f8716b326078a8a00875890e3c2"
@@ -13452,6 +13482,15 @@ string.prototype.matchall@^4.0.2:
1345213482
regexp.prototype.flags "^1.3.0"
1345313483
side-channel "^1.0.2"
1345413484

13485+
string.prototype.padend@^3.0.0:
13486+
version "3.1.1"
13487+
resolved "https://registry.yarnpkg.com/string.prototype.padend/-/string.prototype.padend-3.1.1.tgz#824c84265dbac46cade2b957b38b6a5d8d1683c5"
13488+
integrity sha512-eCzTASPnoCr5Ht+Vn1YXgm8SB015hHKgEIMu9Nr9bQmLhRBxKRfmzSj/IQsxDFc8JInJDDFA0qXwK+xxI7wDkg==
13489+
dependencies:
13490+
call-bind "^1.0.0"
13491+
define-properties "^1.1.3"
13492+
es-abstract "^1.18.0-next.1"
13493+
1345513494
string.prototype.trimend@^1.0.1:
1345613495
version "1.0.2"
1345713496
resolved "https://registry.yarnpkg.com/string.prototype.trimend/-/string.prototype.trimend-1.0.2.tgz#6ddd9a8796bc714b489a3ae22246a208f37bfa46"

0 commit comments

Comments
 (0)