Update config.assets.debug documentation to reflect actual defaults [ci-skip] #51747 #51845
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
|
Fixes #51747 |
Comment on lines
+665
to
+674
| In previous versions of Rails, `config.assets.debug` was set to `true` by default in the development environment, which disabled the concatenation and preprocessing of assets to facilitate easier debugging. This was particularly useful when working with a large number of complex assets, as it allowed developers to trace issues directly to specific files. | ||
|
|
||
| However, as of Rails 7.0 (commit adec7e7 on Aug 10, 2021), this setting is no longer included by default in the `development.rb` configuration. The change was made because the move towards using ECMAScript Modules (ESM) in development generally eliminates the need for concatenating or preprocessing large JavaScript files, rendering debug mode less relevant. | ||
|
|
||
| To explicitly enable or disable asset debugging in the current version of Rails, developers may add the following line to `config/environments/development.rb`: | ||
|
|
||
| ```ruby | ||
| # Enable or disable asset concatenation and preprocessing for easier debugging | ||
| config.assets.debug = true # Set to `false` to enable concatenation and compression | ||
| ``` |
There was a problem hiding this comment.
@devikasugathan Thanks for the PR,
Actually we don't really need to mention the history of a configuration file. This document only refers what the purpose of config.assets.debug when it set to true.
also you can add following pattern which we are already using that for other configuration
The default value depends on the `config.load_defaults` target version:
| Starting with version | The default value is |
| --------------------- | -------------------- |
| (original) | `true` |
| 7.0 | `false` |
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 / Background
This Pull Request has been created because the Rails documentation currently states that
config.assets.debugis enabled by default in the development environment. However, as of Rails 7.0 (commit adec7e7 on Aug 10, 2021), this setting is not included by default in thedevelopment.rbfile. This discrepancy can lead to confusion for developers relying on outdated documentation. Updating this will provide clearer guidance and reflect the actual current behavior of Rails applications in development. Fixes #51747.Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]