feat(help) Finished rendering and styled multiple help pages #58
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.
Issue
Closes #32
Description
We released without the renderer being finished, and so there were multiple display issues with displaying help content, particularly in tables. Also things like, if
NO_COLOR
is set, we don't just skip color, we skip any terminal code.Now, the initial renderer has been finished, and lots of 'features' have been added, for instance, to allow us to have more flexibility in table layout.
There's a default chalk 'style' too, but it's set up to make it easy for us to enable others to configure their own style.
The renderer is 'good enough' now that we will have a very easy time moving to any sort of full-screen model instead of a scrolling model... which I do intend to do soon with the component system.
However, now that things seem pretty healthy, we do need to go back and adjust the docs to format properly. I've seen there are definitely some places where tweaks need to be made, for instance, if the doc is using markdown in a context where markdown doesn't get processed, etc.
Testing
Try
chalk help
orchalk help metadata
and see that they're no longer utterly horrid.