main: extract a Status object to represent the final status of nixpkgs-check-by-name
#91
Conversation
|
Damn man your killin it today! |
src/status.rs
Outdated
| let maybe_green = |s: &str| if use_color { s.green() } else { s.normal() }; | ||
| let maybe_yellow = |s: &str| if use_color { s.yellow() } else { s.normal() }; | ||
| let maybe_red = |s: &str| if use_color { s.red() } else { s.normal() }; |
There was a problem hiding this comment.
This will cause it to colorise the output even if it's e.g. just a pipe to a file. So I think I prefer the previous code using NO_COLOR=1 to disable colors when testing, and https://github.com/NixOS/nixpkgs/blob/07c1a652be3a1dda9047f4d8545e17d12958a148/.github/workflows/check-by-name.yml#L113-L115 to force turn it on in CI.
There was a problem hiding this comment.
No, it's the same as before.
nixpkgs-check-by-name used to unilaterally colorize by calling the .red, .yellow, etc methods, and in the colored crate it would decide to actually not color based on this environment variable.
Now, it'll only call those methods if true is passed to use_color. ColoredStatus does this -- see the end of the file. main uses ColoredStatus, and so it retains the original behavior. Tests, which use the process method, format a Status, which passes false to use_color in their display, bypassing colorization in this module itself.
I like that better because it's less action at a distance.
This object contains the actual status of `nixpkgs-check-by-name` checks.
philiptaron
changed the title
nixpkgs-check-by-name
Motivation for changes
I didn't like the mixing of error reporting (through
io::Writer) and business logic inside theprocessfunction. By extracting a Status object, the two are separated, just likeNixpkgsProblemdid on a lower level.Description of changes
Statusobject which contains the actual status ofnixpkgs-check-by-namechecks.Status::fmtmethod.Fromimpl.ColoredStatuswhich is the colored version of status; it's used exclusively inmain.NO_COLORenvironment variable and test-onlyio::Writer.It's mildly longer (~53 more lines) due to the needed boilerplate of being a module.