stringify description #37
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
hiimbex
suggested changes
Oct 17, 2018
There was a problem hiding this comment.
Thanks for the PR @dmlittle! I definitely appreciate the thought that went into this. However, I'm not really convinced this is the right way to handle the original issue. If we want to stringify or escape the description, I'd think we'd want to handle all of the variables in the template.
I left more thoughts in probot/probot#727 (comment) about the original source of this issue, which I'd like more clarity on before moving to a solution.
(Sorry to not merge what looks like a nice 1 line PR 😓)
|
Closing this PR! As discussed in probot/probot#727 we'll just start escaping the description and author fields again in the template. |
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.
What
answers.descriptionbefore passing it to egad's scaffold function.Why
Currently
descriptionisn't escaped in the probot template to allow for symbols in the description (<,>or&). This has the adverse effect that if double quotes are used in the description we end up with an invalid JSON file in package.json as they aren't escaped.For example:
{ "description: "a description with "quotes"." }Since it seems we purposely chose to not HTML escape descriptions I'm stringifiying the description and removing the beginning and end quotes of the JSON stringification in order to end up with a valid JSON object.
Happy to talk about other way of tackling this issue!
Misc
Closes probot/probot#727