Prevent rendering hover for snippet with no liquidDoc definition

Author: jamesmengo

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

@@ -54,10 +54,16 @@ describe('Module: RenderSnippetHoverProvider', async () => {
       );
     });
 
-    it('should return an H3 with snippet name if no LiquidDocDefinition found', async () => {
-      getSnippetDefinition = async () => ({ name: 'unknown-snippet' });
+    it('should return null if no LiquidDocDefinition found', async () => {
+      getSnippetDefinition = async () => ({ name: 'unknown-snippet', liquidDoc: undefined });
       provider = createProvider(getSnippetDefinition);
-      await expect(provider).to.hover(`{% render 'unknown-sni█ppet' %}`, '### unknown-snippet');
+      await expect(provider).to.hover(`{% render 'unknown-sni█ppet' %}`, null);
+    });
+
+    it('should return null if snippet is null', async () => {
+      getSnippetDefinition = async () => undefined;
+      provider = createProvider(getSnippetDefinition);
+      await expect(provider).to.hover(`{% render 'unknown-sni█ppet' %}`, null);
     });
 
     it('should return nothing if not in render tag', async () => {

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

@@ -32,19 +32,9 @@ export class RenderSnippetHoverProvider implements BaseHoverProvider {
       snippetName,
     );
 
-    if (!snippetDefinition) {
-      return null;
-    }
-
-    const liquidDoc = snippetDefinition.liquidDoc;
-
+    const liquidDoc = snippetDefinition?.liquidDoc;
     if (!liquidDoc) {
-      return {
-        contents: {
-          kind: 'markdown',
-          value: `### ${snippetDefinition.name}`,
-        },
-      };
+      return null;
     }
 
     const parts = [`### ${snippetDefinition.name}`];

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

@@ -9,7 +9,7 @@ describe('Unit: makeGetLiquidDocDefinitions', () => {
     return toSourceCode('/tmp/foo.liquid', code).ast as LiquidHtmlNode;
   }
 
-  it('should return name if no valid annotations are present in definition', async () => {
+  it('should return undefined if no renderable content is present', async () => {
     const ast = toAST(`
         {% doc %}
           just a description
@@ -18,12 +18,7 @@ describe('Unit: makeGetLiquidDocDefinitions', () => {
       `);
 
     const result = getSnippetDefinition(ast, 'product-card');
-    expect(result).to.deep.equal({
-      name: 'product-card',
-      liquidDoc: {
-        parameters: [],
-      },
-    });
+    expect(result).to.be.undefined;
   });
 
   it('should extract name, description and type from param annotations', async () => {
@@ -65,4 +60,15 @@ describe('Unit: makeGetLiquidDocDefinitions', () => {
       },
     });
   });
+
+  it('should return undefined if no renderable content is present', async () => {
+    const ast = toAST(`
+        {% doc %}
+          just a description (update this when we add description to renderable content)
+        {% enddoc %}
+      `);
+
+    const result = getSnippetDefinition(ast, 'product-card');
+    expect(result).to.be.undefined;
+  });
 });

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

@@ -27,7 +27,7 @@ export type LiquidDocParameter = {
 export function getSnippetDefinition(
   snippet: LiquidHtmlNode,
   snippetName: string,
-): SnippetDefinition {
+): SnippetDefinition | undefined {
   const parameters: LiquidDocParameter[] = visit<SourceCodeType.LiquidHtml, LiquidDocParameter>(
     snippet,
     {
@@ -41,10 +41,14 @@ export function getSnippetDefinition(
     },
   );
 
+  if (parameters.length === 0) {
+    return undefined;
+  }
+
   return {
     name: snippetName,
     liquidDoc: {
-      parameters: parameters,
+      parameters,
     },
   };
 }