Render snippet name on hover when file exists without liquidDoc definition

Author: jamesmengo

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

@@ -57,7 +57,7 @@ describe('Module: RenderSnippetHoverProvider', async () => {
     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' %}`, null);
+      await expect(provider).to.hover(`{% render 'unknown-sni█ppet' %}`, `### unknown-snippet`);
     });
 
     it('should return null if snippet is null', async () => {

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

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

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 undefined if no renderable content is present', async () => {
+  it('should return default snippet definition if no renderable content is present', async () => {
     const ast = toAST(`
         {% doc %}
           just a description
@@ -18,7 +18,12 @@ describe('Unit: makeGetLiquidDocDefinitions', () => {
       `);
 
     const result = getSnippetDefinition(ast, 'product-card');
-    expect(result).to.be.undefined;
+    expect(result).to.deep.equal({
+      name: 'product-card',
+      liquidDoc: {
+        parameters: [],
+      },
+    });
   });
 
   it('should extract name, description and type from param annotations', async () => {
@@ -60,15 +65,4 @@ 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 | undefined {
+): SnippetDefinition {
   const parameters: LiquidDocParameter[] = visit<SourceCodeType.LiquidHtml, LiquidDocParameter>(
     snippet,
     {
@@ -41,10 +41,6 @@ export function getSnippetDefinition(
     },
   );
 
-  if (parameters.length === 0) {
-    return undefined;
-  }
-
   return {
     name: snippetName,
     liquidDoc: {