Liquid Snippets by ALSEL
🧰 ユーティリティ上級

liquid タグの整形・フォーマット

複数の Liquid ステートメントを liquid タグで一括記述したときのコード整形・フォーマット仕様を示すテストスニペット。インデント・改行・コメント・タグの解析を正しく処理する

用途
Prettier など Liquid コードのフォーマッタを開発・テストするときや、liquid タグの構文仕様を確認したいときに参照。
設置場所
このコード自体は参考資料・テストファイルであり、実装には不要。Liquid フォーマッタの開発時に期待される整形結果の具体例として使用。
注意点
このファイルは Shopify 公式のフォーマッタテストスイートの一部であり、手動で theme に貼り付けるコードではない。liquid タグ内の複数ステートメント、コメント、ネストされた条件分岐、インラインコメント(# 記法)の扱いはフォーマッタごとに異なるため、自店舗で使用するツールのドキュメントに従う必要がある。printWidth や window_size などフォーマッタオプションの値により出力が変わる。
タグ:liquid-tagformatterprettiercode-qualitysyntax

コード

152 行 / liquid
<div>
{%
  liquid
  assign x = 1
  assign y = 2
  if A
    assign z = 1
  endif
%}
</div>
<div>
{%- liquid
  assign x = 1
  assign y = 2
  if A
    assign z = 1
  endif -%}
</div>

It should reindent and format
{%- liquid
  if empty   and   true
render 'icon-cart-empty'
      else
  render 'icon-cart'
      endif
-%}

It should handle comments correctly
{%- liquid
comment
how u doin?
endcomment -%}

It should handle nested comments correctly
{%- liquid
comment
how u doin?
comment
  ho
endcomment
endcomment -%}

It should handle empty nested comments correctly
{%- liquid
comment
how u doin?
comment
endcomment
endcomment -%}

It should handle inline comments correctly
{%- liquid
# heyy how u doin
# not too bad
  #
# you? -%}

It should pretty print #### lines without a space
{%- liquid
#############
#     fancy
#############
-%}

It should keep at most one empty new line between statements, and strip trailing
{% liquid
# some reason
if cond

      echo foo


      echo bar

else
echo bar
endif


# some other block
case foo
when bar,baz
echo 'hi'

else
echo 'no'
endcase

%}

It should parse tags properly and print them properly
printWidth: 1
{% liquid
assign x = thing['property']|filter1|fitler2
echo x |filter1|  filter2
capture var
  if nil
  echo true
  else
  echo false
  endif
endcapture
cycle 'one', 'two', 'three'

for x in col reversed limit:10
echo x
else
echo 'nope'
endfor

form 'cart', cart
  echo 'huh?'
endform

increment i
section 'string'
layout 'string'

paginate col by 10 window_size:50
render 'icon' with x as bar foo:bar
endpaginate
%}

It should keep newlines between tags
{% liquid
  # comment 1

  # comment 2
  if cond
    echo foo

    echo bar
  endif
%}

It should keep leading whitespace in comments
{% liquid
# This list should not be reindented:
#   - a
#   - b
#      - d
#   - c
%}

It should not freak out on variable output characters inside conditions
{% liquid
if shop.foo contains '{{cond}}'
echo 'xxx'
endif
%}

出典・ライセンス

License:
MIT

このコードは Shopify 著作の MIT ライセンスソースです。 原本の著作権は Shopify が保有します。日本語訳は ALSEL によるものです。

関連項目

🧰 ユーティリティ初級

コメント後の空白フォーマット

Liquid コメントタグの直後に改行や空白がある場合の正しいフォーマット例。prettier-plugin-liquid によるコード整形テストケース。

📁 theme-tools·MIT·6
🧰 ユーティリティ初級

Liquidコメントのフォーマット

Liquid のコメントタグ直後に改行がある場合の正しいフォーマット例。prettier-plugin-liquid による自動整形テストケース。

📁 theme-tools·MIT·6
🧰 ユーティリティ初級

セクション呼び出しの改行制御

{% sections %} タグの前後の空白制御(ホワイトスペース削除演算子 `{%-` と `-%}` の使い方)を示すサンプル。Prettier による Liquid コードフォーマットで改行が崩れないことを確認するテストケース。

📁 theme-tools·MIT·7
🧰 ユーティリティ初級

Prettier フォーマッタの HTML リスト整形テスト

Prettier Liquid プラグインが HTML のリスト要素(ul / ol)をどのように整形・改行するかをテストするサンプルコード。短い行は1行、長い行は複数行に自動で分割される動作を検証する。

📁 theme-tools·MIT·8
🧰 ユーティリティ上級

Vue.js属性のLiquid整形

Vue.js のディレクティブ(@click、:class など)を含む Liquid コードを Prettier で正しく整形するテストケース。spec 準拠の属性名を保持したまま、改行・インデント処理を行う。

📁 theme-tools·MIT·9
🧰 ユーティリティ上級

sections タグのフォーマット

Liquid の sections タグ構文と、Prettier によるフォーマット時の動作を示すテストファイル。タグ名の直前・直後の空白や改行が保持される仕様を確認するサンプル。

📁 theme-tools·MIT·9