Color test output and shorten chapter paths #2259
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Here's a screenshot of the output mentioned in the commit message. |
stevecheckoway
force-pushed
the
improve-test-output
branch
from
ae5d06a
to
c7f9390
Compare
Currently, the output from `rustdoc --test` is not colored because
`rustdoc`'s stdout is not a tty. The output of a failed `rustdoc` run is
sent to `mdbook`'s stderr via the `error!()` macro. This commit checks
if stderr is a tty using the standard `.is_terminal()` and if so, passes
`--color always` to `rustdoc`.
The test output from `rustdoc` includes the full path that `rustdoc` was
called with. This obscures the path of the file with the error. E.g.,
```
---- /var/folders/9v/90bm7kb10fx3_bprxltb3t1r0000gn/T/mdbook-tnGJxp/lab0/index.md - Lab_0__Getting_Started (line 3) stdout ----
error: expected one of `!`, `.`, `::`, `;`, `?`, `{`, `}`, or an operator, found `code`
--> /var/folders/9v/90bm7kb10fx3_bprxltb3t1r0000gn/T/mdbook-tnGJxp/lab0/index.md:4:6
|
3 | this code has a bug
| ^^^^ expected one of 8 possible tokens
error: aborting due to previous error
```
This commit runs `rustdoc` in the temp directory and replaces any
relative library paths with absolute library paths. This leads to
simpler error messages. The one above becomes
```
---- lab0/index.md - Lab_0__Getting_Started (line 3) stdout ----
error: expected one of `!`, `.`, `::`, `;`, `?`, `{`, `}`, or an operator, found `code`
--> lab0/index.md:4:6
|
3 | this code has a bug
| ^^^^ expected one of 8 possible tokens
error: aborting due to previous error
```
(with colors, of course).
stevecheckoway
force-pushed
the
improve-test-output
branch
from
c7f9390
to
d61990c
Compare
|
I realized after creating this PR that I had accidentally included an unrelated change that causes I split the commit into two different commits. The first commit makes the changes described above. The second commit just adds these command line options. I'm happy to drop the second commit, but the |
ehuss
force-pushed
the
improve-test-output
branch
from
d61990c
to
32687e6
Compare
ehuss
approved these changes
May 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, the output from
rustdoc --testis not colored becauserustdoc's stdout is not a tty. The output of a failedrustdocrun is sent tomdbook's stderr via theerror!()macro. This commit checks if stderr is a tty using the standard.is_terminal()and if so, passes--color alwaystorustdoc.The test output from
rustdocincludes the full path thatrustdocwas called with. This obfuscates the file with the error. E.g.,This commit runs
rustdocin the temp directory and replaces any relative library paths with absolute library paths. This leads to simpler error messages. The one above becomes(with colors, of course).