From 0380c326076fe6a181e1c4b86b2b902b8bc025b1 Mon Sep 17 00:00:00 2001 From: Ali Nazzal Date: Sun, 31 Aug 2025 09:51:47 +0300 Subject: [PATCH] docs(rustdoc): document that JS/TS checks run under tidy (eslint, es-check, tsc) --- src/rustdoc.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/rustdoc.md b/src/rustdoc.md index 9290fcd3b..4181c2f7f 100644 --- a/src/rustdoc.md +++ b/src/rustdoc.md @@ -60,6 +60,18 @@ does is call the `main()` that's in this crate's `lib.rs`, though.) * Use `./x test tests/rustdoc*` to run the tests using a stage1 rustdoc. * See [Rustdoc internals] for more information about tests. +* Use `./x.py test tidy --extra-checks=js` to run rustdoc’s JavaScript checks (`eslint`, `es-check`, and `tsc`). +> **Note:** `./x.py test tidy` already runs these checks automatically when JS/TS sources changed; `--extra-checks=js` forces them explicitly. + +### JavaScript CI checks + +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. + +```bash +./x.py test tidy --extra-checks=js +``` + +The `--extra-checks=js` flag enables the frontend linting that runs in CI. [`bootstrap.toml`]: ./building/how-to-build-and-run.md