Skip to content

Commit a7aaef1

Browse files
Add information on eslint and how to install and run it
1 parent 9823246 commit a7aaef1

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
@@ -150,7 +150,8 @@ If you want to only run some tests, you can filter them by passing (part of) the
150150
cargo test --test gui -- search
151151
```
152152
153-
The first time, it'll fail and ask you to install the `browser-ui-test` package. Install it then re-run the tests.
153+
The first time, it'll fail and ask you to install the `browser-ui-test` package. Install it with the provided
154+
command then re-run the tests.
154155
155156
If you want to disable the headless mode, use the `--disable-headless-test` option:
156157
@@ -162,6 +163,21 @@ The GUI tests are in the directory `tests/gui` in text files with the `.goml` ex
162163
using a `node.js` framework called `browser-ui-test`. You can find documentation for this language on its
163164
[repository](https://github.com/GuillaumeGomez/browser-UI-test/blob/master/goml-script.md).
164165
166+
### Checking changes in `.js` files
167+
168+
The `.js` files source code is checked using [`eslint`](https://eslint.org/). This is a linter (just like `clippy` in Rust)
169+
for the Javascript language. You can install it with `npm` by running the following command:
170+
171+
```
172+
npm install
173+
```
174+
175+
Then you can run it using:
176+
177+
```
178+
npm run lint
179+
```
180+
165181
## Updating highlight.js
166182
167183
The following are instructions for updating [highlight.js](https://highlightjs.org/).

0 commit comments

Comments
 (0)