Skip to content

Commit 4d6c5e4

Browse files
committed
Normalize param description in LiquidDoc
1 parent 846bc20 commit 4d6c5e4

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

packages/prettier-plugin-liquid/src/printer/print/liquid.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -524,10 +524,11 @@ export function printLiquidDocParam(
524524
}
525525

526526
if (node.paramDescription.value) {
527+
const normalizedDescription = node.paramDescription.value.replace(/\s+/g, ' ').trim();
527528
if (node.paramDescription.dashSeparated) {
528-
parts.push(' - ', node.paramDescription.value);
529+
parts.push(' - ', normalizedDescription);
529530
} else {
530-
parts.push(' ', node.paramDescription.value);
531+
parts.push(' ', normalizedDescription);
531532
}
532533
}
533534

packages/prettier-plugin-liquid/src/test/liquid-doc/fixed.liquid

+5
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,8 @@ It should format the param description with a dash separator
2222
{% doc %}
2323
@param paramName - param with description
2424
{% enddoc %}
25+
26+
It should normalize the param description
27+
{% doc %}
28+
@param paramName param with description
29+
{% enddoc %}

packages/prettier-plugin-liquid/src/test/liquid-doc/index.liquid

+6
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,9 @@ It should format the param description with a dash separator
2222
{% doc %}
2323
@param paramName - param with description
2424
{% enddoc %}
25+
26+
It should normalize the param description
27+
{% doc %}
28+
@param paramName param with description
29+
{% enddoc %}
30+

0 commit comments

Comments
 (0)