mirrors/mdBook
1
0
Fork 0
mirror of https://github.com/rust-lang/mdBook synced 2025-04-29 15:47:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add information on eslint and how to install and run it

Browse Source
This commit is contained in:
Guillaume Gomez 2025-03-21 12:08:11 +01:00
parent 9823246ecd
commit a7aaef1e85
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md
View File

@ -150,7 +150,8 @@ If you want to only run some tests, you can filter them by passing (part of) the
cargo test --test gui -- search
```
The first time, it'll fail and ask you to install the `browser-ui-test` package. Install it then re-run the tests.
The first time, it'll fail and ask you to install the `browser-ui-test` package. Install it with the provided
command then re-run the tests.
If you want to disable the headless mode, use the `--disable-headless-test` option:
@ -162,6 +163,21 @@ The GUI tests are in the directory `tests/gui` in text files with the `.goml` ex
using a `node.js` framework called `browser-ui-test`. You can find documentation for this language on its
[repository](https://github.com/GuillaumeGomez/browser-UI-test/blob/master/goml-script.md).
### Checking changes in `.js` files
The `.js` files source code is checked using [`eslint`](https://eslint.org/). This is a linter (just like `clippy` in Rust)
for the Javascript language. You can install it with `npm` by running the following command:
```
npm install
```
Then you can run it using:
```
npm run lint
```
## Updating highlight.js
The following are instructions for updating [highlight.js](https://highlightjs.org/).