Liquid ブロックの改行時の空白処理
Prettier プラグインの Liquid フォーマッタで、if / form などの Liquid タグが改行時に不要な空白を自動削除・追加する仕様テスト。HTML 要素の空白感度、htmlWhitespaceSensitivity の設定値、親要素の性質に応じて処理を分岐させる。
コード
60 行 / 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 display is 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>
出典・ライセンス
- Repository:
- https://github.com/Shopify/theme-tools
- License:
- MIT
このコードは Shopify 著作の MIT ライセンスソースです。 原本の著作権は Shopify が保有します。日本語訳は ALSEL によるものです。
関連項目
コメント後の空白フォーマット
Liquid コメントタグの直後に改行や空白がある場合の正しいフォーマット例。prettier-plugin-liquid によるコード整形テストケース。
Liquidコメントのフォーマット
Liquid のコメントタグ直後に改行がある場合の正しいフォーマット例。prettier-plugin-liquid による自動整形テストケース。
セクション呼び出しの改行制御
{% sections %} タグの前後の空白制御(ホワイトスペース削除演算子 `{%-` と `-%}` の使い方)を示すサンプル。Prettier による Liquid コードフォーマットで改行が崩れないことを確認するテストケース。
Prettier フォーマッタの HTML リスト整形テスト
Prettier Liquid プラグインが HTML のリスト要素(ul / ol)をどのように整形・改行するかをテストするサンプルコード。短い行は1行、長い行は複数行に自動で分割される動作を検証する。
Vue.js属性のLiquid整形
Vue.js のディレクティブ(@click、:class など)を含む Liquid コードを Prettier で正しく整形するテストケース。spec 準拠の属性名を保持したまま、改行・インデント処理を行う。
sections タグのフォーマット
Liquid の sections タグ構文と、Prettier によるフォーマット時の動作を示すテストファイル。タグ名の直前・直後の空白や改行が保持される仕様を確認するサンプル。