Added test cases and refactored some tests that create JSONLanguageService instances

Author: shoplando

.changeset/lazy-seas-collect.md

@@ -0,0 +1,5 @@
+---
+'@shopify/theme-language-server-common': minor
+---
+
+Added document linking inside schema tags, which enhances developer experience

packages/theme-language-server-common/src/json/JSONLanguageService.spec.ts

@@ -120,6 +120,7 @@ describe('Module: JSONLanguageService', () => {
       (uri: string) => Promise.resolve(uri.includes('tae') ? 'app' : 'theme'),
       () => Promise.resolve([]),
       async () => undefined,
+      async () => 'file:///test-root',
     );
 
     await jsonLanguageService.setup({

packages/theme-language-server-common/src/json/completions/providers/BlockTypeCompletionProvider.spec.ts

@@ -64,6 +64,7 @@ describe('Unit: BlockTypeCompletionProvider', () => {
       async () => 'theme',
       async () => blockNames,
       async () => undefined,
+      async () => 'file:///test-root',
     );
 
     await jsonLanguageService.setup({

packages/theme-language-server-common/src/json/documentLinks/DocumentLinksProvider.spec.ts

@@ -0,0 +1,141 @@
+import { beforeEach, describe, expect, it } from 'vitest';
+import { DocumentManager } from '../../documents';
+import { createJSONDocumentLinksVisitor } from './DocumentLinksProvider';
+import { toJSONAST, visit } from '@shopify/theme-check-common';
+import { URI } from 'vscode-uri';
+
+describe('JSON Document Links in Schema Tags', () => {
+  let documentManager: DocumentManager;
+  let rootUri: string;
+  let uriString: string;
+
+  beforeEach(() => {
+    documentManager = new DocumentManager();
+  });
+
+  it('should return document links for block types in schema tags', async () => {
+    uriString = 'file:///path/to/sections/header.liquid';
+    rootUri = 'file:///path/to/project';
+
+    const schemaContent = `
+      {
+        "name": "Header",
+        "blocks": [
+          { "type": "logo" },
+          { "type": "navigation" }
+        ]
+      }
+    `;
+
+    const liquidContent = `
+      <div>Header content</div>
+      
+      {% schema %}
+      ${schemaContent}
+      {% endschema %}
+    `;
+
+    documentManager.open(uriString, liquidContent, 1);
+
+    const textDocument = documentManager.get(uriString)!.textDocument;
+    const schemaOffset = liquidContent.indexOf(schemaContent);
+
+    const visitor = createJSONDocumentLinksVisitor(textDocument, URI.parse(rootUri), schemaOffset);
+    const ast = toJSONAST(schemaContent);
+
+    if (ast instanceof Error) throw ast;
+    const result = visit(ast, visitor);
+
+    expect(result).toHaveLength(2);
+    expect(result[0].target).toBe('file:///path/to/project/blocks/logo.liquid');
+    expect(result[1].target).toBe('file:///path/to/project/blocks/navigation.liquid');
+  });
+
+  it('should handle section types in schema tags', async () => {
+    uriString = 'file:///path/to/sections/main-collection.liquid';
+    rootUri = 'file:///path/to/project';
+
+    const schemaContent = `
+      {
+        "name": "Collection",
+        "blocks": [
+          {
+            "type": "text",
+            "settings": []
+          }
+        ],
+        "presets": [
+          {
+            "name": "Default",
+            "blocks": [
+              { "type": "text" }
+            ]
+          }
+        ]
+      }
+    `;
+
+    const liquidContent = `
+      <div>Collection content</div>
+      
+      {% schema %}
+      ${schemaContent}
+      {% endschema %}
+    `;
+
+    documentManager.open(uriString, liquidContent, 1);
+
+    const textDocument = documentManager.get(uriString)!.textDocument;
+    const schemaOffset = liquidContent.indexOf(schemaContent);
+
+    const visitor = createJSONDocumentLinksVisitor(textDocument, URI.parse(rootUri), schemaOffset);
+    const ast = toJSONAST(schemaContent);
+
+    if (ast instanceof Error) throw ast;
+    const result = visit(ast, visitor);
+
+    // Should find both block type references (in blocks array and in presets)
+    expect(result).toHaveLength(2);
+    expect(result[0].target).toBe('file:///path/to/project/blocks/text.liquid');
+    expect(result[1].target).toBe('file:///path/to/project/blocks/text.liquid');
+  });
+
+  it('should not create links for special block types in schema tags', async () => {
+    uriString = 'file:///path/to/sections/app-blocks.liquid';
+    rootUri = 'file:///path/to/project';
+
+    const schemaContent = `
+      {
+        "name": "App Blocks",
+        "blocks": [
+          { "type": "@app" },
+          { "type": "@theme" },
+          { "type": "custom-block" }
+        ]
+      }
+    `;
+
+    const liquidContent = `
+      <div>App blocks section</div>
+      
+      {% schema %}
+      ${schemaContent}
+      {% endschema %}
+    `;
+
+    documentManager.open(uriString, liquidContent, 1);
+
+    const textDocument = documentManager.get(uriString)!.textDocument;
+    const schemaOffset = liquidContent.indexOf(schemaContent);
+
+    const visitor = createJSONDocumentLinksVisitor(textDocument, URI.parse(rootUri), schemaOffset);
+    const ast = toJSONAST(schemaContent);
+
+    if (ast instanceof Error) throw ast;
+    const result = visit(ast, visitor);
+
+    // Should only create link for custom-block, not @app or @theme
+    expect(result).toHaveLength(1);
+    expect(result[0].target).toBe('file:///path/to/project/blocks/custom-block.liquid');
+  });
+});