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

Liquid ドキュメント形式のコード整形テスト

Shopify Liquid で `@doc` タグを使ったドキュメンテーション形式のパース・フォーマッティング仕様を検証するテストセット。パラメータ型の正規化、説明文の整形、例示コードの改行処理など、ドキュメンテーション構文の統一化ルールをカバー。

用途
prettier-plugin-liquid を開発・メンテナンスするとき、Liquid コード内のドキュメンテーションコメント(@param、@example、@description など)が一貫した形式に整形されることを確認する。
設置場所
このファイル自体が Prettier プラグインのテストケースであり、直接テーマに貼り付けるコードではない。開発時に npm run test で実行し、各テストケースの期待値がドキュメント形式フォーマッタで正しく処理されるか検証する。
注意点
このファイルはテスト用であり、実運用テーマには不要。`@doc` タグ記法は Shopify 公式の Liquid 仕様ではなく、prettier-plugin-liquid が独自に導入した拡張構文であるため、テーマ内で使用する場合は Prettier 設定と liquidDocParamDash オプションの有無を事前に統一する。パラメータ型の角括弧(`[ ]` )は省略可能表記だが、パース時の整形ルールがテストで定義されているため、チーム内で同じバージョンの prettier-plugin-liquid を使用することが重要。
タグ:liquid-docprettierformattingtest-casedocumentation

コード

128 行 / liquid
It should indent the body
{% doc %}
  @param paramName - param with description
{% enddoc %}

It should trim whitespace between nodes
{% doc %}
  @param paramName - param with description
{% enddoc %}

It should normalize the param type
{% doc %}
  @param { string     } paramName - param with description
{% enddoc %}

It should format the param description with a dash separator
{% doc %}
  @param paramName  -   param with description
{% enddoc %}

It should respect the liquidDocParamDash option liquidDocParamDash: false
{% doc %}
  @param paramName  param with description
{% enddoc %}

It should normalize the param description
{% doc %}
  @param paramName - param           with                    description
{% enddoc %}

It should strip whitespace between optional param delimiters
{% doc %}
  @param [ paramName ] - param with description
{% enddoc %}

It should handle params with malformed optional delimiters
{% doc %}
  @param [missingTail - param with description
  @param missingHead - ] - param with description
  @param [too many words no desc]
  @param [too many words] - param with description
{% enddoc %}

It should keep single-line examples on the line it's written on
{% doc %}
  @example This is a valid example
  @example
  This is a valid example on the next line
{% enddoc %}

It should push multi-line examples to the next line
{% doc %}
  @example This is a valid example


  So is this without a newline
  See?
{% enddoc %}

It should remove empty lines at the end of the example content
{% doc %}
  @example
  Here is my content and a newline

{% enddoc %}

It should respect example content with param and description
{% doc %}
@param paramName - param with description
@example
This is a valid example
{% enddoc %}

It should allow multiple example nodes
{% doc %}
  @example
  First Example
  @example
  Second Example
{% enddoc %}

It should keep single-line description content on the line it's written on
{% doc %}
  @description This is a description
  @description
  This is another description on the next line
{% enddoc %}

It should push multi-line description content to the next line
{% doc %}
  @description This is a description


  This is another description on the next line
{% enddoc %}

It should add a space between a description tag and content
{% doc %}
  @descriptionThis is a description
{% enddoc %}

It should handle param, example, and description nodes
{% doc %}
  @description This is a description
  @param {String} paramName - param with description
  @example
  This is a valid example
{% enddoc %}

It should add padding between dissimilar nodes
{% doc %}
  @param {String} param1 - param with description
  @param {String} param2 - param with description
  @example
  This is a valid example
  @example
  This is another valid example
  @description This is a description
  @param {String} param3 - param with description
{% enddoc %}

It should not prepend an implicit description with an @description annotation
{% doc %}
This is an implicit description

  @description This is an explicit description
{% enddoc %}

出典・ライセンス

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