Commit 0380c32

committed

docs(rustdoc): document that JS/TS checks run under tidy (eslint, es-check, tsc)

1 parent 57117cf commit 0380c32Copy full SHA for 0380c32

File tree

+12

-0

lines changed

+12

-0

lines changed

Lines changed: 12 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -60,6 +60,18 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)
`60`	`60`	* Use `./x test tests/rustdoc*` to run the tests using a stage1
`61`	`61`	`rustdoc.`
`62`	`62`	`* See [Rustdoc internals] for more information about tests.`
	`63`	+* Use `./x.py test tidy --extra-checks=js` to run rustdoc’s JavaScript checks (`eslint`, `es-check`, and `tsc`).
	`64`	+> Note: `./x.py test tidy` already runs these checks automatically when JS/TS sources changed; `--extra-checks=js` forces them explicitly.
	`65`	`+`
	`66`	`+### JavaScript CI checks`
	`67`	`+`
	`68`	+Rustdoc’s JavaScript and TypeScript are checked during CI by `eslint`, `es-check`, and `tsc` (not by compiletest). These run as part of the `tidy` job.
	`69`	`+`
	`70`	+```bash
	`71`	`+./x.py test tidy --extra-checks=js`
	`72`	+```
	`73`	`+`
	`74`	+The `--extra-checks=js` flag enables the frontend linting that runs in CI.
`63`	`75`
`64`	`76`	[`bootstrap.toml`]: ./building/how-to-build-and-run.md
`65`	`77`

Comments

(0)