policy status CLI: Render guidance as markdown #982
Merged
Conversation
This file contains 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
JAORMX
requested review from
evankanderson,
jhrozek and
lukehinds
and removed request for
evankanderson and
jhrozek
evankanderson
requested changes
Sep 19, 2023
| @@ -160,5 +161,10 @@ func guidanceOrEncouragement(status, guidance string) string { | |||
| return "No guidance available for this rule 😞" | |||
| } | |||
|
|
|||
| return guidance | |||
| renderedGuidance, err := glamour.Render(guidance, "dark") | |||
There was a problem hiding this comment.
Do we want to use RenderWithEnvironmentConfig, which will allow users to set GLAMOUR_STYLE environment variable to choose their styling?
There was a problem hiding this comment.
I'm thinking we should use a consize color scheme instead, I added a TODO with a reference to #1006
evankanderson
previously approved these changes
Sep 19, 2023
rdimitrov
previously approved these changes
Sep 22, 2023
JAORMX
changed the title
This providers a nicer view of the rule's policy status by rendering the rule as markdown. Note that this is only applicable to the CLI and would not affect our API at all. If the renderer fails, we'd just render the raw text.
rdimitrov
approved these changes
Sep 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This providers a nicer view of the rule's policy status by rendering
the rule as markdown. Note that this is only applicable to the CLI
and would not affect our API at all. If the renderer fails, we'd just
render the raw text.