Merge pull request #668 from Shopify/jm/normalize_description

Normalize param description in LiquidDoc
Shopify · Dec 19, 2024 · 38b6f21 · 38b6f21
2 parents f4da6ca + ba1cf41
commit 38b6f21
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/packages/prettier-plugin-liquid/src/printer/print/liquid.ts b/packages/prettier-plugin-liquid/src/printer/print/liquid.ts
@@ -524,10 +524,11 @@ export function printLiquidDocParam(
   }
 
   if (node.paramDescription.value) {
+    const normalizedDescription = node.paramDescription.value.replace(/\s+/g, ' ').trim();
     if (node.paramDescription.dashSeparated) {
-      parts.push(' - ', node.paramDescription.value);
+      parts.push(' - ', normalizedDescription);
     } else {
-      parts.push(' ', node.paramDescription.value);
+      parts.push(' ', normalizedDescription);
     }
   }
 

diff --git a/packages/prettier-plugin-liquid/src/test/liquid-doc/fixed.liquid b/packages/prettier-plugin-liquid/src/test/liquid-doc/fixed.liquid
@@ -22,3 +22,8 @@ It should format the param description with a dash separator
 {% doc %}
   @param paramName - param with description
 {% enddoc %}
+
+It should normalize the param description
+{% 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
@@ -22,3 +22,9 @@ It should format the param description with a dash separator
 {% doc %}
 @param paramName  -   param with description
 {% enddoc %}
+
+It should normalize the param description
+{% doc %}
+@param paramName param          with                    description
+{% enddoc %}
+