🧰 ユーティリティ初級

Liquidコメントのフォーマット

Liquid のコメントタグ直後に改行がある場合の正しいフォーマット例。prettier-plugin-liquid による自動整形テストケース。

用途

テーマ開発時に Prettier でコードを自動整形するとき、コメント周りの空白がどう処理されるかを確認したいシーン。

設置場所

このスニペット自体はテストケースなため、実装ファイルではなく開発時の参考コード例として扱う。実装時は `{% comment %}` と `{% endcomment %}` の構文をそのまま theme.liquid や各セクション内で使用する。

注意点

Prettier 導入時に comment タグ直後の改行を自動削除・保持するかは設定に依存する。コメント内に複数行テキストがある場合、インデント調整が自動で入るため手動整形との差異に注意する。本番テーマでは不要なコメントは削除して容量を削減することを推奨。

タグ:commentformattingprettierwhitespacesyntax

コード

6 行 / liquid

it should format as expected when there's whitespace after the opening comment
{% comment %} 
This is a comment
{% endcomment %}
<p>hello, world!</p>

Source:: Shopify/theme-tools/packages/prettier-plugin-liquid/src/test/issue-144/index.liquid
Repository:: https://github.com/Shopify/theme-tools
License:: MIT

このコードは Shopify 著作の MIT ライセンスソースです。原本の著作権は Shopify が保有します。日本語訳は ALSEL によるものです。

Liquid コメントタグの直後に改行や空白がある場合の正しいフォーマット例。prettier-plugin-liquid によるコード整形テストケース。

{% sections %} タグの前後の空白制御（ホワイトスペース削除演算子 `{%-` と `-%}` の使い方）を示すサンプル。Prettier による Liquid コードフォーマットで改行が崩れないことを確認するテストケース。

Prettier Liquid プラグインが HTML のリスト要素（ul / ol）をどのように整形・改行するかをテストするサンプルコード。短い行は1行、長い行は複数行に自動で分割される動作を検証する。

Vue.js のディレクティブ（@click、:class など）を含む Liquid コードを Prettier で正しく整形するテストケース。spec 準拠の属性名を保持したまま、改行・インデント処理を行う。

Liquid の sections タグ構文と、Prettier によるフォーマット時の動作を示すテストファイル。タグ名の直前・直後の空白や改行が保持される仕様を確認するサンプル。

Liquid の範囲オブジェクト（0..1 などの形式）をテンプレート内で出力したときの挙動を確認するテストスニペット。整数範囲と文字列範囲の出力結果の違いを示す。