Server: Fix string escaping in CSF compiler #14615
Merged
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
shilman
requested changes
Apr 15, 2021
| @@ -5,7 +5,7 @@ const { identifier } = require('safe-identifier'); | |||
|
|
|||
| export function stringifyObject(object: any, level = 0, excludeOuterParams = false): string { | |||
| if (typeof object === 'string') { | |||
| return `'${object}'`; | |||
| return `"${object}"`; | |||
There was a problem hiding this comment.
Won't this version have the same problem as the original but in the case of double quotes? I suggest you use JSON.stringify (or something similar) that handles string escaping for you. WDYT?
There was a problem hiding this comment.
Great suggestion. Updated to do that.
|
@shilman Thoughts on the right tests here? I could add examples with single and double quotes into the snapshot tests. |
|
Works for me. If you've seen our test coverage you'll know this isn't our strong suit 😭 |
|
Release vehicle for this one? 6.2.9? |
shilman
added
the
patch:yes
|
@jonspalmer sure. i'll release in an alpha then patch it back to 6.2.9 |
shilman
changed the title
shilman
added
the
patch:done
shilman
added a commit
that referenced
this pull request
Apr 23, 2021
Server: Fix string escaping in CSF compiler
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.
Consumers of Storybook Server declaring stories with single quotes in the names or control args result in syntax errors in the generated CSF stories. For example: jonspalmer/view_component-storybook#31
What I did
Changed the CSF compiler to output double quote strings vs single quote strings.
Discussion
While perhaps we'd like to generate a more "pure" version of the CSF and only use double quotes when necessary in practice this is super hard to organize.
Also the source of Server stories is JSON, which uses double quotes, it's very natural to just use the same encoding.
How to test
Curious as to others thoughts here.
We have snapshot tests and they might be good enough.
I wonder if we could/should evaluate the generated CSF and at least prove it's valid javascript?