Documenting debug:twig command #10232
Merged
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
symfony-splitter
pushed a commit
to symfony/twig-bridge
that referenced
this pull request
Sep 5, 2018
…wig command to find their paths (yceruto) This PR was squashed before being merged into the 4.2-dev branch (closes #27981). Discussion ---------- [TwigBridge] Added template "name" argument to debug:twig command to find their paths | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #27911 | License | MIT | Doc PR | symfony/symfony-docs#10232 Find the template file (to load by Twig) from a given template name (useful to know which file will be loaded exactly and which ones don't):  This will also show the overridden files if they exist and the paths corresponding to their namespace. In addition, the command suggests alternatives if you made a typo (this way you can check your template name quickly): | namespace typo | template name typo | | --- | --- | |  |  | <details> <summary><strong>Other outputs</strong></summary> Discovering more alternatives:  Unknown template name:  </details> ## Update The feature was introduced into `debug:twig` command and the `filter` argument was converted to `--filter` option. The `name` argument is now the first one of the command. Commits ------- 7ef3d39a4c [TwigBridge] Added template \"name\" argument to debug:twig command to find their paths
fabpot
added a commit
to symfony/symfony
that referenced
this pull request
Sep 5, 2018
…wig command to find their paths (yceruto) This PR was squashed before being merged into the 4.2-dev branch (closes #27981). Discussion ---------- [TwigBridge] Added template "name" argument to debug:twig command to find their paths | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #27911 | License | MIT | Doc PR | symfony/symfony-docs#10232 Find the template file (to load by Twig) from a given template name (useful to know which file will be loaded exactly and which ones don't):  This will also show the overridden files if they exist and the paths corresponding to their namespace. In addition, the command suggests alternatives if you made a typo (this way you can check your template name quickly): | namespace typo | template name typo | | --- | --- | |  |  | <details> <summary><strong>Other outputs</strong></summary> Discovering more alternatives:  Unknown template name:  </details> ## Update The feature was introduced into `debug:twig` command and the `filter` argument was converted to `--filter` option. The `name` argument is now the first one of the command. Commits ------- 7ef3d39 [TwigBridge] Added template \"name\" argument to debug:twig command to find their paths
|
Related PR was merged 🎉 now we can take care of this one :) Cheers! |
| @@ -71,6 +71,13 @@ in the ``vendor/acme/foo-bar/templates/`` directory, you can refer to it as: | |||
|
|
|||
| {{ include('@foo_bar/sidebar.twig') }} | |||
|
|
|||
| Execute this command to verify if your template name is correct and know which | |||
| template file will be loaded: | |||
There was a problem hiding this comment.
Just asking: what happens if the app doesn't use physical files to store templates? (they are stored in the database for example)
There was a problem hiding this comment.
Sadly, at this moment, the command only work for physical files.
There was a problem hiding this comment.
Btw, I'm not sure if the TwigBridge & TwigBundle support such feature.
templating/debug.rst
Outdated
| # filter output by any keyword | ||
| $ php bin/console debug:twig --filter=date | ||
|
|
||
| Also, you can verify any template name to know which template file will be loaded: |
There was a problem hiding this comment.
Maybe we can merge this last comment into the main code block?
.. code-block:: terminal
...
# pass a template path to show the physical file which will be loaded
$ php bin/console debug:twig @Twig/Exception/error.html.twigb36f615 to
621a846
Compare
621a846 to
1026020
Compare
javiereguiluz
added a commit
that referenced
this pull request
Sep 6, 2018
This PR was merged into the master branch. Discussion ---------- Documenting debug:twig command See symfony/symfony#27981 Commits ------- 1026020 Documenting debug:twig command
|
This was finally merged. Yonel, thanks as always for creating these great little utilities to improve developer experience! |
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.
See symfony/symfony#27981