Give the doctor and dashboard a visual language - #2131
Merged
Conversation
Both buffers were plain text with the structure carried entirely by ASCII rules and column padding, which made them hard to skim - the doctor's findings in particular, where severity is exactly the thing color exists for. Section headers, labels, the project's identity and the findings are now faced by meaning, and the findings are sorted so a warning can't hide among a dozen ok lines. Every face only inherits from a standard one, so themes get it right for free and a terminal without colors renders what it always did. The characters stay plain ASCII, so a yanked report reads like the rendered one - and projectile-report-copy makes that explicit by putting the buffer on the kill ring without faces or buttons, which is what pasting a report into an issue actually wants.
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
1 participant
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.
Both buffers were plain text, with all the structure carried by ASCII rules and
column padding. The doctor's findings were the worst of it - severity is exactly
what color is for, and
ok,warnandinfoall rendered identically grey.Section headers, field labels, the project's identity (root, type) and the
findings are now faced by meaning. Findings are also sorted warn-first, since a
report is read top-down and a lone warning shouldn't sit buried among a dozen
oklines.Three constraints shaped it:
:inherits from a standard one (success,warning,shadow,font-lock-*), so themes style them without knowing Projectileexists, and a terminal without colors degrades to exactly what you saw before.
----rules are still text rather thanan underline face, so a yanked report reads like the rendered one.
them in the section face and the bright underlines competed with the headers.
And since a doctor report's usual destination is an issue,
projectile-report-copy(
win either buffer) makes that explicit: the buffer goes onto the kill ringwith faces and buttons stripped, so nothing drags Emacs text properties along.
Both buffers grew a dimmed footer listing their keys, which is also how
wbecomes discoverable.