Skip to content

Add support for LiquidDoc #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
deathaxe merged 7 commits into from
May 29, 2025
Merged

Add support for LiquidDoc #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8f22022
Add support for LiquidDoc
nikitaourazbaev May 28, 2025
99ff62a
Move test to correct file
nikitaourazbaev May 28, 2025
e27b443
Undo change to markdown syntax test file
nikitaourazbaev May 28, 2025
0562fc8
Remove `text.html.liquid` scope in attempt to fix tests
nikitaourazbaev May 28, 2025
b4ab379
Remove `meta.template.liquid` scope in attempt to fix tests
nikitaourazbaev May 28, 2025
1643624
Merge branch 'develop' into feat/doc-tag
deathaxe May 29, 2025
a10c464
Directly implement LiquidDoc
deathaxe May 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions Syntaxes/Liquid.sublime-syntax
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ contexts:

liquid-tags:
- include: jekyll-highlight-tags
- include: liquid-doc-tags
- include: liquid-comment-tags
- include: liquid-schema-tags
- include: liquid-javascript-tags
Expand Down Expand Up @@ -70,6 +71,42 @@ contexts:
3: punctuation.section.embedded.end.liquid
pop: 1

###[ LIQUID DOC TAGS ]####################################################

liquid-doc-tags:
# https://shopify.dev/docs/api/liquid/tags/theme-tags#doc
- match: ({%-?)\s*(doc)\s*(-?%})
scope: meta.statement.liquid
captures:
1: punctuation.section.embedded.begin.liquid
2: keyword.declaration.comment.liquid
3: punctuation.section.embedded.end.liquid
push: liquid-doc-tag-body

liquid-doc-tag-body:
- meta_scope: meta.embedded.liquid source.liquid
- meta_content_scope: comment.block.documentation.liquid
- match: ({%-?)\s*(enddoc)\s*(-?%})
scope: meta.statement.liquid
captures:
1: punctuation.section.embedded.begin.liquid
2: keyword.declaration.comment.liquid
3: punctuation.section.embedded.end.liquid
pop: 1
- match: '@description\b'
scope: entity.name.tag.documentation.liquid
- match: '(@param)\s+(({){{liquid_variables}}(}))\s+(\[?{{liquid_variables}}\]?)'
captures:
1: entity.name.tag.documentation.liquid
2: storage.type.liquid
3: punctuation.definition.type.begin.liquid
4: punctuation.definition.type.end.liquid
5: variable.other.liquid
- match: '@example\b'
scope: entity.name.tag.documentation.liquid
embed: scope:text.html.liquid
escape: (?=@example\b|{%-?\s*enddoc\s*-?%})

###[ LIQUID JAVASCRIPT TAGS ]##################################################

liquid-javascript-tags:
Expand Down
60 changes: 60 additions & 0 deletions tests/syntax_test_liquid.liquid.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,66 @@
| ^^^^^^^^^^ keyword.declaration.comment.liquid
| ^^ punctuation.section.embedded.end.liquid

{% doc %}
| <- meta.embedded.liquid source.liquid meta.statement.liquid punctuation.section.embedded.begin.liquid
|^^^^^^^^ meta.embedded.liquid source.liquid meta.statement.liquid
|^ punctuation.section.embedded.begin.liquid
| ^^^ keyword.declaration.comment.liquid
| ^^ punctuation.section.embedded.end.liquid

@description This will display a product title
|^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.embedded.liquid source.liquid comment.block.documentation.liquid
| ^^^^^^^^^^^^ entity.name.tag.documentation.liquid

@param {product} product The product to display the title for
|^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.embedded.liquid source.liquid comment.block.documentation.liquid
| ^^^^^^ entity.name.tag.documentation.liquid
| ^^^^^^^^^ storage.type.liquid
| ^ punctuation.definition.type.begin.liquid
| ^ punctuation.definition.type.end.liquid
| ^^^^^^^ variable.other.liquid

@example
|^^^^^^^^^ meta.embedded.liquid source.liquid comment.block.documentation.liquid
| ^^^^^^^^ entity.name.tag.documentation.liquid
<div class={{ var | filter }}></div>
|^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.embedded.liquid source.liquid comment.block.documentation.liquid
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.tag.block
| ^ punctuation.definition.tag.begin.html
| ^^^ entity.name.tag
| ^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute-with-value.class.html
| ^^^^^ entity.other.attribute-name.class.html
| ^ punctuation.separator.key-value.html
| ^^^^^^^^^^^^^^^^^^ meta.class-name.html meta.string.html meta.interpolation.liquid
| ^^ punctuation.section.interpolation.begin.liquid
| ^^^^^^^^^^^^^^ source.liquid
| ^^^ variable.other.liquid
| ^^^^^^^^ meta.filter.liquid
| ^ keyword.operator.logical.pipe.liquid
| ^^^^^^ support.function.filter.liquid
| ^^ punctuation.section.interpolation.end.liquid
| ^ punctuation.definition.tag.end.html
| ^^ punctuation.definition.tag.begin.html
| ^^^ entity.name.tag
| ^ punctuation.definition.tag.end.html

@example
| ^^^^^^^^ entity.name.tag.documentation.liquid
{% render 'price' %}
|^^^^^^^^^^^^^^^^^^^^^^^ meta.embedded.liquid source.liquid comment.block.documentation.liquid
| ^^ punctuation.section.embedded.begin.liquid
| ^^^^^^ support.function.liquid
| ^^^^^^^ meta.string.liquid string.quoted.single.liquid
| ^ punctuation.definition.string.begin.liquid
| ^ punctuation.definition.string.end.liquid
| ^^ punctuation.section.embedded.end.liquid

{% enddoc %}
|^^^^^^^^^^^ meta.embedded.liquid source.liquid meta.statement.liquid
|^ punctuation.section.embedded.begin.liquid
| ^^^^^^ keyword.declaration.comment.liquid
| ^^ punctuation.section.embedded.end.liquid

{% javascript %}
| <- meta.embedded.liquid source.liquid meta.statement.liquid punctuation.section.embedded.begin.liquid
|^^^^^^^^^^^^^^^ meta.embedded.liquid source.liquid meta.statement.liquid
Expand Down
60 changes: 60 additions & 0 deletions tests/syntax_test_liquid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,66 @@ I am {{ age }} and my favorite food is {{ favorite_food }}.
| ^^^^^^^^^^ keyword.declaration.comment.liquid
| ^^ punctuation.section.embedded.end.liquid

{% doc %}
| <- meta.embedded.liquid source.liquid meta.statement.liquid punctuation.section.embedded.begin.liquid
|^^^^^^^^ meta.embedded.liquid source.liquid meta.statement.liquid
|^ punctuation.section.embedded.begin.liquid
| ^^^ keyword.declaration.comment.liquid
| ^^ punctuation.section.embedded.end.liquid

@description This will display a product title
|^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.embedded.liquid source.liquid comment.block.documentation.liquid
| ^^^^^^^^^^^^ entity.name.tag.documentation.liquid

@param {product} product The product to display the title for
|^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.embedded.liquid source.liquid comment.block.documentation.liquid
| ^^^^^^ entity.name.tag.documentation.liquid
| ^^^^^^^^^ storage.type.liquid
| ^ punctuation.definition.type.begin.liquid
| ^ punctuation.definition.type.end.liquid
| ^^^^^^^ variable.other.liquid

@example
|^^^^^^^^^ meta.embedded.liquid source.liquid comment.block.documentation.liquid
| ^^^^^^^^ entity.name.tag.documentation.liquid
<div class={{ var | filter }}></div>
|^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.embedded.liquid source.liquid comment.block.documentation.liquid
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.tag.block
| ^ punctuation.definition.tag.begin.html
| ^^^ entity.name.tag
| ^^^^^^^^^^^^^^^^^^^^^^^^ meta.attribute-with-value.class.html
| ^^^^^ entity.other.attribute-name.class.html
| ^ punctuation.separator.key-value.html
| ^^^^^^^^^^^^^^^^^^ meta.class-name.html meta.string.html meta.interpolation.liquid
| ^^ punctuation.section.interpolation.begin.liquid
| ^^^^^^^^^^^^^^ source.liquid
| ^^^ variable.other.liquid
| ^^^^^^^^ meta.filter.liquid
| ^ keyword.operator.logical.pipe.liquid
| ^^^^^^ support.function.filter.liquid
| ^^ punctuation.section.interpolation.end.liquid
| ^ punctuation.definition.tag.end.html
| ^^ punctuation.definition.tag.begin.html
| ^^^ entity.name.tag
| ^ punctuation.definition.tag.end.html

@example
| ^^^^^^^^ entity.name.tag.documentation.liquid
{% render 'price' %}
|^^^^^^^^^^^^^^^^^^^^^^^ meta.embedded.liquid source.liquid comment.block.documentation.liquid
| ^^ punctuation.section.embedded.begin.liquid
| ^^^^^^ support.function.liquid
| ^^^^^^^ meta.string.liquid string.quoted.single.liquid
| ^ punctuation.definition.string.begin.liquid
| ^ punctuation.definition.string.end.liquid
| ^^ punctuation.section.embedded.end.liquid

{% enddoc %}
|^^^^^^^^^^^ meta.embedded.liquid source.liquid meta.statement.liquid
|^ punctuation.section.embedded.begin.liquid
| ^^^^^^ keyword.declaration.comment.liquid
| ^^ punctuation.section.embedded.end.liquid

{% javascript %}
| <- meta.embedded.liquid source.liquid meta.statement.liquid punctuation.section.embedded.begin.liquid
|^^^^^^^^^^^^^^^ meta.embedded.liquid source.liquid meta.statement.liquid
Expand Down