Skip to content

Commit 39378ad

Browse files
Add information on eslint and how to install and run it
1 parent 7f4f189 commit 39378ad

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,8 @@ GUI tests are checked with the GUI testsuite. To run it, you need to install `np
144144
cargo test --test gui
145145
```
146146
147-
The first time, it'll fail and ask you to install the `browser-ui-test` package. Install it then re-run the tests.
147+
The first time, it'll fail and ask you to install the `browser-ui-test` package. Install it with the provided
148+
command then re-run the tests.
148149
149150
If you want to disable the headless mode, use the `DISABLE_HEADLESS_TEST=1` environment variable:
150151
@@ -156,6 +157,21 @@ The GUI tests are in the directory `tests/gui` in text files with the `.goml` ex
156157
using a `node.js` framework called `browser-ui-test`. You can find documentation for this language on its
157158
[repository](https://github.com/GuillaumeGomez/browser-UI-test/blob/master/goml-script.md).
158159
160+
### Checking changes in `.js` files
161+
162+
The `.js` files source code is checked using [`eslint`](https://eslint.org/). This is a linter (just like `clippy` in Rust)
163+
for the Javascript language. You can install it with `npm` by running the following command:
164+
165+
```
166+
npm install
167+
```
168+
169+
Then you can run it using:
170+
171+
```
172+
npm run lint
173+
```
174+
159175
## Updating highlight.js
160176
161177
The following are instructions for updating [highlight.js](https://highlightjs.org/).

0 commit comments

Comments
 (0)