Provide default value for getLiquidDocDefinitionsForURI

Shopify · Jan 17, 2025 · b5fded2 · b5fded2
1 parent 15fc0db
commit b5fded2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/packages/theme-check-common/src/types.ts b/packages/theme-check-common/src/types.ts
@@ -298,6 +298,11 @@ type MetafieldDefinitionType = {
   name: string;
 };
 
+export type GetLiquidDocDefinitionsForURI = (
+  uri: string,
+  snippetName: string,
+) => Promise<LiquidDocDefinition>;
+
 export interface LiquidDocParameter {
   name: string;
   description: string | null;

diff --git a/packages/theme-language-server-common/src/hover/HoverProvider.ts b/packages/theme-language-server-common/src/hover/HoverProvider.ts
@@ -1,4 +1,5 @@
 import {
+  GetLiquidDocDefinitionsForURI,
   LiquidDocDefinition,
   MetafieldDefinitionMap,
   SourceCodeType,
@@ -32,10 +33,12 @@ export class HoverProvider {
     readonly getMetafieldDefinitions: (rootUri: string) => Promise<MetafieldDefinitionMap>,
     readonly getTranslationsForURI: GetTranslationsForURI = async () => ({}),
     readonly getSettingsSchemaForURI: GetThemeSettingsSchemaForURI = async () => [],
-    readonly getLiquidDocDefinitionsForURI: (
-      uri: string,
-      snippetName: string,
-    ) => Promise<LiquidDocDefinition>,
+    readonly getLiquidDocDefinitionsForURI: GetLiquidDocDefinitionsForURI = async (
+      _uri,
+      snippetName,
+    ) => ({
+      name: snippetName,
+    }),
   ) {
     const typeSystem = new TypeSystem(
       themeDocset,