Markdoc formatter - update to skip printing undefined attributes #432
+32
−5
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
matv-stripe
changed the title
rpaul-stripe
approved these changes
Aug 9, 2023
|
I want to let @mfix-stripe weigh in before merging, but this looks good to me. |
mfix-stripe
reviewed
Aug 9, 2023
src/formatter.ts
Outdated
| if (Ast.isAst(v)) { | ||
| return format(v); | ||
| } | ||
| if (v === null) { | ||
| return 'null'; | ||
| } | ||
| if (v === undefined) { |
There was a problem hiding this comment.
Let's just move this to the top of this function.
src/formatter.ts
Outdated
Comment on lines
78
to
84
| if (formattedValue !== undefined) { | ||
| return `${a.name}=${formattedValue}`; | ||
| } else { | ||
| // The Markdoc parser does not support undefined attribute | ||
| // values. Filter those values out. | ||
| return undefined; | ||
| } |
There was a problem hiding this comment.
Suggested change
| if (formattedValue !== undefined) { | |
| return `${a.name}=${formattedValue}`; | |
| } else { | |
| // The Markdoc parser does not support undefined attribute | |
| // values. Filter those values out. | |
| return undefined; | |
| } | |
| if (formattedValue !== undefined) { | |
| return `${a.name}=${formattedValue}`; | |
| } | |
| // The Markdoc parser does not support undefined attribute | |
| // values. Filter those values out. | |
| return undefined; | |
src/formatter.ts
Outdated
Comment on lines
273
to
274
| const attributes = [...formatAttributes(n)]; | ||
| const tag = [open + n.tag, ...attributes.filter((v) => v !== undefined)]; |
There was a problem hiding this comment.
Suggested change
| const attributes = [...formatAttributes(n)]; | |
| const tag = [open + n.tag, ...attributes.filter((v) => v !== undefined)]; | |
| const attributes = [...formatAttributes(n)].filter((v) => v !== undefined); | |
| const tag = [open + n.tag, ...attributes]; |
|
ptal @mfix-stripe |
mfix-stripe
requested changes
Aug 9, 2023
src/formatter.ts
Outdated
Comment on lines
78
to
83
| if (formattedValue !== undefined) { | ||
| return `${a.name}=${formattedValue}`; | ||
| } | ||
| // The Markdoc parser does not support undefined attribute | ||
| // values. Filter those values out. | ||
| return undefined; |
There was a problem hiding this comment.
Wait, I just realized. Let's just move if (formattedValue === undefined) return undefined to the first branch of this function, and leave return ${a.name}=${formattedValue}; as the fallback.
|
ty for the feedback! ptal @mfix-stripe |
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.
See test - the Markdoc parser does not support
undefinedpassed into as an attribute. When generating Markdoc this can cause issues because the data source might have undefined values.Let me know thoughts around this, I am fine with not merging it.
r? @mfix-stripe