(hack) Convert guides to YAML and pretty print #2937
Merged
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.
When we first implemented the
guide
subcommand, we chose to make thefile format of guides flat text and documented how users could add their
own guides to Bolt to be loaded by the
bolt guide
subcommand. Whileuseful, we haven't seen anyone use this functionality, and further it
does not seem like the file format has much impact on whether users add
their own guides or not. This converts the file format from flat text to
YAML, which supports both being read as data and formatting multiline
strings. This lets us format the
bolt guide <guide>
output to be morereadable and inline with other bolt output, make the guide text easily
editable (as opposed to JSON), and still lets users add their own guides
if they choose.
!feature
bolt guide
output (hack)This converts our existing guides from flat text to YAML so that they
can be pretty printed.