rebase with main

Author: EvilGenius13

packages/theme-language-server-common/src/hover/providers/RenderSnippetHoverProvider.spec.ts

@@ -17,30 +17,35 @@ describe('Module: RenderSnippetHoverProvider', async () => {
           description: 'The title of the product',
           type: 'string',
           required: true,
+          nodeType: 'param',
         },
         {
           name: 'border-radius',
           description: 'The border radius in px',
           type: 'number',
           required: false,
+          nodeType: 'param',
         },
         {
           name: 'no-type',
           description: 'This parameter has no type',
           type: null,
           required: true,
+          nodeType: 'param',
         },
         {
           name: 'no-description',
           description: null,
           type: 'string',
           required: true,
+          nodeType: 'param',
         },
         {
           name: 'no-type-or-description',
           description: null,
           type: null,
           required: true,
+          nodeType: 'param',
         },
       ],
       examples: [
@@ -61,7 +66,7 @@ describe('Module: RenderSnippetHoverProvider', async () => {
       provider = createProvider(async () => mockSnippetDefinition);
       await expect(provider).to.hover(
         `{% render 'product-car█d' %}`,
-        '### product-card\n\n**Parameters:**\n- `title`: string - The title of the product\n- `border-radius` (Optional): number - The border radius in px\n- `no-type` - This parameter has no type\n- `no-description`: string\n- `no-type-or-description`\n\n**Examples:**\n\`\`\`liquid\n{{ product }}\n\`\`\`',
+        '### product-card\n\n**Parameters:**\n- `title`: string - The title of the product\n- `border-radius` (Optional): number - The border radius in px\n- `no-type` - This parameter has no type\n- `no-description`: string\n- `no-type-or-description`\n\n**Examples:**\n```liquid{{ product }}```\n```liquid{{ product.title }}```',
       );
     });
 
@@ -92,12 +97,14 @@ describe('Module: RenderSnippetHoverProvider', async () => {
               description: 'The title of the product',
               type: 'string',
               required: true,
+              nodeType: 'param',
             },
             {
               name: 'border-radius',
               description: 'The border radius in px',
               type: 'number',
               required: false,
+              nodeType: 'param',
             },
           ],
         },

packages/theme-language-server-common/src/liquidDoc.spec.ts

@@ -49,36 +49,42 @@ describe('Unit: getSnippetDefinition', () => {
             description: 'The first param',
             type: 'String',
             required: true,
+            nodeType: 'param',
           },
           {
             name: 'secondParam',
             description: 'The second param',
             type: 'Number',
             required: true,
+            nodeType: 'param',
           },
           {
             name: 'optionalParam',
             description: 'The optional param',
             type: 'String',
             required: false,
+            nodeType: 'param',
           },
           {
             name: 'paramWithNoType',
             description: 'param with no type',
             type: null,
             required: true,
+            nodeType: 'param',
           },
           {
             name: 'paramWithOnlyName',
             description: null,
             type: null,
             required: true,
+            nodeType: 'param',
           },
           {
             name: 'paramWithNoDescription',
             description: null,
             type: 'Number',
             required: true,
+            nodeType: 'param',
           },
         ],
         examples: [],
@@ -151,6 +157,7 @@ describe('Unit: getSnippetDefinition', () => {
             name: 'product',
             description: 'The product',
             type: 'String',
+            required: true,
             nodeType: 'param',
           },
         ],

packages/theme-language-server-common/src/liquidDoc.ts

@@ -16,7 +16,7 @@ export type SnippetDefinition = {
 
 type LiquidDocDefinition = {
   parameters?: LiquidDocParameter[];
-  examples?: LiquidDocExample[]; //  I don't think we need an array but maybe we'll allow multiple examples
+  examples?: LiquidDocExample[];
 };
 
 interface LiquidDocNode {
@@ -28,7 +28,7 @@ export interface LiquidDocParameter extends LiquidDocNode {
   description: string | null;
   type: string | null;
   required: boolean;
-};
+}
 
 export interface LiquidDocExample extends LiquidDocNode {
   content: string;
@@ -39,17 +39,18 @@ export function getSnippetDefinition(
   snippet: LiquidHtmlNode,
   snippetName: string,
 ): SnippetDefinition {
-  const parameters: LiquidDocParameter[] = visit<SourceCodeType.LiquidHtml, LiquidDocParameter>(
-    snippet,
-    {
-      LiquidDocParamNode(node: LiquidDocParamNode) {
-        return {
-          name: node.paramName.value,
-          description: node.paramDescription?.value ?? null,
-          type: node.paramType?.value ?? null,
-          required: node.required,
-        };
-      },
+  const nodes: (LiquidDocParameter | LiquidDocExample)[] = visit<
+    SourceCodeType.LiquidHtml,
+    LiquidDocParameter | LiquidDocExample
+  >(snippet, {
+    LiquidDocParamNode(node: LiquidDocParamNode) {
+      return {
+        name: node.paramName.value,
+        description: node.paramDescription?.value ?? null,
+        type: node.paramType?.value ?? null,
+        required: node.required,
+        nodeType: 'param',
+      };
     },
     LiquidDocExampleNode(node: LiquidDocExampleNode) {
       return {