Add `suspenders:development:environment` generator by crackofdusk · Pull Request #1149 · thoughtbot/suspenders

crackofdusk · 2023-12-11T15:28:41Z

Creates generator to configure the development environment. Keeps parity
with Rails as much as possible in an effort to avoid drift with Rails
standards.

It's possible a future release of Rails will alleviate us from having to
do the following:

enable active_model.i18n_customize_full_message which is being
addressed in #50406
enable active_record.query_log_tags_enabled which is being addressed
in #51342

stevepolitodesign · 2023-12-12T15:58:36Z

@crackofdusk

Should the email configuration be part of an suspenders:email_generator

I feel like it makes sense to create a suspenders:email_generator since that touches all environments.

Rails comes with a setup script. Do we feel strongly enough about our own setup script to override the default one?

I think this should be its own separate generator, since there's an opportunity to improve it. That would also be the place to handle dev:prime if we chose to.

Quiet assets is the default development configuration setting already. Do we care about configuring it for every environment? Can we assume that one is using a CDN in production anyway?

It looks like that was introduced in 2015 in 3a06edf and might be in reference to this gem. I think we should stick with the Rails defaults and not modify application.rb

What should the generator configuration look like? The customisations are only necessary when using rspec.

I don't think we need to configure the generators. If we still feel strongly about this, that could be a responsibility of the TestingGenerator (which does not yet exist).

suspenders:lint assumes the app uses yarn. Is that on purpose? Should we ship a bin/yarn script that makes sure yarn is installed?

Yes, this is on purpose. I don't think it's explicitly documented anywhere, but Rails seems to default to yarn. For example, if you install cssbundling-rails, it will install the dependencies with yarn. Additionally, Rails ships with a yarn Rake task

stevepolitodesign

I love how lean this is! I think we should take this opportunity to review all configuration options.

For example, I think there's value in enabling config.action_view.annotate_rendered_view_with_filenames.

Do we want to enable config.active_record.strict_loading_by_default?

stevepolitodesign · 2023-12-12T15:42:18Z

lib/generators/suspenders/development_environment_generator.rb

+      def raise_on_missing_translations_in_test
+        uncomment_lines("config/environments/test.rb", "config.i18n.raise_on_missing_translations = true")
+      end


I recognize this is an open question in the pull request, but want to note that we're modifying files in the test environment even though this generator is called DevelopmentEnvironmentGenerator.

We might want to add this and other tweaks to the test environment, so I will remove this from the development environment generator.

mike-burns · 2023-12-12T16:24:05Z

config.action_view.annotate_rendered_view_with_filenames

Into it.

config.active_record.strict_loading_by_default

Is this a development tool? This seems like something that will change semantics, and I wouldn't want it to be different in different environments.

stevepolitodesign · 2023-12-12T17:45:01Z

@mike-burns

Is this a development tool? This seems like something that will change semantics, and I wouldn't want it to be different in different environments.

Yes. We have it enabled on in development and test on a client project. It's a reasonable substitute for bullet. However, it's challenging to work with when queries are made outside the application, like in gems. We've run into this with devise for example. Since we don't have access to the current_user definition, we need to redefine it and call includes.

mike-burns · 2023-12-12T17:51:19Z

strict_loading_by_default

Oh I see how it works now. Wow that thing is under-documented.

Yup that makes sense to me.

mike-burns · 2023-12-12T17:55:00Z

In Suspenders 2, we had namespaced generators such as suspenders:production:timeout and suspenders:staging:pull_requests. Do we like that pattern? Should this be suspenders:development:environment?

seanpdoyle · 2023-12-12T19:03:40Z

lib/generators/suspenders/development_environment_generator.rb

From a test-driven development perspective, the change to set config.action_dispatch.show_exceptions = :rescuable by default (introduced in rails/rails#45867 had had a largely negative impact on the feedback from Controller and System level test failures.

I'm advocating that Suspenders set config.action_dispatch.show_exceptions = :none so that tests fails with callstack information instead of HTML error pages.

stevepolitodesign · 2023-12-19T16:23:23Z

Based on a recent client feature, I think there's value in enabling config.active_model.i18n_customize_full_message.

I've opened rails/rails#50406 to make this the default.

stevepolitodesign · 2024-03-18T14:54:37Z

Noting we might want to enable config.active_record.query_log_tags_enabled = true.

https://github.com/rails/rails/pull/51342/files

Creates generator to configuration the production environment. For now, this means [requiring a master key][master key]. Drops configuration for [asset_host][], since that should be an infrastructure decision. In an effort to distinguish between the development environment configuration in #1149, we use the `production` namespace. [master key]: https://guides.rubyonrails.org/configuring.html#config-require-master-key [asset_host]: https://guides.rubyonrails.org/configuring.html#config-asset-host

Configures test environment. This differs from #1156 in that this commit is concerned with configuration, where that commit was concerned with generating a holistic test suite. It's also possible to run each generator independently, and the two should not rely on one another. Disables [action_dispatch.show_exceptions][] in an effort to [improve failure output][comment]. Enables [raise_on_missing_translations][] to keep parity with the same setting in development #1149 [action_dispatch.show_exceptions]: https://edgeguides.rubyonrails.org/configuring.html#config-action-dispatch-show-exceptions [comment]: #1149 (comment) [raise_on_missing_translations]: https://guides.rubyonrails.org/configuring.html#config-i18n-raise-on-missing-translations

Creates generator to configuration the production environment. For now, this means [requiring a master key][master key]. Drops configuration for [asset_host][], since that should be an infrastructure decision. In an effort to distinguish between the development environment configuration in #1149, we use the `production` namespace. [master key]: https://guides.rubyonrails.org/configuring.html#config-require-master-key [asset_host]: https://guides.rubyonrails.org/configuring.html#config-asset-host

Configures test environment. This differs from #1156 in that this commit is concerned with configuration, where that commit was concerned with generating a holistic test suite. It's also possible to run each generator independently, and the two should not rely on one another. Disables [action_dispatch.show_exceptions][] in an effort to [improve failure output][comment]. Enables [raise_on_missing_translations][] to keep parity with the same setting in development #1149 [action_dispatch.show_exceptions]: https://edgeguides.rubyonrails.org/configuring.html#config-action-dispatch-show-exceptions [comment]: #1149 (comment) [raise_on_missing_translations]: https://guides.rubyonrails.org/configuring.html#config-i18n-raise-on-missing-translations

Creates generator to configuration the production environment. For now, this means [requiring a master key][master key]. Drops configuration for [asset_host][], since that should be an infrastructure decision. In an effort to distinguish between the development environment configuration in #1149, we use the `production` namespace. [master key]: https://guides.rubyonrails.org/configuring.html#config-require-master-key [asset_host]: https://guides.rubyonrails.org/configuring.html#config-asset-host Co-authored-by: Steve Polito <[email protected]>

Configures test environment. This differs from #1156 in that this commit is concerned with configuration, where that commit was concerned with generating a holistic test suite. It's also possible to run each generator independently, and the two should not rely on one another. Disables [action_dispatch.show_exceptions][] in an effort to [improve failure output][comment]. Enables [raise_on_missing_translations][] to keep parity with the same setting in development #1149 [action_dispatch.show_exceptions]: https://edgeguides.rubyonrails.org/configuring.html#config-action-dispatch-show-exceptions [comment]: #1149 (comment) [raise_on_missing_translations]: https://guides.rubyonrails.org/configuring.html#config-i18n-raise-on-missing-translations

Creates generator to configure the development environment. Keeps parity with Rails as much as possible in an effort to avoid drift with Rails standards. It's possible a future release of Rails will alleviate us from having to do the following: - enable `active_model.i18n_customize_full_message` which is being addressed in [#50406][] - enable `active_record.query_log_tags_enabled` which is being addressed in [#51342][] [#50406]: rails/rails#50406 [#51342]: rails/rails#51342

Follow-up to #1151, #1182, and #1149 Using the `Environments` namespace feels more appropriate, since this keeps parity with Rails' directory structure.

Creates generator to configuration the production environment. For now, this means [requiring a master key][master key]. Drops configuration for [asset_host][], since that should be an infrastructure decision. In an effort to distinguish between the development environment configuration in #1149, we use the `production` namespace. [master key]: https://guides.rubyonrails.org/configuring.html#config-require-master-key [asset_host]: https://guides.rubyonrails.org/configuring.html#config-asset-host Co-authored-by: Steve Polito <[email protected]>

Configures test environment. This differs from #1156 in that this commit is concerned with configuration, where that commit was concerned with generating a holistic test suite. It's also possible to run each generator independently, and the two should not rely on one another. Disables [action_dispatch.show_exceptions][] in an effort to [improve failure output][comment]. Enables [raise_on_missing_translations][] to keep parity with the same setting in development #1149 [action_dispatch.show_exceptions]: https://edgeguides.rubyonrails.org/configuring.html#config-action-dispatch-show-exceptions [comment]: #1149 (comment) [raise_on_missing_translations]: https://guides.rubyonrails.org/configuring.html#config-i18n-raise-on-missing-translations

Creates generator to configure the development environment. Keeps parity with Rails as much as possible in an effort to avoid drift with Rails standards. It's possible a future release of Rails will alleviate us from having to do the following: - enable `active_model.i18n_customize_full_message` which is being addressed in [#50406][] - enable `active_record.query_log_tags_enabled` which is being addressed in [#51342][] [#50406]: rails/rails#50406 [#51342]: rails/rails#51342 Co-authored-by: Steve Polito <[email protected]>

Follow-up to #1151, #1182, and #1149 Using the `Environments` namespace feels more appropriate, since this keeps parity with Rails' directory structure.

crackofdusk mentioned this pull request Dec 11, 2023

Suspenders 3.0.0 #1135

Merged

17 tasks

crackofdusk force-pushed the suspenders-3-0-0-set-up-development-env branch from eab6dbe to 54d9428 Compare December 12, 2023 10:37

stevepolitodesign reviewed Dec 12, 2023

View reviewed changes

seanpdoyle reviewed Dec 12, 2023

View reviewed changes

crackofdusk changed the title ~~Add suspenders:development_environment generator~~ Add suspenders:development:environment generator Dec 22, 2023

crackofdusk force-pushed the suspenders-3-0-0-set-up-development-env branch 3 times, most recently from 32e96e7 to e17e574 Compare December 22, 2023 13:03

stevepolitodesign mentioned this pull request Jan 6, 2024

Annotate HTML output with template file names by default #1120

Closed

This comment was marked as resolved.

Sign in to view

stevepolitodesign mentioned this pull request Apr 5, 2024

Introduce suspenders:production:environment generator #1151

Merged

stevepolitodesign force-pushed the suspenders-3-0-0-set-up-development-env branch from e17e574 to 1711f5b Compare April 5, 2024 11:23

stevepolitodesign marked this pull request as ready for review April 5, 2024 11:23

stevepolitodesign requested a review from thiagoa as a code owner April 5, 2024 11:23

stevepolitodesign self-assigned this Apr 5, 2024

stevepolitodesign mentioned this pull request Apr 5, 2024

Introduce suspenders:test:environment generator #1182

Merged

stevepolitodesign force-pushed the suspenders-3-0-0-set-up-development-env branch 2 times, most recently from 96180f8 to 12ed7db Compare April 5, 2024 14:20

mike-burns approved these changes Apr 5, 2024

View reviewed changes

stevepolitodesign force-pushed the suspenders-3-0-0-set-up-development-env branch from 12ed7db to 4b8894d Compare April 5, 2024 17:30

stevepolitodesign force-pushed the suspenders-3-0-0-set-up-development-env branch from 4b8894d to 50f2a8d Compare April 5, 2024 17:39

stevepolitodesign force-pushed the suspenders-3-0-0-set-up-development-env branch from 50f2a8d to cca73b5 Compare April 5, 2024 17:39

stevepolitodesign merged commit 7d666ca into suspenders-3-0-0 Apr 5, 2024

stevepolitodesign deleted the suspenders-3-0-0-set-up-development-env branch April 5, 2024 17:44

stevepolitodesign added a commit that referenced this pull request Apr 5, 2024

Clean Up: Use Environments namespace

6b1a6a5

Follow-up to #1151, #1182, and #1149 Using the `Environments` namespace feels more appropriate, since this keeps parity with Rails' directory structure.

stevepolitodesign mentioned this pull request Apr 5, 2024

Clean Up: Use Environments namespace #1184

Merged

stevepolitodesign added a commit that referenced this pull request Apr 5, 2024

Clean Up: Use Environments namespace (#1184)

56b316c

Follow-up to #1151, #1182, and #1149 Using the `Environments` namespace feels more appropriate, since this keeps parity with Rails' directory structure.

stevepolitodesign added a commit that referenced this pull request May 10, 2024

Clean Up: Use Environments namespace (#1184)

f2ff953

Follow-up to #1151, #1182, and #1149 Using the `Environments` namespace feels more appropriate, since this keeps parity with Rails' directory structure.

stevepolitodesign mentioned this pull request May 17, 2024

[Feature] Rails 6 config.hosts #975

Closed

Uh oh!

Conversation

crackofdusk commented Dec 11, 2023 • edited by stevepolitodesign Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stevepolitodesign commented Dec 12, 2023

Uh oh!

stevepolitodesign left a comment

Choose a reason for hiding this comment

Uh oh!

stevepolitodesign Dec 12, 2023

Choose a reason for hiding this comment

Uh oh!

crackofdusk Dec 22, 2023

Choose a reason for hiding this comment

Uh oh!

mike-burns commented Dec 12, 2023

Uh oh!

stevepolitodesign commented Dec 12, 2023

Uh oh!

mike-burns commented Dec 12, 2023

Uh oh!

mike-burns commented Dec 12, 2023

Uh oh!

seanpdoyle Dec 12, 2023

Choose a reason for hiding this comment

Uh oh!

stevepolitodesign commented Dec 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

stevepolitodesign commented Mar 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

crackofdusk commented Dec 11, 2023 •

edited by stevepolitodesign

Loading

stevepolitodesign commented Dec 19, 2023 •

edited

Loading