Add template debugging functions for variables #1042
Closed
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
Template developers frequently need to show variable values while debugging templates. Issue #1009 requests better support for this. There are already ways to display information about template variables. This patch makes it easier for users that don't have experience working with Go templates. The `printf "%#v"` idiom is powerful but requires some knowledge of Hugo's internal representation of Go value types. Not all template designers will have that knowledge. The two functions `inspect` and `typeOf` provide a path towards easier to use and understand printing of variables and values. The `inspect` function replaces the `printf` call. This version relies on the default `string` conversion for the result. This provides a path towards pretty-printing variables and values. Templates may use `typeOf` to determine the best formatting for variables and values. This replaces `printf %T`. References #1009
|
This is a big maybe in my book. Both of these could be replaced with printf. I don't think we should duplicate existing functionality. If some of that is hard to use, we should document it. I think people would be really happy to know that the powers of printf is available. |
|
I think the correct way to do this is:
This way the users can chose where to put this info. |
|
I'm closing this now. The thought behind this one is excellent -- but I'm not seeing anything here that isn't possible with |
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Template developers frequently need to show variable values while
debugging templates. Issue #1009 requests better support for this.
There are already ways to display information about template
variables. This patch makes it easier for users that don't have
experience working with Go templates.
The
printf "%#v"idiom is powerful but requires some knowledgeof Hugo's internal representation of Go value types. Not all
template designers will have that knowledge. The two functions
inspectandtypeOfprovide a path towards easier to use andunderstand printing of variables and values.
The
inspectfunction replaces theprintfcall. This versionrelies on the default
stringconversion for the result. Thisprovides a path towards pretty-printing variables and values.
Templates may use
typeOfto determine the best formattingfor variables and values. This replaces
printf %T.References #1009