Feat!: improve signal CLI UX #4812
Conversation
georgesittas
force-pushed
the
jo/signal_ux_improvements
branch
2 times, most recently
from
df7ddfb to
caacc77
Compare
|
Latest state of the PR looks like this in the CLI: Non-verbose mode:
Very-verbose mode:
|
sqlmesh/core/console.py
Outdated
| tree.add(f"check: {check}") | ||
|
|
||
| ready = ", ".join(formatted_ready_intervals) | ||
| tree.add(f"[{color}]ready: {ready}[/{color}]") |
There was a problem hiding this comment.
Currently, the legend is always ready and its actual status is conveyed through colour. Personally, along with the corresponding colours I’d prefer more explicit messaging for the three cases as well for example:
- All intervals ready
- Some intervals unready
- No intervals ready
and then list which intervals are ready below. It’s a minor preference, but relying solely on colour feels a bit implicit, especially from an accessibility perspective and distinguishing green and yellow in some terminals
There was a problem hiding this comment.
I'd be curious to hear @sungchun12's take on this. I hear you, esp. the bit regarding accessibility. I think trying to improve the messaging may be the better thing here.
There was a problem hiding this comment.
Updated:
Non-verbose mode:
Very-verbose mode:
There was a problem hiding this comment.
Aligned with the new images
georgesittas
force-pushed
the
jo/signal_ux_improvements
branch
from
9bd9e05 to
0634bbc
Compare
georgesittas
force-pushed
the
jo/signal_ux_improvements
branch
2 times, most recently
from
2bec393 to
2a08f0f
Compare
| duration: float, | ||
| ) -> None: | ||
| """Updates the signal checking progress.""" | ||
| tree = Tree(f"[{signal_idx + 1}/{total_signals}] {signal_name} {duration:.2f}s") |
There was a problem hiding this comment.
I'm leaving the right-justification of the duration for a followup PR (if we think it's worth it), as it will require some width calculations similar to what we do in the evaluation stage.
georgesittas
force-pushed
the
jo/signal_ux_improvements
branch
from
7ebfaea to
54ced6e
Compare
georgesittas
force-pushed
the
jo/signal_ux_improvements
branch
from
98754b2 to
d0285d3
Compare
Current state of the CLI UX for signals on this branch: