Prettier support - dashSeperator

Shopify · Dec 11, 2024 · f68ce01 · f68ce01
1 parent 434b276
commit f68ce01
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 3 deletions.
diff --git a/packages/prettier-plugin-liquid/src/printer/print/liquid.ts b/packages/prettier-plugin-liquid/src/printer/print/liquid.ts
@@ -524,7 +524,11 @@ export function printLiquidDocParam(
   }
 
   if (node.paramDescription.value) {
-    parts.push(' ', node.paramDescription.value);
+    if (node.paramDescription.dashSeparated) {
+      parts.push(' - ', node.paramDescription.value);
+    } else {
+      parts.push(' ', node.paramDescription.value);
+    }
   }
 
   return parts;

diff --git a/packages/prettier-plugin-liquid/src/test/liquid-doc/fixed.liquid b/packages/prettier-plugin-liquid/src/test/liquid-doc/fixed.liquid
@@ -17,3 +17,8 @@ It should format 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 %}
diff --git a/packages/prettier-plugin-liquid/src/test/liquid-doc/index.liquid b/packages/prettier-plugin-liquid/src/test/liquid-doc/index.liquid
@@ -10,10 +10,15 @@ It should not dedent to root
 
 It should trim whitespace between nodes
 {% doc %}
-@param paramName       param with description
+@param paramName param with description
 {% enddoc %}
 
 It should format the param type
 {% doc %}
-    @param      { string      }      paramName param with description
+@param { string } paramName param with description
+{% enddoc %}
+
+It should format the param description with a dash separator
+{% doc %}
+@param paramName  -   param with description
 {% enddoc %}