@platformos/platformos-language-server-common 0.0.7 → 0.0.8

package/src/json/JSONLanguageService.ts

@@ -1,15 +1,9 @@
-import { LiquidRawTag, NodeTypes } from '@platformos/liquid-html-parser';
 import {
   IsValidSchema,
   JsonValidationSet,
-  Mode,
-  Modes,
   SchemaDefinition,
   SourceCodeType,
-  findCurrentNode,
   isValid,
-  toJSONAST,
-  visit,
 } from '@platformos/platformos-check-common';
 import { JSONDocument, LanguageService, getLanguageService } from 'vscode-json-languageservice';
 import {
@@ -24,21 +18,12 @@ import {
 } from 'vscode-languageserver';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import { DocumentManager } from '../documents';
-import { GetTranslationsForURI } from '../translations';
-import { JSONContributions, GetThemeBlockNames, GetThemeBlockSchema } from './JSONContributions';
-import { createJSONDocumentLinksVisitor } from './documentLinks/DocumentLinksProvider';
-import { URI } from 'vscode-uri';
-import { FindThemeRootURI } from '../internal-types';
+import { JSONContributions } from './JSONContributions';
 
 export class JSONLanguageService {
-  // We index by Mode here because I don't want to reconfigure the service depending on the URI.
-  // This is because you may be in a "app" context in one folder, and in a "theme" context in another one.
-  // Because theme app extensions and themes do not share a common JSON schema for blocks/*.liquid files,
-  // we need to do this switch on mode here to figure out which language service we will use to power
-  // completions/hover. The mode comes from the theme check config.
-  private services: Record<Mode, LanguageService | null>;
-
-  // One record for all modes since collisions on URIs should point to the same schema
+  private service: LanguageService | null = null;
+
+  // One record for all schemas since collisions on URIs should point to the same schema
   private schemas: Record<string, SchemaDefinition>;
 
   // Setup state
@@ -48,13 +33,7 @@ export class JSONLanguageService {
   constructor(
     private documentManager: DocumentManager,
     private jsonValidationSet: JsonValidationSet,
-    private getDefaultSchemaTranslations: GetTranslationsForURI,
-    private getModeForURI: (uri: string) => Promise<Mode>,
-    private getThemeBlockNames: GetThemeBlockNames,
-    private getThemeBlockSchema: GetThemeBlockSchema,
-    private findThemeRootURI: FindThemeRootURI,
   ) {
-    this.services = Object.fromEntries(Modes.map((mode) => [mode, null])) as typeof this.services;
     this.schemas = {};
     this.initialized = new Promise((resolve) => {
       this.initialize = resolve;
@@ -62,14 +41,12 @@ export class JSONLanguageService {
   }
 
   async setup(clientCapabilities: LSPClientCapabilities) {
-    const promises = Modes.map(async (mode) => {
-      const schemas = await this.jsonValidationSet.schemas(mode);
-      for (const schema of schemas) {
-        this.schemas[schema.uri] = schema;
-      }
-
-      if (!schemas.length) return;
+    const schemas = await this.jsonValidationSet.schemas();
+    for (const schema of schemas) {
+      this.schemas[schema.uri] = schema;
+    }
 
+    if (schemas.length) {
       const service = getLanguageService({
         clientCapabilities,
 
@@ -86,14 +63,7 @@ export class JSONLanguageService {
           },
         },
 
-        contributions: [
-          new JSONContributions(
-            this.documentManager,
-            this.getDefaultSchemaTranslations,
-            this.getThemeBlockNames,
-            this.getThemeBlockSchema,
-          ),
-        ],
+        contributions: [new JSONContributions(this.documentManager)],
       });
 
       service.configure({
@@ -106,17 +76,15 @@ export class JSONLanguageService {
         })),
       });
 
-      this.services[mode] = service;
-    });
+      this.service = service;
+    }
 
-    await Promise.all(promises);
     this.initialize();
   }
 
   async completions(params: CompletionParams): Promise<null | CompletionList | CompletionItem[]> {
     await this.initialized;
-    const mode = await this.getModeForURI(params.textDocument.uri);
-    const service = this.services[mode];
+    const service = this.service;
     if (!service) return null;
     const documents = this.getDocuments(params, service);
     if (!documents) return null;
@@ -126,8 +94,7 @@ export class JSONLanguageService {
 
   async hover(params: HoverParams): Promise<Hover | null> {
     await this.initialized;
-    const mode = await this.getModeForURI(params.textDocument.uri);
-    const service = this.services[mode];
+    const service = this.service;
     if (!service) return null;
     const documents = this.getDocuments(params, service);
     if (!documents) return null;
@@ -135,52 +102,13 @@ export class JSONLanguageService {
     return service.doHover(jsonTextDocument, params.position, jsonDocument);
   }
 
-  async documentLinks(params: DocumentLinkParams): Promise<DocumentLink[]> {
-    await this.initialized;
-    const rootUri = await this.findThemeRootURI(params.textDocument.uri);
-    if (!rootUri) return [];
-
-    const document = this.documentManager.get(params.textDocument.uri);
-    if (!document) return [];
-
-    switch (document.type) {
-      case SourceCodeType.JSON: {
-        if (document.ast instanceof Error) return [];
-        const visitor = await createJSONDocumentLinksVisitor(
-          document.textDocument,
-          URI.parse(rootUri),
-        );
-        return visit(document.ast, visitor);
-      }
-
-      case SourceCodeType.LiquidHtml: {
-        if (document.ast instanceof Error) return [];
-        const textDocument = document.textDocument;
-        const links: DocumentLink[] = [];
-
-        const schema = await document.getSchema();
-        if (schema && !(schema.ast instanceof Error)) {
-          const visitor = await createJSONDocumentLinksVisitor(
-            textDocument,
-            URI.parse(rootUri),
-            schema.offset,
-          );
-          const schemaLinks = await visit(schema.ast, visitor);
-          links.push(...schemaLinks);
-        }
-
-        return links;
-      }
-
-      default:
-        return [];
-    }
+  async documentLinks(_params: DocumentLinkParams): Promise<DocumentLink[]> {
+    return [];
   }
 
   public isValidSchema = async (uri: string, jsonString: string) => {
     await this.initialized;
-    const mode = await this.getModeForURI(uri);
-    const service = this.services[mode];
+    const service = this.service;
     if (!service) return false;
     return isValid(service, uri, jsonString);
   };
@@ -194,40 +122,14 @@ export class JSONLanguageService {
 
     switch (document.type) {
       case SourceCodeType.GraphQL:
+      case SourceCodeType.LiquidHtml:
+      case SourceCodeType.YAML:
         return null;
       case SourceCodeType.JSON: {
         const jsonTextDocument = document.textDocument;
         const jsonDocument = service.parseJSONDocument(jsonTextDocument);
         return [jsonTextDocument, jsonDocument];
       }
-
-      case SourceCodeType.LiquidHtml: {
-        if (document.ast instanceof Error) return null;
-        const textDocument = document.textDocument;
-        const offset = textDocument.offsetAt(params.position);
-        const [_, ancestors] = findCurrentNode(document.ast, offset);
-        const schema = ancestors.find(
-          (node): node is LiquidRawTag =>
-            node.type === NodeTypes.LiquidRawTag && node.name === 'schema',
-        );
-        if (!schema) return null;
-
-        const schemaLineNumber = textDocument.positionAt(schema.blockStartPosition.end).line;
-        // Hacking away "same line numbers" here by prefixing the file with newlines
-        // This way params.position will be at the same line number in this fake jsonTextDocument
-        // Which means that the completions will be at the same line number in the Liquid document
-        const jsonString =
-          Array(schemaLineNumber).fill('\n').join('') +
-          schema.source.slice(schema.blockStartPosition.end, schema.blockEndPosition.start);
-        const jsonTextDocument = TextDocument.create(
-          textDocument.uri,
-          'json',
-          textDocument.version,
-          jsonString,
-        );
-        const jsonDocument = service.parseJSONDocument(jsonTextDocument);
-        return [jsonTextDocument, jsonDocument];
-      }
     }
   }
 

package/src/json/test/test-helpers.ts

@@ -5,10 +5,7 @@ import {
   HoverParams,
 } from 'vscode-languageserver-protocol';
 import { DocumentManager } from '../../documents';
-import { GetThemeBlockNames } from '../JSONContributions';
 import { JSONLanguageService } from '../JSONLanguageService';
-import { SourceCodeType } from '@platformos/platformos-check-common';
-import { GetTranslationsForURI } from '../../translations';
 
 export function getRequestParams(
   documentManager: DocumentManager,
@@ -33,36 +30,8 @@ export function isCompletionList(
   return completions !== null && !Array.isArray(completions);
 }
 
-export function mockJSONLanguageService(
-  rootUri: string,
-  documentManager: DocumentManager,
-  getDefaultSchemaTranslations: GetTranslationsForURI = async () => ({}),
-  getThemeBlockNames: GetThemeBlockNames = async () => [],
-) {
-  return new JSONLanguageService(
-    documentManager,
-    {
-      schemas: async () => [
-        {
-          uri: 'https://shopify.dev/block-schema.json',
-          schema: JSON.stringify({
-            $schema: 'http://json-schema.org/draft-07/schema#',
-          }),
-          fileMatch: ['**/{blocks,sections}/*.liquid'],
-        },
-      ],
-    },
-    getDefaultSchemaTranslations,
-    async () => 'theme',
-    getThemeBlockNames,
-    async (_uri: string, name: string) => {
-      const blockUri = `${rootUri}/blocks/${name}.liquid`;
-      const doc = documentManager.get(blockUri);
-      if (!doc || doc.type !== SourceCodeType.LiquidHtml) {
-        return;
-      }
-      return doc.getSchema();
-    },
-    async () => rootUri,
-  );
+export function mockJSONLanguageService(_rootUri: string, documentManager: DocumentManager) {
+  return new JSONLanguageService(documentManager, {
+    schemas: async () => [],
+  });
 }

package/src/json/utils.ts

@@ -1,30 +1,3 @@
-import { LiquidHtmlNode, LiquidRawTag } from '@platformos/liquid-html-parser';
-import { SourceCodeType, visit, Visitor } from '@platformos/platformos-check-common';
-
 export function fileMatch(uri: string, patterns: RegExp[]): boolean {
   return patterns.some((pattern) => pattern.test(uri));
 }
-
-export function isSectionFile(uri: string): boolean {
-  return /\/sections\/[^/]*\.liquid$/.test(uri);
-}
-
-export function isBlockFile(uri: string): boolean {
-  return /\/blocks\/[^/]*\.liquid$/.test(uri);
-}
-
-export function isSectionOrBlockFile(uri: string): boolean {
-  return isSectionFile(uri) || isBlockFile(uri);
-}
-
-export async function findSchemaNode(ast: LiquidHtmlNode): Promise<LiquidRawTag | undefined> {
-  const nodes = await visit(ast, {
-    async LiquidRawTag(node) {
-      if (node.name === 'schema') {
-        return node;
-      }
-    },
-  } as Visitor<SourceCodeType.LiquidHtml, LiquidRawTag>);
-
-  return nodes[0];
-}

package/src/rename/RenameProvider.ts

@@ -14,7 +14,7 @@ import { HtmlTagNameRenameProvider } from './providers/HtmlTagNameRenameProvider
 import { LiquidVariableRenameProvider } from './providers/LiquidVariableRenameProvider';
 import { Connection } from 'vscode-languageserver';
 import { ClientCapabilities } from '../ClientCapabilities';
-import { FindThemeRootURI } from '../internal-types';
+import { FindAppRootURI } from '../internal-types';
 
 /**
  * RenameProvider is responsible for providing rename support for the theme language server.
@@ -28,7 +28,7 @@ export class RenameProvider {
     connection: Connection,
     clientCapabilities: ClientCapabilities,
     private documentManager: DocumentManager,
-    findThemeRootURI: FindThemeRootURI,
+    findAppRootURI: FindAppRootURI,
   ) {
     this.providers = [
       new HtmlTagNameRenameProvider(documentManager),
@@ -36,7 +36,7 @@ export class RenameProvider {
         connection,
         clientCapabilities,
         documentManager,
-        findThemeRootURI,
+        findAppRootURI,
       ),
     ];
   }

package/src/rename/providers/LiquidVariableRenameProvider.spec.ts

@@ -10,7 +10,7 @@ const mockRoot = 'file:';
 
 describe('LiquidVariableRenameProvider', () => {
   const textDocumentUri = `${mockRoot}///app/views/partials/example-partial.liquid`;
-  const findThemeRootURI = async () => mockRoot;
+  const findAppRootURI = async () => mockRoot;
 
   let capabilities: ClientCapabilities;
   let connection: MockConnection;
@@ -39,7 +39,7 @@ describe('LiquidVariableRenameProvider', () => {
 
     beforeEach(() => {
       documentManager = new DocumentManager();
-      provider = new RenameProvider(connection, capabilities, documentManager, findThemeRootURI);
+      provider = new RenameProvider(connection, capabilities, documentManager, findAppRootURI);
 
       textDocument = TextDocument.create(textDocumentUri, 'liquid', 1, documentSource);
       documentManager.open(textDocument.uri, documentSource, 1);
@@ -198,7 +198,7 @@ describe('LiquidVariableRenameProvider', () => {
 
     beforeEach(() => {
       documentManager = new DocumentManager();
-      provider = new RenameProvider(connection, capabilities, documentManager, findThemeRootURI);
+      provider = new RenameProvider(connection, capabilities, documentManager, findAppRootURI);
     });
 
     ['for', 'tablerow'].forEach((tag) => {
@@ -371,7 +371,7 @@ describe('LiquidVariableRenameProvider', () => {
       );
 
       documentManager = new DocumentManager();
-      provider = new RenameProvider(connection, capabilities, documentManager, findThemeRootURI);
+      provider = new RenameProvider(connection, capabilities, documentManager, findAppRootURI);
 
       documentManager.open(textDocumentUri, textDocument.getText(), 1);
     });

package/src/rename/providers/LiquidVariableRenameProvider.ts

@@ -30,7 +30,7 @@ import {
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import { ClientCapabilities } from '../../ClientCapabilities';
 import { AugmentedLiquidSourceCode, DocumentManager, isLiquidSourceCode } from '../../documents';
-import { FindThemeRootURI } from '../../internal-types';
+import { FindAppRootURI } from '../../internal-types';
 import { partialName } from '../../utils/uri';
 import { BaseRenameProvider } from '../BaseRenameProvider';
 
@@ -39,7 +39,7 @@ export class LiquidVariableRenameProvider implements BaseRenameProvider {
     private connection: Connection,
     private clientCapabilities: ClientCapabilities,
     private documentManager: DocumentManager,
-    private findThemeRootURI: FindThemeRootURI,
+    private findAppRootURI: FindAppRootURI,
   ) {}
 
   async prepare(
@@ -74,7 +74,7 @@ export class LiquidVariableRenameProvider implements BaseRenameProvider {
     params: RenameParams,
   ): Promise<null | WorkspaceEdit> {
     const document = this.documentManager.get(params.textDocument.uri);
-    const rootUri = await this.findThemeRootURI(params.textDocument.uri);
+    const rootUri = await this.findAppRootURI(params.textDocument.uri);
     const textDocument = document?.textDocument;
 
     if (!rootUri || !textDocument || !node || !ancestors) return null;
@@ -104,7 +104,7 @@ export class LiquidVariableRenameProvider implements BaseRenameProvider {
     });
 
     if (this.clientCapabilities.hasApplyEditSupport && liquidDocParamUpdated) {
-      const themeFiles = this.documentManager.theme(rootUri, true);
+      const themeFiles = this.documentManager.app(rootUri, true);
       const liquidSourceCodes = themeFiles.filter(isLiquidSourceCode);
       const name = partialName(params.textDocument.uri);
 

package/src/renamed/RenameHandler.ts

@@ -2,11 +2,9 @@ import { Connection } from 'vscode-languageserver';
 import { RenameFilesParams } from 'vscode-languageserver-protocol';
 import { ClientCapabilities } from '../ClientCapabilities';
 import { DocumentManager } from '../documents';
-import { FindThemeRootURI } from '../internal-types';
+import { FindAppRootURI } from '../internal-types';
 import { BaseRenameHandler } from './BaseRenameHandler';
 import { AssetRenameHandler } from './handlers/AssetRenameHandler';
-import { BlockRenameHandler } from './handlers/BlockRenameHandler';
-import { SectionRenameHandler } from './handlers/SectionRenameHandler';
 import { PartialRenameHandler } from './handlers/PartialRenameHandler';
 
 /**
@@ -15,7 +13,6 @@ import { PartialRenameHandler } from './handlers/PartialRenameHandler';
  * Stuff we'll handle:
  * - When a partial is renamed, then we'll change all the render calls
  * - When an asset is renamed, then we'll change the asset_url calls
- * - etc.
  */
 export class RenameHandler {
   private handlers: BaseRenameHandler[];
@@ -23,13 +20,11 @@ export class RenameHandler {
     connection: Connection,
     capabilities: ClientCapabilities,
     documentManager: DocumentManager,
-    findThemeRootURI: FindThemeRootURI,
+    findAppRootURI: FindAppRootURI,
   ) {
     this.handlers = [
-      new PartialRenameHandler(documentManager, connection, capabilities, findThemeRootURI),
-      new AssetRenameHandler(documentManager, connection, capabilities, findThemeRootURI),
-      new BlockRenameHandler(documentManager, connection, capabilities, findThemeRootURI),
-      new SectionRenameHandler(documentManager, connection, capabilities, findThemeRootURI),
+      new PartialRenameHandler(documentManager, connection, capabilities, findAppRootURI),
+      new AssetRenameHandler(documentManager, connection, capabilities, findAppRootURI),
     ];
   }
 

package/src/renamed/handlers/AssetRenameHandler.spec.ts

@@ -10,7 +10,7 @@ import { RenameHandler } from '../RenameHandler';
 
 describe('Module: AssetRenameHandler', () => {
   const mockRoot = 'mock-fs:';
-  const findThemeRootURI = async () => mockRoot;
+  const findAppRootURI = async () => mockRoot;
   let capabilities: ClientCapabilities;
   let documentManager: DocumentManager;
   let handler: RenameHandler;
@@ -29,7 +29,7 @@ describe('Module: AssetRenameHandler', () => {
       mockRoot,
     );
     documentManager = new DocumentManager(fs);
-    handler = new RenameHandler(connection, capabilities, documentManager, findThemeRootURI);
+    handler = new RenameHandler(connection, capabilities, documentManager, findAppRootURI);
   });
 
   describe('when the client does not support workspace/applyEdit', () => {
@@ -182,7 +182,7 @@ describe('Module: AssetRenameHandler', () => {
         'mock-fs:',
       );
       documentManager = new DocumentManager(fs);
-      handler = new RenameHandler(connection, capabilities, documentManager, findThemeRootURI);
+      handler = new RenameHandler(connection, capabilities, documentManager, findAppRootURI);
 
       await handler.onDidRenameFiles({
         files: [

package/src/renamed/handlers/AssetRenameHandler.ts

@@ -12,7 +12,7 @@ import { ClientCapabilities } from '../../ClientCapabilities';
 import { DocumentManager, isLiquidSourceCode } from '../../documents';
 import { assetName, isAsset } from '../../utils/uri';
 import { BaseRenameHandler } from '../BaseRenameHandler';
-import { FindThemeRootURI } from '../../internal-types';
+import { FindAppRootURI } from '../../internal-types';
 
 /**
  * The AssetRenameHandler will handle asset renames.
@@ -31,7 +31,7 @@ export class AssetRenameHandler implements BaseRenameHandler {
     private documentManager: DocumentManager,
     private connection: Connection,
     private capabilities: ClientCapabilities,
-    private findThemeRootURI: FindThemeRootURI,
+    private findAppRootURI: FindAppRootURI,
   ) {}
 
   async onDidRenameFiles(params: RenameFilesParams): Promise<void> {
@@ -44,11 +44,11 @@ export class AssetRenameHandler implements BaseRenameHandler {
     // Only preload if you have something to do (folder renames are not supported)
     if (relevantRenames.length !== 1) return;
     const rename = relevantRenames[0];
-    const rootUri = await this.findThemeRootURI(path.dirname(params.files[0].oldUri));
+    const rootUri = await this.findAppRootURI(path.dirname(params.files[0].oldUri));
     if (!rootUri) return;
     await this.documentManager.preload(rootUri);
-    const theme = this.documentManager.theme(rootUri, true);
-    const liquidSourceCodes = theme.filter(isLiquidSourceCode);
+    const app = this.documentManager.app(rootUri, true);
+    const liquidSourceCodes = app.filter(isLiquidSourceCode);
 
     const oldAssetName = assetName(rename.oldUri);
     const newAssetName = assetName(rename.newUri);

package/src/renamed/handlers/PartialRenameHandler.spec.ts

@@ -9,7 +9,7 @@ import { RenameHandler } from '../RenameHandler';
 
 describe('Module: PartialRenameHandler', () => {
   const mockRoot = 'mock-fs:';
-  const findThemeRootURI = async () => mockRoot;
+  const findAppRootURI = async () => mockRoot;
   let capabilities: ClientCapabilities;
   let documentManager: DocumentManager;
   let handler: RenameHandler;
@@ -29,7 +29,7 @@ describe('Module: PartialRenameHandler', () => {
       mockRoot,
     );
     documentManager = new DocumentManager(fs);
-    handler = new RenameHandler(connection, capabilities, documentManager, findThemeRootURI);
+    handler = new RenameHandler(connection, capabilities, documentManager, findAppRootURI);
   });
 
   describe('when the client does not support workspace/applyEdit', () => {

package/src/renamed/handlers/PartialRenameHandler.ts

@@ -12,7 +12,7 @@ import { ClientCapabilities } from '../../ClientCapabilities';
 import { DocumentManager, isLiquidSourceCode } from '../../documents';
 import { isPartial, partialName } from '../../utils/uri';
 import { BaseRenameHandler } from '../BaseRenameHandler';
-import { FindThemeRootURI } from '../../internal-types';
+import { FindAppRootURI } from '../../internal-types';
 
 /**
  * The PartialRenameHandler will handle partial renames.
@@ -31,7 +31,7 @@ export class PartialRenameHandler implements BaseRenameHandler {
     private documentManager: DocumentManager,
     private connection: Connection,
     private capabilities: ClientCapabilities,
-    private findThemeRootURI: FindThemeRootURI,
+    private findAppRootURI: FindAppRootURI,
   ) {}
 
   async onDidRenameFiles(params: RenameFilesParams): Promise<void> {
@@ -43,11 +43,11 @@ export class PartialRenameHandler implements BaseRenameHandler {
     // Only preload if you have something to do (folder renames are not supported)
     if (relevantRenames.length !== 1) return;
     const rename = relevantRenames[0];
-    const rootUri = await this.findThemeRootURI(path.dirname(params.files[0].oldUri));
+    const rootUri = await this.findAppRootURI(path.dirname(params.files[0].oldUri));
     if (!rootUri) return;
     await this.documentManager.preload(rootUri);
-    const theme = this.documentManager.theme(rootUri, true);
-    const liquidSourceCodes = theme.filter(isLiquidSourceCode);
+    const app = this.documentManager.app(rootUri, true);
+    const liquidSourceCodes = app.filter(isLiquidSourceCode);
     const oldPartialName = partialName(rename.oldUri);
     const newPartialName = partialName(rename.newUri);
     const editLabel = `Rename partial '${oldPartialName}' to '${newPartialName}'`;

package/src/renamed/handlers/utils.ts

@@ -1,4 +1,4 @@
-import { Template } from '@platformos/platformos-check-common';
+import { Template } from '@platformos/platformos-check-common/dist/types/schemas';
 
 // this is very very optimistic...
 export function isValidTemplate(parsed: unknown): parsed is Template.Template {