.annotate_template_file_names annotates HTML output with template names #38848
Conversation
This file contains hidden or 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
…e names As a developer, when looking at a page in my web browser, it's sometimes difficult to figure out which template(s) are being used to render the page. config.action_view.annotate_template_file_names adds HTML comments to the rendered output indicating where each template begins and ends. Co-authored-by: Aaron Patterson <tenderlove@github.com>
This was referenced Apr 8, 2020
|
great to see this being added after proposing it 6 years ago 👍 just wanted to leave a comment here, that i'm going to discontinue to support partially_useful the gem adding this functionality for rails > 6.0 for later reference. |
Merged
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
.annotate_template_file_names annotates HTML output with template file names
Problem
As a developer, when looking at a page in my web browser, it's sometimes
difficult to figure out which template(s) are being used to render the page.
Solution
config.action_view.annotate_template_file_namesadds HTML comments to therendered output indicating where each template begins and ends, leveraging the lovely
ActionView::Template#short_identifierintroduced by @jhawthorn in #35407:(Note: Chrome moves any HTML comments outside the
htmltag to insidebody, which is why<!-- END app/views/layouts/application.html.erb -->is shown as being insidebody, despite falling after the closinghtmltag in the document)Co-authored-by: Aaron Patterson tenderlove@github.com