Pretty output #978
plocket
started this conversation in
Improving clarity
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
The output is pretty hard to read and pretty dense right now.
We might be able to make the console print have prettier formatting. For example, pretty headings. Maybe we could separate Scenarios in pretty ways too. For example, Scenarios could be in what HTML coders might call "cards". We could use actual characters (similar to what we're doing now) for headers and other separators. Other types of formatting are trickier as they might interfere with functionality. See the "reports" section below
I tried to find a library that would handle manipulating plain text that way and found nothing particularly useful other than some tables.
Reports
Plain text in reports are trickier. Authors are supposed to be able to copy "Rows used" tables wholesale and paste those into their code. If we outline each Scenario with some kind of character, that would include the tables and then those tables will be harder to copy/paste. Still not sure what to do about that.
The console
The console has some functionality like
.table()
that prints nicely there. I'm not sure if copying that "table" text would copy extraneous characters where the outlines are. We should check. If not, that's an option for the console, but, again, not for plain text formatting. Otherwise, we could use background colors around the edges of "cards" (and for other decoration) because I believe copy/pasting those won't get extra characters. The colors could indicate (to non-color blind folks) failures vs. warnings (when we finally add that type of result) vs. other vs. successes.I propose background colors because that I believe shouldn't interfere with copying text. One downside is that color blind folks wouldn't be able to tell the differences between the colors. We could try to make the darkness/lightness of the different colors different enough to distinguish from each other. Or maybe we could make a dashed line for failed and warnings and a solid line for other types of outcomes. Or give some other visual difference (e.g. double-think border for failures?).
HTML
We can create the HTML for the ALKilnInThePlayground display by converting the console output styles or using the reports objects themselves. I think that's in the queue already.
Beta Was this translation helpful? Give feedback.
All reactions