support an optional custom escape #25
Open
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
**Warning:** This changes the public API, requiring a `nil` to be passed to template parsing functions in cases where the default parser is intended to be used. This adds an optional `TemplateOptions` parameter to template parsing functions, which allows specification of a newly-added `Escaper` interface, which defines a string escaping function. By default this will be an HTMLEscaper, which has idential behavior to previous versions of this library: it escapes HTML. However, for usages where you're _not_ rendering HTML (say JSON, YAML, plain text, etc.) you may specify your own escaping function to be used by default.
|
sorry about that, missed updating some tests; fixed now |
|
I would like to see this feature in Raymond. I'm using it for non html templates and starts to be a problem having to use always the triple mustache for interpolation. |
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.
This adds an option to override the default escaping, allowing you to use handlebars to render things which are not HTML. It both alters the public API—is a breaking change—and adds a feature that might not be the common use case for this library, but I wanted to PR these changes against the canonical repo before creating a fork, just in case you thought they would be useful!
This does the following:
Escaperinterface, which defines anEscapemethod that can be used to escape unsafe textEscapeintoHTMLEscaperwhich satisfies theEscaperinterfaceTemplateOptionsstruct, which defines options for a template, such as itsEscaperTemplateOptionsas an optional parameter to template parsing functions; whennil, the old behavior is maintainedescape_tests.gowhich had no asserts, and adds a test for the new feature.Let me know what you think, or maybe if you like the idea but would prefer it implemented in a different way. It won't hurt my feelings if you close this PR; it's an unnecessary addition for most users, changes the public API, and I don't mind maintaining a fork for my purposes.