Use consistent formatting for build system errors #9340
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
charliermarsh
force-pushed
the
charlie/format
branch
from
087878c
to
20bb50a
Compare
charliermarsh
commented
Nov 21, 2024
| @@ -1105,7 +1105,7 @@ impl std::fmt::Display for PubGrubHint { | |||
| Self::InvalidPackageMetadata { package, reason } => { | |||
| write!( | |||
| f, | |||
| "{}{} Metadata for {} could not be parsed:\n{}", | |||
| "{}{} Metadata for `{}` could not be parsed:\n{}", | |||
| "hint".bold().cyan(), | |||
| ":".bold(), | |||
| package.bold(), | |||
There was a problem hiding this comment.
Should the package names be cyan? In the build failures, they're now cyan (but not bold)... But here, they're just bold.
charliermarsh
force-pushed
the
charlie/format
branch
4 times, most recently
from
974bb3d
to
4a5cd25
Compare
charliermarsh
commented
Nov 22, 2024
| @@ -1068,7 +1068,7 @@ impl std::fmt::Display for PubGrubHint { | |||
| Self::PrereleaseRequested { package, range } => { | |||
| write!( | |||
| f, | |||
| "{}{} {} was requested with a pre-release marker (e.g., {}), but pre-releases weren't enabled (try: `{}`)", | |||
| "{}{} `{}` was requested with a pre-release marker (e.g., {}), but pre-releases weren't enabled (try: `{}`)", | |||
There was a problem hiding this comment.
Maybe this is bad? We don't use backticks around the package name in the PubGrub error message (just this hint, now).
charliermarsh
force-pushed
the
charlie/format
branch
from
4a5cd25
to
126943b
Compare
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.
Summary
These look pretty different from the help / hint messages we show on resolver failure. I've added color, backticks, and a "hint:" prefix.
Before:
After: