Indicate successful check #9503
Conversation
This implements outputting a message to `stdout` when a check is run and errors do not occur and fixes are not made. See astral-sh#8553 for more information.
| noqa.into(), | ||
| fix_mode, | ||
| )?, | ||
| 1, |
There was a problem hiding this comment.
Flagging here that I'm returning 1 here for the number of affected files if we're reading from stdin.
Please let me know if this is okay!
| ----- stdout ----- | ||
| Found 0 errors in 1 file | ||
|
|
||
| ----- stderr ----- | ||
| warning: Encountered error: Permission denied (os error 13) |
There was a problem hiding this comment.
Flagging here that we're displaying the Found 0 errors in 1 file, even when we run into a permission-denied error. Perhaps the output here is undesirable?
Open to feedback and suggestions on what we think the ideal product behavior should look like!
| if checked_files > 0 && diagnostics.fixed.is_empty() && diagnostics.messages.is_empty() { | ||
| let s = if checked_files == 1 { "" } else { "s" }; | ||
| writeln!(summary_writer, "Found 0 errors in {checked_files} file{s}")?; | ||
| } |
There was a problem hiding this comment.
Flagging the logic here on how I'm deciding whether or not to display the "success" output. Please let me know if we think the heuristic should be different!
|
This is my first time attempting to contribute to the Ruff codebase, so please let me know if my logic is misdirected, e.g. at the incorrect abstraction levels. I'm really trying to familiarize myself with the codebase so any direction or guidance is greatly appreciated! |
|
|
Ahh, I just realized that #8631 already exists, and is probably at the more correct level of abstraction to implement this in! |
|
#8631 does seem more appropriate, we'll try to get that one merged. Thank you for contributing though! I'm interested in adding those file counts 👀 |
Summary
This implements outputting a message to
stdoutwhen a check is run and errors do not occur and fixes are not made. This is done only for when watch mode is not enabled; running via watch mode will continue to not output anything when errors do not occur and fixes are not made.See #8553 for more information.
Test Plan
Snapshot tests.