Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Normalize param description in LiquidDoc #668

Draft
wants to merge 1 commit into
base: jm/liquid_desc_seperator
Choose a base branch
from
+14 −2
Draft

Normalize param description in LiquidDoc #668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/prettier-plugin-liquid/src/printer/print/liquid.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
}

Expand Down
5 changes: 5 additions & 0 deletions packages/prettier-plugin-liquid/src/test/liquid-doc/fixed.liquid
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
6 changes: 6 additions & 0 deletions packages/prettier-plugin-liquid/src/test/liquid-doc/index.liquid
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}

Loading