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

Liquid Prettier のテストケース(段落整形)

Liquid Prettier プラグインが HTML と Liquid タグの混在テキスト(段落)を適切に整形できるかを検証するテストスイート。行幅制限下での折り返し、インライン要素の空白維持、タグの改行処理などのシナリオを網羅している。

用途
Liquid Prettier の開発・保守時に、段落内の複雑な HTML・Liquid 構文が正しく整形されているか確認するため。テーマ開発者が実装するというより、プラグイン開発者向けのテストコード。
設置場所
このコードは Shopify theme-tools リポジトリのテストスイートなので、通常のテーマに貼り付けることはない。Prettier Liquid プラグインの単体テスト実行時に参照される。Prettier 設定で `printWidth` や `htmlWhitespaceSensitivity` 動作を検証する際の基準として使用する。
注意点
これはテストケースのみで実装コードではないため、ストア運用では直接利用できない。Prettier プラグインのバージョンアップ時に、このテストケースが全パスしているか確認してから本番環境にプラグインを適用する。`htmlWhitespaceSensitivity: "ignore"` や `printWidth: 20` など Prettier オプションの値を変更すると結果が変わるため、テーマの `.prettierrc` 設定と統一する。
タグ:prettierliquidformattertesthtml

コード

77 行 / liquid
|print-width--------------------------------------------------------------------|

it should maintain whitespace (or lack of thereof) in flow text.
<div>hello {{ name }}!</div>

it should break child html elements liquid prettier would for html
<span>
  Some&nbsp;<b>freeform</b>&nbsp;text
  <em
    >hello world that might span multiple lines. That's fine. It's a paragraph
    after all...</em
  >
  We can definitely deal with that.
</span>

it should break liquid tags on new lines when it has leading and trailing
whitespace because it prefers newlines
<div>
  More freeform text
  {%- if liquid -%}But with liquid instead.{%- endif -%}
  I wonder what this will look like {{ punctuation }}.
</div>

it should break child liquid tags on new lines
<div>
  If a child breaks, it breaks on a new line.
  {%- if liquid -%}
    <span>aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa</span>
  {%- endif -%}
  But the paragraph that <i>follows</i> keeps on going as before. If an
  <em>fits on the line line</em>, it flows inline. But it will
  <em>never open in the middle of a line and end on another</em>
</div>

it should maintain whitespace between inline elements
<h1>HELLO <span> WORLD </span></h1>

it should not maintain whitespace between inline elements with htmlWhitespaceSensitivity set to ignore
htmlWhitespaceSensitivity: "ignore"
<h1>
  HELLO
  <span>WORLD</span>
</h1>

if there arent whitespace on either side of the text, when it breaks it should
break on both sides
<p>
  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa (-
  {{- product.price -}}
  -)
</p>

it should behave like prettier/language-html
<p>
  Ipsum. Praesent scelerisque tortor a justo. Quisque consequat libero erat<em
    >product.price</em
  >ok
</p>

it should break parent and add WTC when the child breaks
<p>
  (-
  {%- if liquid -%}
    <span>aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa</span>
  {%- endif -%}
  -)
</p>

it should add wtc between liquid drop and span if the ifbreak breaks.
printWidth: 20
<p>
  {{ drop -}}
  <span
    >Lorem Ipsum</span
  >
</p>

出典・ライセンス

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