Fix syntax highlighting for param tag #31
+53
−6
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
This commit fixes an issue where the param tag would incorrectly match the first "-" found and comment anything after it. This broke snake case variables and other similar cases.
aswamy
approved these changes
Feb 21, 2025
| { | ||
| "include": "#liquid_doc_fallback_tag" | ||
| } | ||
| ] | ||
| }, | ||
| "liquid_doc_param_tag": { | ||
| "match": "(@param)\\s+(?:({[^}]*}?)\\s+)?([a-zA-Z_]\\w*)?", | ||
| "match": "(@param)\\s+(?:({[^}]*}?)\\s+)?([a-zA-Z_][\\w-]*)?(?:\\s+(.*))?", |
There was a problem hiding this comment.
Suggested change
| "match": "(@param)\\s+(?:({[^}]*}?)\\s+)?([a-zA-Z_][\\w-]*)?(?:\\s+(.*))?", | |
| "match": "(@param)\\s+(?:({[^}]*}?)\\s+)?(\\[?[a-zA-Z_][\\w-]*\\]?)?(?:\\s+(.*))?", |
Let's also capture optional params
| "match": "(@description)\\b", | ||
| "captures": { | ||
| "1": { | ||
| "name": "storage.type.class.liquid" |
There was a problem hiding this comment.
Can we have the contents of description, example, and param in string-color rather than comment-color?
I know why we chose comment (since JS doc also appears as a comment), but we should really only use comments for our comment tag or text nodes instead of doc tag.
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.
Closes: https://github.com/Shopify/developer-tools-team/issues/557
Note There is some code from the description PR that I have in here to ensure everything is working. I will rebase once we merge that.
What is this PR doing?
There was a syntax highlighting error when you would have a hyphen in a variable name before the hyphen used to show a description in a param tag.
For example"
@param {String} title - The title of the productwould properly highlight the code.@param {String} my-title - The title of the productwould stop highlighting properly aftermy-This is because we were matching on the first hyphen found. I've reworked the matching and now we look for the first space after the variable name. This is a lot more robust.
The changes work even if you don't add the variable type such as
{String}Before:
After:
