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

Prettier による Liquid コードのフォーマット

if・unless 文内の開きタグ・閉じタグを条件付きで配置するときに、Prettier プラグインが正しくフォーマットするかを検証するテストコード。printWidth 設定に応じた改行・インデント処理を確認する。

用途
Liquid テンプレートの開発環境で、条件分岐の中に HTML タグが挟まる複雑な構造をコード整形するとき。Prettier プラグイン自体の動作確認・デバッグ用。
設置場所
このコード自体はテストコード(prettier-plugin-liquid の test ディレクトリ配下)であり、実装には使わない。Prettier フォーマッティング規則を定義するプラグイン開発時の参照資料として活用する。
注意点
本項目はテストコード・仕様書であり、商用テーマに直接貼り付けるものではない。Liquid コード内で if・unless で HTML タグを分割配置する場合、Prettier で自動整形すると想定外の改行が入る可能性があるため、このテストケースを基に開発環境の Prettier 設定を調整する。printWidth や空白制御(`{%-` と `-%}` の使い分け)がフォーマット結果に大きく影響するので、チーム内で統一ルールを決めておく。
タグ:prettierliquid-pluginformatterhtml-tagcode-quality

コード

107 行 / liquid
It should pretty print dangling open tags inside if statements
printWidth: 1
{% if condition %}
  <div
    attr="value"
    other="{{ product.id }}"
  >
{% else -%}
  <product-wrapper
    id="{{ product.id }}"
  >
{%- endif %}

It should pretty print dangling open tags inside unless statements
printWidth: 1
{% unless condition -%}
  <product-wrapper
    attr="value"
    other="{{ product.id }}"
  >
{%- else %}
  <div
    id="{{ product.id }}"
  >
{% endunless %}

It should pretty print dangling close tags inside if statements
printWidth: 1
{% if condition %}
  </div>
{% else -%}
  </product-wrapper>
{%- endif %}

It should pretty print dangling close tags inside unless statements
printWidth: 1
{% unless condition %}
  </div>
{% else -%}
  </product-wrapper>
{%- endunless %}

It should allow two nodes as well, with indenting
printWidth: 1
{% if condition %}
  <div
    attr="value"
    other="{{ product.id }}"
  >
    <p
      attr="value"
    >
{% endif %}

It should allow unclosed nodes + closed nodes, with indenting
printWidth: 1
{% if condition %}
  <details>
    <summary>
      hello
    </summary>
{% endif %}

It should allow unclosed nodes + liquid, with indenting
printWidth: 1
{% if condition %}
  <details>
    {% render 'summary' %}
{% endif %}

It should allow dangling close nodes with flat nodes
printWidth: 1
{% if condition %}
  </details>
  {% render 'summary' %}
{% else %}
  {% render 'summary' %}
  </details>
{% endif %}

It should not add superfluous spaces for dangling opens
printWidth: 1
{% if condition %}
  <a>
{% endif %}

It should maintain space on dangling open without break
printWidth: 80
{% if condition %}<a> {% endif %}

It should format as expected, Dawn example...
printWidth: 80
<div>
  {%- if block.settings.make_collapsible_row -%}
    <details id="Details-{{ block.id }}-{{ section.id }}" open>
      <summary>
  {%- endif %}
  ...
  {%- if block.settings.make_collapsible_row -%}
    </summary>
  {%- endif %}
  ...
  {%- if block.settings.make_collapsible_row -%}
    </details>
  {%- endif %}
</div>

出典・ライセンス

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