Prettier: Support Param Type Formatting

Shopify · Dec 11, 2024 · 60f93b8 · 60f93b8
1 parent fc16617
commit 60f93b8
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 6 deletions.
diff --git a/packages/prettier-plugin-liquid/src/printer/print/liquid.ts b/packages/prettier-plugin-liquid/src/printer/print/liquid.ts
@@ -513,12 +513,21 @@ export function printLiquidDocParam(
   _args: LiquidPrinterArgs,
 ): Doc {
   const node = path.getValue();
-  return [
-    node.name,
-    ' ',
-    node.paramName.value,
-    node.paramDescription.value ? ' ' + node.paramDescription.value : '',
-  ];
+  const parts: Doc[] = ['@param'];
+
+  if (node.paramType.value) {
+    parts.push(' ', `{${node.paramType.value}}`);
+  }
+
+  if (node.paramName.value) {
+    parts.push(' ', node.paramName.value);
+  }
+
+  if (node.paramDescription.value) {
+    parts.push(' ', node.paramDescription.value);
+  }
+
+  return parts;
 }
 
 function innerLeadingWhitespace(node: LiquidTag | LiquidBranch) {

diff --git a/packages/prettier-plugin-liquid/src/test/liquid-doc/fixed.liquid b/packages/prettier-plugin-liquid/src/test/liquid-doc/fixed.liquid
@@ -12,3 +12,8 @@ It should trim whitespace between nodes
 {% doc %}
   @param paramName param with description
 {% enddoc %}
+
+It should format the param type
+{% doc %}
+  @param {string} paramName param with description
+{% enddoc %}
diff --git a/packages/prettier-plugin-liquid/src/test/liquid-doc/index.liquid b/packages/prettier-plugin-liquid/src/test/liquid-doc/index.liquid
@@ -12,3 +12,8 @@ It should trim whitespace between nodes
 {% doc %}
 @param paramName       param with description
 {% enddoc %}
+
+It should format the param type
+{% doc %}
+    @param      { string      }      paramName param with description
+{% enddoc %}