fix(core): more helpful output for format:check --verbose #23503
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
☁️ Nx Cloud ReportCI is running/has finished running commands for commit a832a14. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 6 targets
Sent with 💌 from NxCloud. |
xiongemi
approved these changes
May 22, 2024
FrozenPandaz
pushed a commit
that referenced
this pull request
May 23, 2024
(cherry picked from commit 383be1f)
|
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Nx format is currently exclusively built on top of prettier. We leverage the
--list-differentfeature of prettier to show the user which files failed the formatting check. The simple common case solution is to runnx format:write(powered byprettier --write) and commit the result.Right now a user might want to try and learn more about their
format:checkfailure by passing--verbosebut it will not change the output in any way.Based on the feedback in #4159 some users are expecting to see the diff output of what correct vs incorrect formatting would look like.
However, because nx format is currently exclusively built on top of prettier, it is therefore subject to its limitations. prettier/prettier#6885 remains unresolved and so there is no native way for users to see a diff.
It is important to note that only showing the names of the files in the default
nx format:checkoutput is an important feature - it allows easy piping into custom scripts to perform further handling. Therefore we do not want to change the default output here.This PR updates the case where
--verboseis passed in order to provide more information/context about the overall problem and how to fix it.Before
After