Skip to content

Commit 8c7d4ab

Browse files
committed
some docs updates around development
1 parent 995a4be commit 8c7d4ab

File tree

2 files changed

+40
-19
lines changed

2 files changed

+40
-19
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -156,23 +156,37 @@ jupyter labextension install @krassowski/jupyterlab-lsp@0.5.0-rc.0
156156

157157
## Development
158158

159-
For a development install (requires npm version 4 or later), do the following in the repository directory:
159+
For a development install (requires `nodejs` 8 or later and `jupyterlab` 1.1),
160+
run the following in the repository directory:
160161

161162
```bash
162-
npm install
163-
npm run build
164-
jupyter labextension link .
163+
jlpm
164+
jlpm build
165+
jupyter labextension install .
165166
```
166167

167168
To rebuild the package and the JupyterLab app:
168169

169170
```bash
170-
npm run build
171+
jlpm build
171172
jupyter lab build
172173
```
173174

174-
To run tests suite:
175+
To watch the files and build continuously:
175176

176177
```bash
177-
npm test
178+
jlpm watch # leave this running...
179+
jupyter lab --watch # ...in another terminal
180+
```
181+
182+
To check and fix code style:
183+
184+
```bash
185+
jlpm lint
186+
```
187+
188+
To run test the suite:
189+
190+
```bash
191+
jlpm test
178192
```

py_src/jupyter_lsp/CONTRIBUTING.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,15 @@ python scripts/utest.py
157157

158158
### Browser-based Acceptance Tests
159159

160+
The browser tests will launch JupyterLab on a random port and exercise the
161+
Language Server features with [Robot Framework][] and [SeleniumLibrary][].
162+
163+
[robot framework]: https://github.com/robotframework/robotframework
164+
[seleniumlibrary]: https://github.com/robotframework/seleniumlibrary
165+
166+
First, ensure you've prepared JupyterLab for `jupyterlab-lsp`
167+
[development](../../README.md#development).
168+
160169
Prepare the enviroment:
161170

162171
```bash
@@ -165,22 +174,20 @@ conda env update -n jupyterlab-lsp --file environment-atest.yml
165174
pip install -r requirements-atest.txt # ... and install geckodriver, somehow
166175
```
167176

168-
> To use with `jupyterlab-lsp` in JupyterLab, ensure you've
169-
>
170-
> ```
171-
> jlpm
172-
> jlpm build
173-
> jupyter labextension install .
174-
> ```
175-
176-
````
177-
> in the root of this repo. See the [README](../../README.md#development) for more
178-
179177
Run the tests:
180178

181179
```bash
182180
python scripts/atest.py
183-
````
181+
```
182+
183+
The Robot Framework reports and screenshots will be in `atest/output`, with
184+
`<operating system>_<python version>.log.html` being the most interesting
185+
artifacts, e.g.
186+
187+
```
188+
- linux_37.log.html
189+
- linux_37.report.html
190+
```
184191

185192
### Formatting
186193

0 commit comments

Comments
 (0)