Generate the help block from the README
#958
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
Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
Morriar
force-pushed
the
at-readme
branch
2 times, most recently
from
060270a
to
9c995dc
Compare
Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
vinistock
approved these changes
Jun 1, 2022
st0012
approved these changes
Jun 1, 2022
egiurleo
approved these changes
Jun 1, 2022
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.
Motivation
I noticed that the verbatim code blocks showing the content of the help command was out-of-date.
While we generate the help for the different commands we didn't generate the root help of Tapioca.
This PR addresses this problem and update the README accordingly.
Implementation
In the
readme.rake:print_commands_helpprint_helpshintoshellfor uniformityI also fixed the terminal width used by the
FakeShellto ensure local and CI runs would produce the same output. Before this PR, CI was truncating the help lines at 80 chars which may be different from local config.