Support code completion for inline snippet render arguments #1075
Conversation
This file contains hidden or 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
dejmedus
force-pushed
the
jb-inline-snippets-args-completion
branch
from
402e7be to
b332d3d
Compare
shoplando
reviewed
Oct 20, 2025
Comment on lines
94
to
139
| function getInlineSnippetDocParams( | ||
| params: LiquidCompletionParams, | ||
| snippet: LiquidVariableLookup, | ||
| ): LiquidDocParameter[] { | ||
| const ast = params.document.ast; | ||
| if (ast instanceof Error || ast.type !== NodeTypes.Document) return []; | ||
|
|
||
| if (!snippet.name) return []; | ||
|
|
||
| let snippetNode: LiquidTagSnippet | undefined; | ||
|
|
||
| visit(ast, { | ||
| LiquidTag(node: LiquidTag) { | ||
| if ( | ||
| node.name === 'snippet' && | ||
| typeof node.markup !== 'string' && | ||
| node.markup.type === NodeTypes.VariableLookup && | ||
| node.markup.name === snippet.name | ||
| ) { | ||
| snippetNode = node as LiquidTagSnippet; | ||
| } | ||
| }, | ||
| }); | ||
|
|
||
| if (!snippetNode?.children) return []; | ||
|
|
||
| const docNode = snippetNode.children.find( | ||
| (node): node is LiquidRawTag => node.type === NodeTypes.LiquidRawTag && node.name === 'doc', | ||
| ); | ||
|
|
||
| if (!docNode) return []; | ||
|
|
||
| const paramNodes = (docNode.body.nodes as LiquidHtmlNode[]).filter( | ||
| (node): node is LiquidDocParamNode => node.type === NodeTypes.LiquidDocParamNode, | ||
| ); | ||
|
|
||
| return paramNodes.map( | ||
| (node): LiquidDocParameter => ({ | ||
| nodeType: 'param', | ||
| name: node.paramName.value, | ||
| description: node.paramDescription?.value ?? null, | ||
| type: node.paramType?.value ?? null, | ||
| required: node.required, | ||
| }), | ||
| ); | ||
| } |
Contributor
There was a problem hiding this comment.
I think it might be worth moving this helper function into an utils file like liquidDoc since this could be a very helpful function for hovering and some theme checks like MissingRenderSnippetArguments or UnrecognizedRenderSnippetArgument
Contributor
Author
There was a problem hiding this comment.
Good call! I moved it out:)
shoplando
approved these changes
Oct 20, 2025
Argument completion suggestions should be offered while rendering an inline snippet. This commit adds this functionality by selecting and displaying arguments defined in an inline snippets doc tag
dejmedus
force-pushed
the
jb-inline-snippets-args-completion
branch
from
b332d3d to
50e2939
Compare
EvilGenius13
approved these changes
Oct 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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?
While rendering an inline snippet that contains a doc tag we should be offered argument completion suggestions
Demo
render-arguments-completion-demo.mov
How to test
Pull down the branch
gh pr checkout 1075Before you deploy
changeset