Commit 91f915d

committed

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

1 parent 57117cf commit 91f915dCopy full SHA for 91f915d

File tree

+12

-4

lines changed

+12

-4

lines changed

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ jobs:`
`14`	`14`	`if: github.repository == 'rust-lang/rustc-dev-guide'`
`15`	`15`	`runs-on: ubuntu-latest`
`16`	`16`	`env:`
`17`		`- MDBOOK_VERSION: 0.4.52`
	`17`	`+ MDBOOK_VERSION: 0.4.48`
`18`	`18`	`MDBOOK_LINKCHECK2_VERSION: 0.9.1`
`19`	`19`	`MDBOOK_MERMAID_VERSION: 0.12.6`
`20`	`20`	`MDBOOK_OUTPUT__LINKCHECK__FOLLOW_WEB_LINKS: ${{ github.event_name != 'pull_request' }}`

Lines changed: 0 additions & 3 deletions

Original file line number	Diff line number	Diff line change
@@ -370,9 +370,6 @@ You can also use `rustdoc` directly to check small fixes. For example,
`370`	`370`	`rustdoc src/doc/reference.md` will render reference to `doc/reference.html`.
`371`	`371`	`The CSS might be messed up, but you can verify that the HTML is right.`
`372`	`372`
`373`		`-Please notice that at this time we don't accept typography/spellcheck fixes to internal documentation (example:`
`374`		`-tests, library or compiler code) as it's usually not worth the churn or the review time.`
`375`		`-`
`376`	`373`	`### Contributing to rustc-dev-guide`
`377`	`374`
`378`	`375`	`Contributions to the [rustc-dev-guide] are always welcome, and can be made directly at`

Lines changed: 11 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -60,6 +60,17 @@ 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 test tidy --extra-checks=js` to run ESLint/TSC checks on rustdoc's frontend code.
	`64`	`+`
	`65`	`+### Frontend CI checks`
	`66`	`+`
	`67`	+Rustdoc's JavaScript and TypeScript are checked by ESLint and `tsc` during CI, not by compiletest. These run as part of the tidy job:
	`68`	`+`
	`69`	+```bash
	`70`	`+./x.py test tidy --extra-checks=js`
	`71`	+```
	`72`	`+`
	`73`	+The `--extra-checks=js` flag enables the frontend linting that runs in CI.
`63`	`74`
`64`	`75`	[`bootstrap.toml`]: ./building/how-to-build-and-run.md
`65`	`76`

Comments

(0)