Introduce Inline Snippets tag #2001

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 :) 🚀

lib/liquid/tags/snippet.rb

lib/liquid/locales/en.yml

lib/liquid/tags/snippet.rb

lib/liquid/tags/render.rb

lib/liquid.rb

lib/liquid/tags/render.rb

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?

karreiro · 2025-10-24T16:44:56Z

lib/liquid/tags/snippet.rb

+  #   {% snippet input %}
+  #     value
+  #   {% endsnippet %}
+


I think we could remove this line:

Suggested change

(I'm almost sure it doesn't impact YARD pipeline, but I think it would be nice to remove to be 100% sure and also be cohesive with the other tags) 😌

Good call! Fixed

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 :)

lib/liquid/tags/render.rb

charlespwd · 2025-10-27T19:25:44Z

lib/liquid/tags/snippet.rb

+  # @liquid_description
+  #   You can create inline snippets to make your Liquid code more modular.
+  # @liquid_syntax
+  #   {% snippet input %}


Non blocking: we should name this snippet_name instead? So that we'd call {% render snippet_name %}?

Looks like the docs for assign are using variable_name. We can try to be consistent here.

charlespwd · 2025-10-27T19:26:30Z

lib/liquid/tags/snippet.rb

+        @to = p.consume(:id)
+      else
+        raise SyntaxError, options[:locale].t("errors.syntax.snippet")
+      end


We're missing a p.consume(:end_of_text), otherwise folks could do stuff like {% snippet foo bar baz %} and we wouldn't be throwing an error

Thank you! Fixed

karreiro

Thank you, @dejmedus! Excellent stuff 🚀

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

lib/liquid/tags/render.rb Outdated Show resolved Hide resolved

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

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

lib/liquid/tags/render.rb Outdated Show resolved Hide resolved

Remove unneeded read method

d109bc9

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

charlespwd reviewed Oct 27, 2025

View reviewed changes

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

Uh oh!

Introduce Inline Snippets tag #2001

Are you sure you want to change the base?

Introduce Inline Snippets tag #2001

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!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dejmedus Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

karreiro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

charlespwd Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

charlespwd Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

dejmedus Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

karreiro left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dejmedus commented Oct 24, 2025 •

edited

Loading

karreiro Oct 24, 2025 •

edited

Loading