Improved UX #26

dragonmux commented 2025年04月15日 23:34:03 +02:00

Currently the user experience with the mashup of logging framework and other output styles is a little rough and could do with some work. Likewise the switch flow could do with some help added for understanding what firmware does what and such where there are multiple variants for a probe.

Very notable, the erase phase for the Flash process needs some indication there's something going on as otherwise it's a jarring long wait that the user must sit through.

Currently the user experience with the mashup of logging framework and other output styles is a little rough and could do with some work. Likewise the `switch` flow could do with some help added for understanding what firmware does what and such where there are multiple variants for a probe. Very notable, the erase phase for the Flash process needs some indication there's something going on as otherwise it's a jarring long wait that the user must sit through.

P-Storm commented 2025年06月04日 22:52:08 +02:00 (Migrated from github.com)

Looking into the logging that is being used I see:

• println!
• log / env_logger
• termcolor
• ratatui
  • tui-markdown
• dialoguer
  • indicatif
• clap
  • anstyle

Things that I see that could be merged:
For sure

• println! -> log / env_logger
• indicatif -> ratatui (widget LineGauge)

I think probably use the ratatui crate for more items, but deeper research has to be done.

Looking into the logging that is being used I see: - println! - log / env_logger - termcolor - ratatui - tui-markdown - dialoguer - indicatif - clap - anstyle Things that I see that could be merged: For sure - println! -> log / env_logger - indicatif -> [ratatui (widget LineGauge)](https://docs.rs/ratatui/latest/ratatui/widgets/struct.LineGauge.html) I think probably use the ratatui crate for more items, but deeper research has to be done.

P-Storm commented 2025年06月04日 23:16:54 +02:00 (Migrated from github.com)

Other thing that can also be a consideration, why not drop the ratatui? Feels a bit as overkill for what the application does.

Other thing that can also be a consideration, why not drop the ratatui? Feels a bit as overkill for what the application does.

dragonmux commented 2025年06月04日 23:25:15 +02:00

So, termcolor is going away with feature/cli-restructure as it was identified that the only reason it was in use can be replaced for much cleaner code by using color-eyre's text coloration support, so that one is getting stripped out.

With regards to ratatui: We needed a way to interactively display release documentation such as in:

A console interactively displaying the formatted Markdown release information on the native probe's RISC-V firmware variant

With things that are planned for the tool in the future, most likely the use of ratatui will be expanded on to build out other interactive elements.

So, `termcolor` is going away with feature/cli-restructure as it was identified that the only reason it was in use can be replaced for much cleaner code by using color-eyre's text coloration support, so that one is getting stripped out. With regards to ratatui: We needed a way to interactively display release documentation such as in:  With things that are planned for the tool in the future, most likely the use of ratatui will be expanded on to build out other interactive elements.