Dynamically generate README #1187
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
Create README based off the `desc` of the generators. We chose to create a custom class instead of a traditional generator because this script is intended to be run in the [application template][] as a Rake task. It is not intended to be run as a standalone generator, since it only makes sense to be run on concert with `suspenders:install:web`. Updates all generator descriptions to use Herdoc syntax to ensure consistent line breaks. A follow-up commit will update the descriptions to work better in a README. [application template]: https://guides.rubyonrails.org/rails_application_templates.html
stevepolitodesign
force-pushed
the
suspenders-3-0-0-readme
branch
from
bb098e4
to
5780f69
Compare
stevepolitodesign
added a commit
that referenced
this pull request
Apr 13, 2024
Follow-up to #1187. Removes description tests. These were a helpful guide during development, but don't provide much value now.
stevepolitodesign
added a commit
that referenced
this pull request
Apr 22, 2024
Follow-up to #1187 Since we derive the app name from a module name, we need to [titleize][] it so it reads better in the `README`. Now `ExpectedAppName` will be rendered as `Expected App Name`. [titleize]: https://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-titleize
stevepolitodesign
added a commit
that referenced
this pull request
Apr 22, 2024
Follow-up to #1187 Since we derive the app name from a module name, we need to [titleize][] it so it reads better in the `README`. Now `ExpectedAppName` will be rendered as `Expected App Name`. [titleize]: https://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-titleize
stevepolitodesign
added a commit
that referenced
this pull request
Apr 26, 2024
Follow-up to #1187 Update descriptions so that they work well in the `README.md` generated by `suspenders:clean_up:generate_readme`. Also fixes a typo in `Suspenders::Cleanup::GenerateReadme`.
stevepolitodesign
added a commit
that referenced
this pull request
Apr 26, 2024
Follow-up to #1187 Update descriptions so that they work well in the `README.md` generated by `suspenders:clean_up:generate_readme`. Also fixes a typo in `Suspenders::Cleanup::GenerateReadme`.
stevepolitodesign
added a commit
that referenced
this pull request
May 10, 2024
Create README based off the `desc` of the generators. We chose to create a custom class instead of a traditional generator because this script is intended to be run in the [application template][] as a Rake task. It is not intended to be run as a standalone generator, since it only makes sense to be run on concert with `suspenders:install:web`. Updates all generator descriptions to use Herdoc syntax to ensure consistent line breaks. A follow-up commit will update the descriptions to work better in a README. [application template]: https://guides.rubyonrails.org/rails_application_templates.html
stevepolitodesign
added a commit
that referenced
this pull request
May 10, 2024
Follow-up to #1187 Since we derive the app name from a module name, we need to [titleize][] it so it reads better in the `README`. Now `ExpectedAppName` will be rendered as `Expected App Name`. [titleize]: https://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-titleize
stevepolitodesign
added a commit
that referenced
this pull request
May 10, 2024
Follow-up to #1187 Update descriptions so that they work well in the `README.md` generated by `suspenders:clean_up:generate_readme`. Also fixes a typo in `Suspenders::Cleanup::GenerateReadme`.
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.
Create README based off the
descof the generators.We chose to create a custom class instead of a traditional generator because this script is intended to be run in the application template as a Rake task. It is not intended to be run as a standalone generator, since it only makes sense to be run on concert with
suspenders:install:web.Updates all generator descriptions to use Herdoc syntax to ensure consistent line breaks.
A follow-up commit will update the descriptions to work better in a README.