Introduce Inline Snippets tag by dejmedus · Pull Request #2001 · Shopify/liquid

dejmedus · 2025-10-20T20:28:02Z

This PR implements RFC#1916 and introduces support for the new inline snippets {% snippet %} tag, which allows us to define reusable template components directly within Liquid files

Traditionally, snippets are stored as separate .liquid files in a snippets/ directory and rendered using the {% render %} tag. The {% snippet %} tag allows us to define and render inline snippets in the same file

  {% snippet input %}
    {% doc %}
      @param {string} type 
      @param {string} value
    {% enddoc %}

    <input type="{{ type }}" value="{{ value }}" />
  {% endsnippet %}

  {% render input, type: "text", value: "Hi!" %}

karreiro

Thank you for this PR, @dejmedus! Excellent stuff! I've left some minor comments, but it's really cool to see inline snippets working :) 🚀

Maaarcocr

given that we are allowing variables to be passed to render like we do for blocks in shopify themes, I think it would be wise to have a shared interface here that we can use in both places.

what does this mean practically? instead of checking for SnippetDrop, if the ruby object that is passed responds to a certain method (let's say render or maybe a less common name that may not be mistakenly implemented by other drops) then it will get called.

This way we can remove our monkey patching of render in storefronts, as having callable objects is now a real liquid feature and it has a shared interface we can use.

dejmedus · 2025-10-24T00:15:25Z

instead of checking for SnippetDrop, if the ruby object that is passed responds to a certain method

Thank you for the detailed explanation @Maaarcocr! I added a to_partial method to SnippetDrop so render can differentiate by respond_to?(:to_partial). Does this sound like what we are aiming for?

Inline snippets will reduce code duplication and improve the developer experience, eliminating the need for one-off snippet files

Previously, inline snippets syntax looked a bit different, they: - used strings as tag identifiers - defined tag arguments {% snippet "input" |type| %} This PR updates snippets to better reflect the currently proposed syntax Co-authored-by: Orlando Qiu <orlando.qiu@shopify.com>

Currently, snippet files identified by strings. This PR makes changes to render to allow for new inline snippets to use variables as identifiers instead

This commit updates the render method to share parts of the snippet and block rendering logic to enable inline snippets to support `with`, `for`, and `as` syntax

karreiro

Thank you for this PR, @dejmedus! I just left one minor question left, but overall, everything looks good to me :)

karreiro

Thank you, @dejmedus! Excellent stuff 🚀

Maaarcocr · 2025-10-29T12:47:49Z

looks solid. one suggestion, if we do not have a test for this, can you please add a test for something like:

{% snippet foo %}
{% render "THIS_DOES_NOT_EXIST" %}
{% endsnippet %}

{% render foo %}

to see what file and line number the render for rendering a non existing snippet has?
(the render inside the snippet is just a simple way to generate a liquid error)

in theory I would expect this to render something like:

Liquid error (<filename> line 2): the snippet cannot be found or something like this

but what I care about is <filename>. if that code is contained in a file called bar.liquid <filename> should be bar

karreiro

Thank you for the changes, @dejmedus! Excellent catches, @Maaarcocr!

…sages in the render tag

bakura10 · 2025-10-31T14:13:50Z

Awesome feature! Do we know when this will be added to Shopify? :)

ianks · 2025-10-31T22:07:43Z

+        partial = template.to_partial
+        template_name = template.filename
+        context_variable_name = @alias_name || template.name
+      elsif @template_name_expr.is_a?(String)


nit: we should first check is_a?(String) since its the common/hot path

ianks · 2025-10-31T22:08:44Z

+
+      if template.respond_to?(:to_partial)
+        partial = template.to_partial
+        template_name = template.filename


would be good to respond to name as well for duck typing

ianks · 2025-10-31T22:10:42Z

+    private
+
+    def assign_score_of(snippet_drop)
+      snippet_drop.body.nodelist.sum { |node| node.to_s.bytesize }


I'm not sure if this makes sense. Assigning a snippet drop shouldn't rely on parsed AST for this functionality.

Liquid to 5.11. For now, the inclusion of Inline Snippets in the latest Liquid release is being treated as a bug. While #2001 does implement the scope contained in RFC#1916, we need to take a step back to make sure we’re setting our sights high enough with this feature, and that we’re truly supporting theme developers in the ways they need. If you have any feedback, please leave a comment on RFC#1916. - Liquid Developer Tools

This commit reverts the Inline Snippets tag (#2001) and bumps Liquid to 5.11. For now, the inclusion of Inline Snippets in the latest Liquid release is being treated as a bug. While #2001 does implement the scope contained in RFC#1916, we need to take a step back to make sure we’re setting our sights high enough with this feature, and that we’re truly supporting theme developers in the ways they need. If you have any feedback, please leave a comment on RFC#1916. - Liquid Developer Tools

PaulNewton · 2025-12-03T20:35:46Z

If this is being reverted good

https://github.com/Shopify/liquid/pull/2017/files#diff-abfa5988643af1b8b2600aac13b273922dbb3372e021bf1d7caadfe7473c9561R37

Please consider renaming this so we are not overloading even more concepts words in liquid and downstream platforms
.With this out in it's current naming it adds a permanent type of friction everywhere i.e. when someone says "fix the snippet bug" what are they talking about a file or a tag in some other file.

Wrote about the pedagogy of this in the RFC #1916 (comment)

bakura10 · 2026-01-20T01:45:21Z

@karreiro any info on when this will be merged to Shopify? We have a few use cases in our code where this would drastically remove duplication.

PaulNewton · 2026-01-20T21:07:19Z

@bakura10 it's reverted, and is in RFC #1916
I can use this like crazy too but it's current approach is flawed and needs more scrutiny and better feedback; and non-ambiguous naming or it's just gonna confuse merchants.

Probably be faster if the slack was still around so more shopify-partner even knew this was a thing they were finally chasing so more people were chiming in, or pushing on their shopify-connections.

v5.11.0 Latest
What's Changed
...
Revert the Inline Snippets tag (https://github.com/Shopify/liquid/pull/2001), treat its inclusion in the latest Liquid release as a bug, and allow for feedback on RFC#1916 to better support Liquid developers by @karreiro in https://github.com/Shopify/liquid/pull/2012

karreiro reviewed Oct 21, 2025

View reviewed changes

karreiro requested a review from charlespwd October 21, 2025 16:51

charlespwd reviewed Oct 21, 2025

View reviewed changes

Comment thread lib/liquid/tags/render.rb Outdated

dejmedus force-pushed the jb-inline-snippets branch 3 times, most recently from bdf3e2a to 266e1ed Compare October 22, 2025 22:47

Maaarcocr requested changes Oct 23, 2025

View reviewed changes

dejmedus force-pushed the jb-inline-snippets branch from c0918c5 to 1133386 Compare October 23, 2025 21:07

dejmedus marked this pull request as ready for review October 24, 2025 00:15

karreiro reviewed Oct 24, 2025

View reviewed changes

Comment thread lib/liquid/tags/snippet.rb Outdated

dejmedus force-pushed the jb-inline-snippets branch from 52ae826 to fecdb2c Compare October 24, 2025 18:04

Base automatically changed from rigid-mode to main October 27, 2025 15:56

EvilGenius13 and others added 15 commits October 27, 2025 10:11

Introduce new inline snippets tag

8c61497

Inline snippets will reduce code duplication and improve the developer experience, eliminating the need for one-off snippet files

Create SnippetDrop and set in scope

3a13ac7

Change inline snippet identifier from string to variable

db474d5

Currently, snippet files identified by strings. This PR makes changes to render to allow for new inline snippets to use variables as identifiers instead

Support ... inline snippet syntax

a384e22

Support with, for, and as inline snippet syntax

ba5aa0a

This commit updates the render method to share parts of the snippet and block rendering logic to enable inline snippets to support `with`, `for`, and `as` syntax

Remove inline snippet specific example files

b5ecd4d

Render arguments should maintain correct precedence

9409dd8

Implement resource limits and remove leftover string references

fb6cf17

Support prop spreading

96a4492

Raise syntax error on incorrect render identifier type

3556c33

Remove ... syntax references

c6c342a

Allow render tag to recognize drops that respond to to_partial

1069b94

Extract snippet resource scoring logic into assign_score_of

de23ed8

Add liquid_public_docs yard tag to snippet tag

47288cc

dejmedus force-pushed the jb-inline-snippets branch from fecdb2c to 47288cc Compare October 27, 2025 16:29

karreiro reviewed Oct 27, 2025

View reviewed changes

Comment thread lib/liquid/tags/render.rb Outdated

Remove unneeded read method

d109bc9

dejmedus requested a review from Maaarcocr October 27, 2025 18:52

charlespwd reviewed Oct 27, 2025

View reviewed changes

Comment thread lib/liquid/tags/snippet.rb Outdated

charlespwd reviewed Oct 27, 2025

View reviewed changes

Comment thread lib/liquid/tags/snippet.rb

karreiro approved these changes Oct 28, 2025

View reviewed changes

Raise error on invalid snippet name

99b0b38

dejmedus requested a review from charlespwd October 28, 2025 17:47

Maaarcocr reviewed Oct 29, 2025

View reviewed changes

Comment thread lib/liquid/tags/render.rb Outdated

Maaarcocr reviewed Oct 29, 2025

View reviewed changes

Comment thread test/integration/tags/snippet_test.rb Outdated

Missing inline snippets should display same error as filebased

eab457f

dejmedus force-pushed the jb-inline-snippets branch from b02ece2 to eab457f Compare October 29, 2025 17:44

karreiro requested a review from Maaarcocr October 30, 2025 08:34

karreiro approved these changes Oct 30, 2025

View reviewed changes

Maaarcocr reviewed Oct 30, 2025

View reviewed changes

Comment thread lib/liquid/tags/render.rb Outdated

Maaarcocr approved these changes Oct 30, 2025

View reviewed changes

Update error handling for keeping backward-compatibility on error mes…

c4a6987

…sages in the render tag

karreiro merged commit a16ec56 into main Oct 30, 2025
23 checks passed

ianks reviewed Oct 31, 2025

View reviewed changes

karreiro mentioned this pull request Nov 19, 2025

Bump Liquid to 5.11.0 #2012

Merged

Uh oh!

Conversation

dejmedus commented Oct 20, 2025

Uh oh!

karreiro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Maaarcocr left a comment

Choose a reason for hiding this comment

Uh oh!

dejmedus commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

karreiro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

karreiro left a comment

Choose a reason for hiding this comment

Uh oh!

Maaarcocr commented Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

karreiro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bakura10 commented Oct 31, 2025

Uh oh!

ianks Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

ianks Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

ianks Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

PaulNewton commented Dec 3, 2025

Uh oh!

bakura10 commented Jan 20, 2026

Uh oh!

PaulNewton commented Jan 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

dejmedus commented Oct 24, 2025 •

edited

Loading

Maaarcocr commented Oct 29, 2025 •

edited

Loading