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

Prettier Liquid フォーマッタのテストケース

Liquid コードのフォーマット規則を検証するテストセット。フィルタチェーン、名前付き引数、位置引数の混在、複数の引数型(文字列、数値、範囲、真偽値)に対応し、printWidth に応じた改行・インデント・スペース挿入の動作を確認する。

用途
Prettier Liquid プラグインの開発・保守時に、フォーマット機能が仕様通りに動作しているかを単体テストで検証するため。
設置場所
packages/prettier-plugin-liquid/src/test/liquid-drop-filters/ ディレクトリ内に index.liquid として配置し、テストランナー(Jest 等)で `index.liquid` を読み込んでフォーマット結果を期待値と照合する。
注意点
このコードはテストケース集合であり、実際のストアテーマには使用しない。各テストケースの `printWidth` は Prettier の設定値を上書きしており、実運用では設定ファイル(.prettierrc)の値に統一する必要がある。末尾のカンマ削除(split の例)など、エディタやプラグインのバージョンによって実装が異なる場合があるため、プラグイン更新時に回帰テストを実施する。
タグ:prettierformatterliquid-syntaxcode-qualityfilter-chain

コード

59 行 / liquid
It should never break a name
printWidth: 1
{{ x }}

It should break before/after delimiters and indent everything
printWidth: 1
{{ x | filter1 | filter2 }}

It should break and indent named arguments
printWidth: 1
{{ x | filter1: key1: value1, key2: value2 | filter2 }}

It should not break the first positional argument
printWidth: 1
{{ x | filter1: arg1 | filter2: arg2, arg3, arg4 }}

It should break arguments only if necessary
printWidth: 40
{{ x | filter1: key1: value1, key2: value2 | filter2 }}

It should support a mix of positional and named arguments as expected (p1)
printWidth: 1
{{ x | filter1: pos1, pos2, key1: val1, key2: val2 }}

It should support a mix of positional and named arguments as expected (p50)
printWidth: 50
{{ x | filter1: pos1, pos2, key1: val1, key2: val2 }}

It should support a mix of positional and named arguments as expected (p80)
printWidth: 80
{{ x | filter1: pos1, pos2, key1: val1, key2: val2 }}

It should support all types of arguments, and add spaces
{{ x|f:'string' }}
{{ x|f:"string" }}
{{ x|f:0.0 }}
{{ x|f:0 }}
{{ x|f:x }}
{{ x|f:(0..a) }}
{{ x|f:true }}

It should support all types of named arguments, and add spaces
{{ x|f:key:'string' }}
{{ x|f:key:"string" }}
{{ x|f:key:0.0 }}
{{ x|f:key:0 }}
{{ x|f:key:x }}
{{ x|f:key:(0..a) }}
{{ x|f:key:true }}

It should support spaces or lack of thereof erywhere
{{ x|f:
a    :  b  , range
: ( a .. b)
}}

It should strip trailing commas by default
{{x|split:'',}}

出典・ライセンス

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