stage2 tests and prettier support functioning

Shopify · Jan 15, 2025 · 8db22b5 · 8db22b5
1 parent 1b4763c
commit 8db22b5
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 2 deletions.
diff --git a/packages/liquid-html-parser/src/stage-2-ast.spec.ts b/packages/liquid-html-parser/src/stage-2-ast.spec.ts
@@ -1258,6 +1258,43 @@ describe('Unit: Stage 2 (AST)', () => {
       expectPath(ast, 'children.0.body.nodes.2.value').to.eql(
         '@unsupported this node falls back to a text node',
       );
+
+      ast = toLiquidAST(`
+        {% doc -%}
+        @example
+        This is a valid example
+        {%- enddoc %}
+      `);
+      expectPath(ast, 'children.0.type').to.eql('LiquidRawTag');
+      expectPath(ast, 'children.0.name').to.eql('doc');
+      expectPath(ast, 'children.0.body.nodes.0.name').to.eql('example');
+      expectPath(ast, 'children.0.body.nodes.0.type').to.eql('LiquidDocExampleNode');
+      expectPath(ast, 'children.0.body.nodes.0.exampleContent.type').to.eql('TextNode');
+      expectPath(ast, 'children.0.body.nodes.0.exampleContent.value').to.eql(
+        'This is a valid example',
+      );
+
+      ast = toLiquidAST(`
+        {% doc -%}
+        @example
+        This is a valid example
+        It can have multiple lines
+        @param {String} paramWithDescription - param with description
+        {% enddoc %}
+      `);
+      expectPath(ast, 'children.0.type').to.eql('LiquidRawTag');
+      expectPath(ast, 'children.0.name').to.eql('doc');
+      expectPath(ast, 'children.0.body.nodes.0.type').to.eql('LiquidDocExampleNode');
+      expectPath(ast, 'children.0.body.nodes.0.name').to.eql('example');
+      expectPath(ast, 'children.0.body.nodes.0.exampleContent.value').to.eql(
+        'This is a valid example\nIt can have multiple lines',
+      );
+      expectPath(ast, 'children.0.body.nodes.1.type').to.eql('LiquidDocParamNode');
+      expectPath(ast, 'children.0.body.nodes.1.name').to.eql('param');
+      expectPath(ast, 'children.0.body.nodes.1.paramName.value').to.eql('paramWithDescription');
+      expectPath(ast, 'children.0.body.nodes.1.paramDescription.value').to.eql(
+        'param with description',
+      );
     });
 
     it('should parse unclosed tables with assignments', () => {

diff --git a/packages/liquid-html-parser/src/stage-2-ast.ts b/packages/liquid-html-parser/src/stage-2-ast.ts
@@ -1314,7 +1314,11 @@ function buildAst(
           source: node.source,
           exampleContent: {
             type: NodeTypes.TextNode,
-            value: node.exampleContent.value,
+            value: node.exampleContent.value
+            .split('\n')
+            .map(line => line.trim())
+            .filter(Boolean)
+            .join('\n'),
             position: position(node.exampleContent),
             source: node.exampleContent.source,
           },

diff --git a/packages/prettier-plugin-liquid/src/printer/print/liquid.ts b/packages/prettier-plugin-liquid/src/printer/print/liquid.ts
@@ -544,7 +544,12 @@ export function printLiquidDocExample(
   _args: LiquidPrinterArgs,
 ): Doc {
   const node = path.getValue();
-  const parts: Doc[] = ['@example', 'asdf'];
+  const parts: Doc[] = ['@example'];
+
+  if (node.exampleContent?.value.trim()) {
+    parts.push(hardline);
+    parts.push(join(hardline, node.exampleContent.value.split('\n')));
+  }
 
   return parts;
 }