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

Prettier Liquid プラグインの空白トリムテスト

Liquid タグが複数行に折り返された際に、空白文字の感度設定に応じて適切にホワイトスペーストリムコントロール(WTC)を挿入するかを判定するテストファイル。HTML 要素、Liquid タグ、Liquid ブランチ、段落内での空白処理ルールを網羅している。

用途
prettier-plugin-liquid でコード整形する際に、Liquid の `-` 修飾子による空白除去がどのケースで自動的に必要か、またはフォーマッタが何もしないかを検証するときに使用する。テーマ開発時の Prettier 統合テストの参考資料。
設置場所
theme-tools リポジトリの `packages/prettier-plugin-liquid/src/test/whitespace-trim-on-liquid-block-break/` ディレクトリに fixed.liquid として配置されている。Prettier プラグインのテストスイートの一部として Jest などで自動実行され、直接テーマ内には貼り付けない。
注意点
このファイルは formatter のテストケース集であり、実際のテーマコードではない。`htmlWhitespaceSensitivity` の設定値('strict' / 'ignore')や `printWidth` により WTC の挿入ルールが変わるため、プロジェクトの prettier 設定を確認してからプラグイン動作を参考にする。`display: inline` コメントは CSS フレームワーク側の定義と連動するため、カスタムテーマで応用するときは実際の HTML 構造とスタイルを検証する必要がある。
タグ:prettierliquid-formattingwhitespace-controlplugintest-case

コード

93 行 / liquid
|print-width--------------------------------------------------------------------|

In HTMLElement children array,

it should add wtc if the liquid tag breaks on a new line and its children are whitespace sensitive and there wasn't whitespace to begin with
<div>
  {% if condition -%}
    aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
  {%- endif %}
</div>

it should add wtc if the liquid tag breaks on a new line, the node is
leading/trailing space sensitive, and there was no leading/trailing whitespace
<span>
  {%- if condition -%}
    aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
  {%- endif -%}
</span>

<div>
  <img>
  {%- if condition %}aaaaaa{% endif %}
</div>

it should not add wtc if the liquid drop breaks on a new line and the
previous/next characters were spaces
<div>
  {% if condition %}
    aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
  {% endif %}
</div>

--------------------------------------------------------------------------------

In LiquidTag children array,

If it breaks and the htmlWhitespaceSensitivity is 'strict', then add whitespace stripping
htmlWhitespaceSensitivity: 'strict'
printWidth: 30
{% form 'cart' -%}
  aaaaaaaaaaaa
{%- endform %}

If it breaks and the htmlWhitespaceSensitivity is 'ignore', then omit whitespace stripping
htmlWhitespaceSensitivity: "ignore"
printWidth: 30
{% if A %}
  aaaaaaaaaaaa
{% endif %}

If it breaks and the node is display: inline add whitespace stripping
printWidth: 30
<!-- display: inline -->
{% form 'cart' -%}
  aaaaaaaaaaaa
{%- endform %}

When it does break, there was a whitespace, and the parent is not
leading/trailing space sensitive, it should not change anything
{% form 'cart' %}
  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
{% endform %}

--------------------------------------------------------------------------------

In LiquidBranch children array,

when it does break and there was a whitespace, it should not change anything
{% if true %}
  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
{% endif %}

when it does break and there wasn't whitespace, it should add WTCs
{% if true -%}
  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
{%- endif %}

--------------------------------------------------------------------------------

In paragraphs,

it should add wtc if the liquid drop breaks next to a character (but not if not)
<div>
  Hey
  {% if true %}
    buddyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
  {%- endif -%}
  , how are you doing? boo
  {%- if true -%}
    oooooooooooooooooooooooooooooooooooooooooooooooooooooooooom!
  {%- 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