Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve CLI output of lfc #896

Open
7 tasks
lhstrh opened this issue Jan 27, 2022 · 1 comment
Open
7 tasks

Improve CLI output of lfc #896

lhstrh opened this issue Jan 27, 2022 · 1 comment
Assignees
Labels
good first issue Good for newcomers

Comments

@lhstrh
Copy link
Member

lhstrh commented Jan 27, 2022

Currently, the output from lfc can be rather verbose. Messages from the underlying build system can be suppressed using the --quiet flag, but that might suppress too much output and impair the user's ability to judge whether actual progress is being made (or the build process stagnated for whatever reason). It would be great if we could create our own progress indicator to address this concern. Once implemented, and the "quiet" output is sufficiently informational for average use, we can let that be the default behavior and instead have a --verbose flag to display all messages.

Major progress has been made with the introduction of MessageReporter which is not only for reporting errors. There are a few more locations left where System.out is being used:

  • FileUtil::deleteDirectory
  • LFCommand::run
  • StateInfo
  • StateSpaceDiagram
  • StateSpaceExplorer
  • UclidGenerator
  • UclidRunner
@lhstrh lhstrh added this to the 0.2.0 milestone Jan 27, 2022
@lhstrh lhstrh added the good first issue Good for newcomers label May 27, 2022
@lhstrh lhstrh modified the milestones: 0.4.0, 0.5.0 Oct 11, 2022
@lhstrh
Copy link
Member Author

lhstrh commented May 5, 2023

To add to this, informational messages are written directly to standard out and are often poorly formatted. We should introduce a class similar to ErrorReporter to format and display informational messages. This is particularly useful for the code generation process of federations, where multiple code generators are at work and concurrently write such messages.

@lhstrh lhstrh modified the milestones: 0.5.0, 0.6.0 May 5, 2023
@lhstrh lhstrh modified the milestones: 0.6.0, 0.7.0 Nov 13, 2023
@lhstrh lhstrh modified the milestones: 0.7.0, 0.8.0 Mar 3, 2024
@cmnrd cmnrd modified the milestones: 0.8.0, 0.9.0 Jun 17, 2024
@lhstrh lhstrh removed this from the 0.9.0 milestone Sep 22, 2024
@lhstrh lhstrh removed their assignment Sep 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants