Add parsing and prettier support for @example tags in liquid doc #725
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
jamesmengo
reviewed
Jan 23, 2025
jamesmengo
reviewed
Jan 23, 2025
jamesmengo
reviewed
Jan 23, 2025
jamesmengo
reviewed
Jan 28, 2025
jamesmengo
approved these changes
Jan 28, 2025
jamesmengo
reviewed
Jan 28, 2025
|
LGTM and 🎩 went well, thanks! We can write those tests in a follow-up. |
EvilGenius13
force-pushed
the
implement-examplenode
branch
from
c1b702f to
c24909d
Compare
jamesmengo
reviewed
Feb 3, 2025
| @@ -765,6 +766,14 @@ export interface LiquidDocParamNode extends ASTNode<NodeTypes.LiquidDocParamNode | |||
| /** Optional type annotation for the parameter (e.g. "{string}", "{number}") */ | |||
| paramType: TextNode | null; | |||
| } | |||
|
|
|||
| /** Represents a `@example` node in a LiquidDoc comment - `@example @exampleContent` */ | |||
There was a problem hiding this comment.
Suggested change
| /** Represents a `@example` node in a LiquidDoc comment - `@example @exampleContent` */ | |
| /** Represents a `@example` node in a LiquidDoc comment - `@example exampleContent` */ |
jamesmengo
reviewed
Feb 3, 2025
Comment on lines
+1315
to
+1320
| exampleContent: { | ||
| type: NodeTypes.TextNode, | ||
| value: node.exampleContent.value, | ||
| position: position(node.exampleContent), | ||
| source: node.exampleContent.source, | ||
| }, |
There was a problem hiding this comment.
Suggested change
| exampleContent: { | |
| type: NodeTypes.TextNode, | |
| value: node.exampleContent.value, | |
| position: position(node.exampleContent), | |
| source: node.exampleContent.source, | |
| }, | |
| exampleContent: toTextNode(node.exampleContent), |
There was a problem hiding this comment.
Could you also fix this for paramNode? A follow-up PR is fine too :)
There was a problem hiding this comment.
Fixed in #759
Left out paramNode as it's currently being refactored in another PR
jamesmengo
reviewed
Feb 3, 2025
Comment on lines
+548
to
+551
|
|
||
| if (node.exampleContent?.value) { | ||
| const content = node.exampleContent.value; | ||
| if (content) { |
There was a problem hiding this comment.
Suggested change
| if (node.exampleContent?.value) { | |
| const content = node.exampleContent.value; | |
| if (content) { | |
| const content = node.exampleContent?.value | |
| if (content) { | |
| .... | |
| } |
jamesmengo
reviewed
Feb 3, 2025
| It should respect example content with param and description | ||
| {% doc %} | ||
| @param paramName - param with description | ||
| @example |
There was a problem hiding this comment.
Agreed. This will be tackled in a separate PR as there is some other prettier logic that will need refactoring as well.
|
Thanks for the changes! The only blocking comment I have is around this, let me know your thoughts! |
2 tasks
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 are you adding in this PR?
References: https://github.com/Shopify/develop-advanced-edits/issues/471
Added support for parsing and formatting
@exampletags withinLiquidDocblocks.Feedback
Right now, we aren't controlling whitespace for example tags. If someone wants to write
check out. my great example, it would stay in that format. Should trim whitespace or allow people writing examples to have full control?What's next? Any followup issues?
I want to add prettier support to automatically move
@exampletags and content below@paramas it is the proper flow.What did you learn?
AST's and CST's are quite puzzle to figure out.
Test
Example.tag.prettier.support.mp4
Before you deploy
changeset