Improve discoverability of fix option
#205
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
ddzz
reviewed
Sep 15, 2021
| @@ -35,7 +35,7 @@ export function mismatchingVersionsToOutput( | |||
| return [ | |||
| `Found ${mismatchingDependencyVersions.length} ${ | |||
| mismatchingDependencyVersions.length === 1 ? 'dependency' : 'dependencies' | |||
| } with mismatching versions across the workspace.`, | |||
| } with mismatching versions across the workspace. Fix with \`--fix\`.`, | |||
There was a problem hiding this comment.
Could chalk be used here instead of backticks?
There was a problem hiding this comment.
I don't immediately see a chalk formatting option that looks analogous to the backtick/code markdown formatting i.e. --fix.
There was a problem hiding this comment.
My idea would be to use bold formatting or something similar since the backticks will appear unformatted in a terminal.
There was a problem hiding this comment.
I could try that. One thing I want to be careful about however is that the output looks fine even for users with non-colored terminals.
There was a problem hiding this comment.
I tried bold and I don't think it made sense to highlight it like that. This isn't critical information.
bmish
changed the title
fix option in mismatching version outputfix option
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.
Improves discoverability of this autofix option by showing it when the user sees the mismatching version output. Many users may not realize they can automatically fix all problems detected.