Add basic prettier support for doc tag

Shopify · Dec 11, 2024 · 0f17fef · 0f17fef
1 parent 68227c4
commit 0f17fef
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 2 deletions.
diff --git a/packages/liquid-html-parser/src/stage-1-cst.ts b/packages/liquid-html-parser/src/stage-1-cst.ts
@@ -110,6 +110,7 @@ export interface ConcreteBasicNode<T> {
 export interface ConcreteLiquidDocParamNode
   extends ConcreteBasicNode<ConcreteNodeTypes.LiquidDocParamNode> {
   name: string;
+  value: string;
 }
 
 export interface ConcreteHtmlNodeBase<T> extends ConcreteBasicNode<T> {
@@ -1328,6 +1329,7 @@ function toLiquidDocAST(source: string, matchingSource: string, offset: number)
     paramNode: {
       type: ConcreteNodeTypes.LiquidDocParamNode,
       name: 0,
+      value: 2,
       locStart,
       locEnd,
       source,

diff --git a/packages/liquid-html-parser/src/stage-2-ast.ts b/packages/liquid-html-parser/src/stage-2-ast.ts
@@ -757,6 +757,7 @@ export interface TextNode extends ASTNode<NodeTypes.TextNode> {
 
 export interface LiquidDocParamNode extends ASTNode<NodeTypes.LiquidDocParamNode> {
   name: string;
+  value: string;
 }
 
 export interface ASTNode<T> {
@@ -1279,6 +1280,7 @@ function buildAst(
           name: node.name,
           position: position(node),
           source: node.source,
+          value: node.value,
         });
         break;
       }

diff --git a/packages/prettier-plugin-liquid/src/printer/print/liquid.ts b/packages/prettier-plugin-liquid/src/printer/print/liquid.ts
@@ -1,4 +1,4 @@
-import { NodeTypes, NamedTags, isBranchedTag } from '@shopify/liquid-html-parser';
+import { NodeTypes, NamedTags, isBranchedTag, RawMarkup } from '@shopify/liquid-html-parser';
 import { Doc, doc } from 'prettier';
 
 import {
@@ -490,6 +490,16 @@ export function printLiquidRawTag(
   return [blockStart, ...body, blockEnd];
 }
 
+export function printLiquidDoc(
+  path: AstPath<RawMarkup>,
+  _options: LiquidParserOptions,
+  print: LiquidPrinter,
+  _args: LiquidPrinterArgs,
+) {
+  const body = path.map((p: any) => print(p), 'nodes');
+  return [indent([hardline, body]), hardline];
+}
+
 function innerLeadingWhitespace(node: LiquidTag | LiquidBranch) {
   if (!node.firstChild) {
     if (node.isDanglingWhitespaceSensitive && node.hasDanglingWhitespace) {

diff --git a/packages/prettier-plugin-liquid/src/printer/printer-liquid-html.ts b/packages/prettier-plugin-liquid/src/printer/printer-liquid-html.ts
@@ -1,5 +1,6 @@
 import {
   getConditionalComment,
+  LiquidDocParamNode,
   NodeTypes,
   Position,
   RawMarkupKinds,
@@ -30,6 +31,7 @@ import {
   LiquidTag,
   LiquidVariableOutput,
   nonTraversableProperties,
+  RawMarkup,
   TextNode,
 } from '../types';
 import { assertNever } from '../utils';
@@ -40,6 +42,7 @@ import { printChildren } from './print/children';
 import { printElement } from './print/element';
 import {
   printLiquidBranch,
+  printLiquidDoc,
   printLiquidRawTag,
   printLiquidTag,
   printLiquidVariableOutput,
@@ -210,6 +213,10 @@ function printNode(
     }
 
     case NodeTypes.RawMarkup: {
+      if (node.parentNode?.name === 'doc') {
+        return printLiquidDoc(path as AstPath<RawMarkup>, options, print, args);
+      }
+
       const isRawMarkupIdentationSensitive = () => {
         switch (node.kind) {
           case RawMarkupKinds.typescript:
@@ -548,7 +555,7 @@ function printNode(
     }
 
     case NodeTypes.LiquidDocParamNode: {
-      return node.name;
+      return [node.name, ' ', node.value];
     }
 
     default: {

diff --git a/packages/prettier-plugin-liquid/src/test/liquid-doc/fixed.liquid b/packages/prettier-plugin-liquid/src/test/liquid-doc/fixed.liquid
@@ -0,0 +1,9 @@
+It should indent the body
+{% doc %}
+  @param body
+{% enddoc %}
+
+It should not dedent to root
+{% doc %}
+  @param body
+{% 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
@@ -0,0 +1,9 @@
+It should indent the body
+{% doc %}
+@param body
+{% enddoc %}
+
+It should not dedent to root
+{% doc %}
+    @param body
+{% enddoc %}
diff --git a/packages/prettier-plugin-liquid/src/test/liquid-doc/index.spec.ts b/packages/prettier-plugin-liquid/src/test/liquid-doc/index.spec.ts
@@ -0,0 +1,7 @@
+import { test } from 'vitest';
+import { assertFormattedEqualsFixed } from '../test-helpers';
+import * as path from 'path';
+
+test('Unit: liquid-doc', async () => {
+  await assertFormattedEqualsFixed(__dirname);
+});