Append final newline in read_line_initial_text#113
Merged
Conversation
dtolnay
pushed a commit
to dtolnay-contrib/console
that referenced
this pull request
Feb 4, 2022
Depends on console-rs#112 This branch builds on console-rs#112 by calculating the *percentage* of a task's wakeups that were self-wakes, and displaying them in the tasks view. It also adds the beginnings of a rudimentary "Warnings" system, and displays warnings for any tasks who have woken themselves for more than 50% of their wakeups. There is a new `Warn` trait for generating warnings that can be used to add new warnings in the future. The warnings functionality can almost certainly be expanded --- for example, it would be nice to be able to quickly jump to the details view for a task that has warnings. In the future, I could imagine generating web documentation with details about a particular warning and how to fix it, like [clippy has][1], and linking to them from the console. But, this is a start, at least! [1]: https://rust-lang.github.io/rust-clippy/v0.0.174/   Signed-off-by: Eliza Weisman <eliza@buoyant.io>
dtolnay
pushed a commit
to dtolnay-contrib/console
that referenced
this pull request
Feb 4, 2022
…s#123) The current method of displaying warnings is as list of all individual tasks with warnings on the task list screen. As discussed in the comments on PR console-rs#113, this may not be the ideal approach when there are a very large number of tasks with warnings. This branch changes this behavior so that the details of a particular warning for a given task is shown only on the task details screen. On the task list screen, we instead list the different _categories_ of warnings that were detected, along with the number of tasks with that warning. This means that when a large number of tasks have warnings, we will only use a number of lines equal to the number of different categories of warning that were detected, rather than the number of individual tasks that have that warning. Each individual task that has warnings shows a warning icon and count in a new column in the task list table. This makes it easy for the user to find the tasks that have warnings and get details on them, including sorting by the number of warnings. Implementing this required some refactoring of how warnings are implemented. This includes: * Changing the `Warn` trait to have separate methods for detecting a warning, formatting the warning for an individual task instance, and summarizing the warning for the list of detected warning types * Introducing a new `Linter` struct that wraps a `dyn Warning` in an `Rc` and clones it into tasks that have lints. This allows the task details screen to determine how to format the lint when it is needed. It also allows tracking the total number of tasks that have a given warning, by using the `Rc`'s reference count. ## Screenshots To demonstrate how this design saves screen real estate when there are many tasks with warnings, I modified the `burn` example to spawn several burn tasks rather than just one. Before, we spent several lines on warnings (one for each task):  After, we only need one line:  The detailed warning text for the individual tasks are displayed on the task details view:  And, it still looks okay in ASCII-only mode:   Signed-off-by: Eliza Weisman <eliza@buoyant.io>
pksunkara
approved these changes
Feb 11, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed fix for issue 112
Note that this changes the behaviour of
Term::read_line_initial_text()to make it consistent withTerm:read_line(). No change to the return value, but a change in side effects.