Skip to content

Commit

Permalink
Generators: Update descriptions
Browse files Browse the repository at this point in the history
Follow-up to #1187
  • Loading branch information
stevepolitodesign committed Apr 21, 2024
1 parent f3a9f50 commit 407bee1
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
6 changes: 5 additions & 1 deletion lib/generators/suspenders/accessibility_generator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ class AccessibilityGenerator < Rails::Generators::Base
include Suspenders::Generators::APIAppUnsupported

desc <<~MARKDOWN
Installs capybara_accessibility_audit and capybara_accessible_selectors"
Uses [capybara_accessibility_audit][] and [capybara_accessible_selectors][] to
encourage and enforce accessibility best practices.
[capybara_accessibility_audit]: https://github.com/thoughtbot/capybara_accessibility_audit
[capybara_accessible_selectors]: https://github.com/citizensadvice/capybara_accessible_selectors
MARKDOWN

def add_capybara_gems
Expand Down
6 changes: 3 additions & 3 deletions lib/generators/suspenders/advisories_generator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ module Generators
class AdvisoriesGenerator < Rails::Generators::Base
source_root File.expand_path("../../templates/advisories", __FILE__)
desc <<~MARKDOWN
Show security advisories during development.
Uses the `bundler-audit` gem to update the local security database and
Uses the [bundler-audit][] to update the local security database and
show any relevant issues with the app's dependencies via a Rake task.
[bundler-audit]: https://github.com/rubysec/bundler-audit
MARKDOWN

def add_bundler_audit
Expand Down
5 changes: 4 additions & 1 deletion lib/generators/suspenders/ci_generator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ class CiGenerator < Rails::Generators::Base

source_root File.expand_path("../../templates/ci", __FILE__)
desc <<~MARKDOWN
Creates CI files for GitHub Actions
Uses [GitHub Actions][] for CI, and [Dependabot][] for dependency updates.
[GitHub Actions]: https://docs.github.com/en/actions
[Dependabot]: https://docs.github.com/en/code-security/dependabot/working-with-dependabot
MARKDOWN

def ci_files
Expand Down
8 changes: 6 additions & 2 deletions lib/generators/suspenders/email_generator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@ module Generators
class EmailGenerator < Rails::Generators::Base
source_root File.expand_path("../../templates/email", __FILE__)
desc <<~MARKDOWN
Intercepts emails in non-production environments by setting `INTERCEPTOR_ADDRESSES`.
[Intercept][] emails in non-production environments by setting `INTERCEPTOR_ADDRESSES`.
```sh
INTERCEPTOR_ADDRESSES="[email protected],[email protected]" bin/rails s
```
Configures `default_url_options` in `test` and `development`.
Configuration can be found at `config/initializers/email_interceptor.rb`.
Interceptor can be found at `app/mailers/email_interceptor.rb`.
[Intercept]: https://guides.rubyonrails.org/action_mailer_basics.html#intercepting-emails
MARKDOWN

def create_email_interceptor
Expand Down

0 comments on commit 407bee1

Please sign in to comment.