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

Liquid タグのコード整形・インデント

複数行の Liquid タグ(`liquid` タグ内の assign、if、render、for など)を自動整形し、インデント・空行・コメントを統一規則に従って調整する。Prettier プラグイン用のテストケース兼リファレンス。

用途
テーマコードの整形ルール統一や、Prettier と Liquid プラグインを組み合わせた自動フォーマット設定の検証時に参考にする。
設置場所
このコード自体はテーマに貼り付けるものではなく、Prettier プラグインの開発・検証用テストケース。テーマ側では Prettier 設定ファイル(.prettierrc)で `liquid-plugin` を指定し、`prettier --write` で自動整形する。
注意点
このスニペットはテストケース集なので、実際のテーマには貼り付けない。整形対象の Liquid コードは `assign`、`if`、`comment`、`for`、`render` など複数タグ種に対応するが、3階層以上深くネストされたタグの場合、インデント深度の計算がずれることがある。空行の統一は「最大1行」ルールが適用されるため、意図的に複数行空ける必要がある場合は手動調整が必要。
タグ:liquid-tagprettierformattingcode-stylelinting

コード

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 null
      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