fix: allow spaces in variables #1035
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
davinhazard
approved these changes
Dec 5, 2024
rafegoldberg
reviewed
Dec 5, 2024
__tests__/lib/mdast/variables/in.mdx
Outdated
| @@ -1 +1 @@ | |||
| Hello, {user.name} | |||
| Hello, { user.name } | |||
There was a problem hiding this comment.
Maybe both just in case?
Suggested change
| Hello, { user.name } | |
| **With Spaces:** { user.name } | |
| **Without Spaces:** {user.name} |
processor/transform/variables.ts
Outdated
| @@ -12,7 +12,7 @@ const variables = | |||
| visit(tree, (node, index, parent) => { | |||
| if (!['mdxFlowExpression', 'mdxTextExpression'].includes(node.type) || !('value' in node)) return; | |||
|
|
|||
| const match = node.value.match(/^user\.(?<value>.*)$/); | |||
| const match = node.value.match(/^\s*user\.(?<value>\S*)\s*$/); | |||
There was a problem hiding this comment.
I think variable names can include spaces though? So this should still be .* right?
There was a problem hiding this comment.
Oh no, that's so cursed
|
Ok, fixed this up so we should be able to handle variables with spaces in the name. |
rafegoldberg
approved these changes
Dec 5, 2024
processor/transform/variables.ts
Outdated
Comment on lines
15
to
29
| // @ts-expect-error - estree is not defined on our mdx types?! | ||
| if (node.data.estree.type !== 'Program') return; | ||
| // @ts-expect-error - estree is not defined on our mdx types?! | ||
| const [expression] = node.data.estree.body; | ||
| if ( | ||
| !expression || | ||
| expression.type !== 'ExpressionStatement' || | ||
| !['Literal', 'Identifier'].includes(expression.expression.property?.type) | ||
| ) | ||
| return; | ||
|
|
||
| const name = | ||
| expression.expression.property.type === 'Identifier' | ||
| ? expression.expression.property.name | ||
| : expression.expression.property.value; |
There was a problem hiding this comment.
I like this a lot more than using regex, but it seems like this new logic will apply to all {vars} (not just user.-prefixed ones…) Does that matter at all?
There was a problem hiding this comment.
OH shit, I forget to check the module is named user. Good catch!
|
This PR was released!🚀 Changes included in v7.10.4 |
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.
🧰 Changes
Allows spaces in user variables.
Previous, the transformer was validating user variables with a regex that didn't allow spaces. This PR changes the regex to allow spaces. This also allows spaces in the variables names, which would have crashed the parser before.
All of the following are now valid:
🧬 QA & Testing