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

package/src/css/CSSLanguageService.spec.ts

@@ -1,159 +0,0 @@
-import { assert, beforeEach, describe, expect, it } from 'vitest';
-import { DocumentManager } from '../documents';
-import { CSSLanguageService } from './CSSLanguageService';
-import { getRequestParams, isCompletionList } from './test/test-helpers';
-
-describe('Module: CSSLanguageService', () => {
-  let cssLanguageService: CSSLanguageService;
-  let documentManager: DocumentManager;
-
-  beforeEach(async () => {
-    documentManager = new DocumentManager(
-      undefined,
-      undefined,
-      undefined,
-      async () => 'theme', // theme schema
-      async () => false, // invalid
-    );
-    cssLanguageService = new CSSLanguageService(documentManager);
-
-    await cssLanguageService.setup({
-      textDocument: {
-        completion: {
-          contextSupport: true,
-          completionItem: {
-            snippetSupport: true,
-            commitCharactersSupport: true,
-            documentationFormat: ['markdown'],
-            deprecatedSupport: true,
-            preselectSupport: true,
-          },
-        },
-      },
-    });
-  });
-
-  describe('completions', () => {
-    it('should return CSS completions in a liquid file {% stylesheet %}', async () => {
-      const params = getRequestParams(
-        documentManager,
-        'sections/section.liquid',
-        `
-          {% stylesheet %}
-            .a:hov█ {
-              color: red;
-            }
-          {% endstylesheet %}
-          <div>hello world</div>
-
-        `,
-      );
-
-      const completions = await cssLanguageService.completions(params);
-      assert(isCompletionList(completions));
-      expect(completions.items).to.have.lengthOf(377);
-      expect(completions.items[0].label).to.equal(':active');
-      expect(completions.items[0].documentation).to.deep.equal({
-        kind: 'markdown',
-        value:
-          `Applies while an element is being activated by the user\\. For example, between the times the user presses the mouse button and releases it\\.\n\n` +
-          `![Baseline icon](data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTgiIGhlaWdodD0iMTAiIHZpZXdCb3g9IjAgMCA1NDAgMzAwIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogIDxzdHlsZT4KICAgIC5ncmVlbi1zaGFwZSB7CiAgICAgIGZpbGw6ICNDNEVFRDA7IC8qIExpZ2h0IG1vZGUgKi8KICAgIH0KCiAgICBAbWVkaWEgKHByZWZlcnMtY29sb3Itc2NoZW1lOiBkYXJrKSB7CiAgICAgIC5ncmVlbi1zaGFwZSB7CiAgICAgICAgZmlsbDogIzEyNTIyNTsgLyogRGFyayBtb2RlICovCiAgICAgIH0KICAgIH0KICA8L3N0eWxlPgogIDxwYXRoIGQ9Ik00MjAgMzBMMzkwIDYwTDQ4MCAxNTBMMzkwIDI0MEwzMzAgMTgwTDMwMCAyMTBMMzkwIDMwMEw1NDAgMTUwTDQyMCAzMFoiIGNsYXNzPSJncmVlbi1zaGFwZSIvPgogIDxwYXRoIGQ9Ik0xNTAgMEwzMCAxMjBMNjAgMTUwTDE1MCA2MEwyMTAgMTIwTDI0MCA5MEwxNTAgMFoiIGNsYXNzPSJncmVlbi1zaGFwZSIvPgogIDxwYXRoIGQ9Ik0zOTAgMEw0MjAgMzBMMTUwIDMwMEwwIDE1MEwzMCAxMjBMMTUwIDI0MEwzOTAgMFoiIGZpbGw9IiMxRUE0NDYiLz4KPC9zdmc+) _Widely available across major browsers (Baseline since 2015)_\n\n` +
-          `[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/:active)`,
-      });
-    });
-  });
-
-  describe('hover', () => {
-    it('should return hover information for the given property in a {% stylesheet %}', async () => {
-      const params = getRequestParams(
-        documentManager,
-        'sections/section.liquid',
-        `
-          {% stylesheet %}
-            .wrapper {
-              display: flex█;
-            }
-          {% endstylesheet %}
-          <div>hello world</div>
-        `,
-      );
-      const hover = await cssLanguageService.hover(params);
-      assert(hover !== null);
-      expect(hover.contents).to.eql({
-        kind: 'plaintext',
-        value:
-          dedent(`In combination with 'float' and 'position', determines the type of box or boxes that are generated for an element.
-
-        Widely available across major browsers (Baseline since 2015)
-
-        Syntax: [ <display-outside> || <display-inside> ] | <display-listitem> | <display-internal> | <display-box> | <display-legacy>
-
-        MDN Reference: https://developer.mozilla.org/docs/Web/CSS/display`),
-      });
-    });
-
-    it('should return hover information for the given tag in a {% stylesheet %}', async () => {
-      const params = getRequestParams(
-        documentManager,
-        'sections/section.liquid',
-        `
-          {% stylesheet %}
-            .wrapper█ {
-              display: flex;
-            }
-          {% endstylesheet %}
-          <div>hello world</div>
-        `,
-      );
-      const hover = await cssLanguageService.hover(params);
-      assert(hover !== null);
-      expect(hover.contents).to.eql([
-        '<element class="wrapper">',
-        '[Selector Specificity](https://developer.mozilla.org/docs/Web/CSS/Specificity): (0, 1, 0)',
-      ]);
-    });
-  });
-
-  describe('diagnostics', () => {
-    it('should return ddiagnostics information for the given property in a {% stylesheet %}', async () => {
-      const params = getRequestParams(
-        documentManager,
-        'sections/section.liquid',
-        `
-          {% stylesheet %}
-            a:h {
-            }
-          {% endstylesheet %}
-          <div>hello world</div>
-        `,
-      );
-      const diagnostics = await cssLanguageService.diagnostics(params);
-      assert(diagnostics !== null);
-      expect(diagnostics).to.eql([
-        {
-          code: 'emptyRules',
-          message: 'Do not use empty rulesets',
-          range: {
-            end: {
-              character: 15,
-              line: 2,
-            },
-            start: {
-              character: 12,
-              line: 2,
-            },
-          },
-          severity: 2,
-          source: 'json',
-        },
-      ]);
-    });
-  });
-});
-
-function dedent(text: string): string {
-  return text
-    .split('\n')
-    .map((line) => line.trimStart())
-    .join('\n');
-}

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

@@ -1,30 +0,0 @@
-import {
-  CompletionItem,
-  CompletionList,
-  CompletionParams,
-  HoverParams,
-} from 'vscode-languageserver-protocol';
-import { DocumentManager } from '../../documents';
-
-export function getRequestParams(
-  documentManager: DocumentManager,
-  relativePath: string,
-  source: string,
-): HoverParams & CompletionParams {
-  const uri = `file:///root/${relativePath}`;
-  const sourceWithoutCursor = source.replace('█', '');
-  documentManager.open(uri, sourceWithoutCursor, 1);
-  const doc = documentManager.get(uri)!.textDocument;
-  const position = doc.positionAt(source.indexOf('█'));
-
-  return {
-    textDocument: { uri: uri },
-    position: position,
-  };
-}
-
-export function isCompletionList(
-  completions: null | CompletionList | CompletionItem[],
-): completions is CompletionList {
-  return completions !== null && !Array.isArray(completions);
-}

package/src/definitions/providers/SchemaTranslationStringDefinitionProvider.spec.ts

@@ -1,96 +0,0 @@
-import { JSONSourceCode, SourceCodeType, toSourceCode } from '@platformos/platformos-check-common';
-import { assert, beforeEach, describe, expect, it } from 'vitest';
-import { DefinitionParams, LocationLink } from 'vscode-languageserver-protocol';
-import { TextDocument } from 'vscode-languageserver-textdocument';
-import { AugmentedJsonSourceCode, DocumentManager } from '../../documents';
-import { DefinitionProvider } from '../DefinitionProvider';
-
-describe('Module: SchemaTranslationStringDefinitionProvider', () => {
-  let provider: DefinitionProvider;
-  let documentManager: DocumentManager;
-  let mockGetDefaultSchemaLocaleSourceCode: (uri: string) => Promise<any>;
-
-  beforeEach(() => {
-    documentManager = new DocumentManager(
-      undefined,
-      undefined,
-      undefined,
-      async () => 'theme',
-      async () => true,
-    );
-
-    const translationFileContents = JSON.stringify(
-      {
-        hello: {
-          world: 'Hello World',
-        },
-      },
-      null,
-      2,
-    );
-
-    const uri = 'file:///locales/en.default.schema.json';
-    const sourceCode = toSourceCode(uri, translationFileContents) as JSONSourceCode;
-    const textDocument = TextDocument.create(uri, sourceCode.type, 1, sourceCode.source);
-    mockGetDefaultSchemaLocaleSourceCode = async (): Promise<AugmentedJsonSourceCode> => {
-      return {
-        ...sourceCode,
-        textDocument,
-      };
-    };
-
-    provider = new DefinitionProvider(
-      documentManager,
-      async () => null,
-      mockGetDefaultSchemaLocaleSourceCode,
-    );
-  });
-
-  it('finds the definition of existing translation keys', async () => {
-    const source = `
-      {% schema %}
-        {
-          "name": "t:hello.world"
-        }
-      {% endschema %}
-    `;
-    documentManager.open('file:///blocks/test.liquid', source, 1);
-    const params: DefinitionParams = {
-      textDocument: { uri: 'file:///blocks/test.liquid' },
-      position: { line: 3, character: 26 }, // Position within "t:hello.world"
-    };
-
-    const result = await provider.definitions(params);
-
-    assert(result);
-    expect(result).toHaveLength(1);
-    assert(LocationLink.is(result[0]));
-    expect(result[0]).toMatchObject({
-      targetUri: 'file:///locales/en.default.schema.json',
-      targetRange: {
-        start: { line: 2, character: expect.any(Number) },
-        end: { line: 2, character: expect.any(Number) },
-      },
-    });
-  });
-
-  it('returns null for non-existent translation key', async () => {
-    const source = `
-      {% schema %}
-        {
-          "name": "t:hello.world"
-        }
-      {% endschema %}
-    `;
-    documentManager.open('file:///blocks/products.liquid', source, 1);
-
-    const params: DefinitionParams = {
-      textDocument: { uri: 'file:///blocks/products.liquid' },
-      position: { line: 0, character: 7 }, // Position within "unknown.key"
-    };
-
-    const result = await provider.definitions(params);
-
-    assert(result === null);
-  });
-});

package/src/definitions/providers/SchemaTranslationStringDefinitionProvider.ts

@@ -1,82 +0,0 @@
-import { LiquidHtmlNode, LiquidRawTag, NodeTypes } from '@platformos/liquid-html-parser';
-import { SourceCodeType, findJSONNode, nodeAtPath } from '@platformos/platformos-check-common';
-import {
-  DefinitionLink,
-  DefinitionParams,
-  LocationLink,
-  Range,
-} from 'vscode-languageserver-protocol';
-import { AugmentedJsonSourceCode, DocumentManager } from '../../documents';
-import { BaseDefinitionProvider } from '../BaseDefinitionProvider';
-
-export class SchemaTranslationStringDefinitionProvider implements BaseDefinitionProvider {
-  constructor(
-    private documentManager: DocumentManager,
-    private getDefaultSchemaLocaleSourceCode: (
-      uri: string,
-    ) => Promise<AugmentedJsonSourceCode | null>,
-  ) {}
-
-  async definitions(
-    params: DefinitionParams,
-    node: LiquidHtmlNode,
-    ancestors: LiquidHtmlNode[],
-  ): Promise<DefinitionLink[]> {
-    const sourceCode = this.documentManager.get(params.textDocument.uri);
-    if (!sourceCode || sourceCode.type !== SourceCodeType.LiquidHtml) return [];
-
-    // We want text inside {% schema %}
-    if (node.type !== NodeTypes.TextNode) return [];
-    const schemaTag = ancestors.find(isSchemaTag);
-    if (!schemaTag) {
-      return [];
-    }
-
-    const schema = await sourceCode.getSchema();
-    if (!schema || schema.ast instanceof Error) return [];
-
-    // Now we need to find the location of the translation in the translation file
-    const defaultLocaleFile = await this.getDefaultSchemaLocaleSourceCode(params.textDocument.uri);
-    if (
-      !defaultLocaleFile ||
-      defaultLocaleFile.type !== SourceCodeType.JSON ||
-      defaultLocaleFile.ast instanceof Error
-    ) {
-      return [];
-    }
-
-    const documentOffset = sourceCode.textDocument.offsetAt(params.position);
-    const offset = documentOffset - schema.offset;
-    const [jNode, _jAncestors] = findJSONNode(schema.ast, offset);
-
-    if (jNode.type !== 'Literal') return [];
-    if (typeof jNode.value !== 'string' || !jNode.value.startsWith('t:')) return [];
-
-    const translationKey = jNode.value.slice(2).trim();
-    const translationNode = nodeAtPath(defaultLocaleFile.ast, translationKey.split('.'));
-
-    if (!translationNode) return [];
-
-    const targetRange = Range.create(
-      defaultLocaleFile.textDocument.positionAt(translationNode.loc.start.offset),
-      defaultLocaleFile.textDocument.positionAt(translationNode.loc.end.offset),
-    );
-    const originRange = Range.create(
-      sourceCode.textDocument.positionAt(schema.offset + jNode.loc.start.offset),
-      sourceCode.textDocument.positionAt(schema.offset + jNode.loc.end.offset),
-    );
-
-    return [
-      LocationLink.create(
-        defaultLocaleFile.textDocument.uri,
-        targetRange,
-        targetRange,
-        originRange,
-      ),
-    ];
-  }
-}
-
-function isSchemaTag(node: LiquidHtmlNode): node is LiquidRawTag & { name: 'schema' } {
-  return node.type === NodeTypes.LiquidRawTag && node.name === 'schema';
-}

package/src/hover/providers/ContentForArgumentHoverProvider.spec.ts

@@ -1,76 +0,0 @@
-import { describe, beforeEach, it, expect } from 'vitest';
-import { DocumentManager } from '../../documents';
-import { HoverProvider } from '../HoverProvider';
-import { MetafieldDefinitionMap } from '@platformos/platformos-check-common';
-import { GetDocDefinitionForURI, DocDefinition } from '@platformos/platformos-check-common';
-import { TranslationProvider } from '@platformos/platformos-common';
-import { MockFileSystem } from '@platformos/platformos-check-common/src/test';
-
-const uri = 'file:///blocks/product-card.liquid';
-
-describe('Module: ContentForArgumentHoverProvider', async () => {
-  let provider: HoverProvider;
-  let getSnippetDefinition: GetDocDefinitionForURI;
-  const mockSnippetDefinition: DocDefinition = {
-    uri,
-    liquidDoc: {
-      parameters: [
-        {
-          name: 'title',
-          description: 'The title of the product',
-          type: 'string',
-          required: true,
-          nodeType: 'param',
-        },
-      ],
-    },
-  };
-
-  describe('hover', () => {
-    beforeEach(() => {
-      provider = createProvider(async () => mockSnippetDefinition);
-    });
-
-    it('should return null if doc definition not found', async () => {
-      getSnippetDefinition = async () => undefined;
-      provider = createProvider(getSnippetDefinition);
-      await expect(provider).to.hover(
-        `{% content_for 'block', type: 'product-card', tit█le: 'value' %}`,
-        null,
-      );
-    });
-
-    it('should return null if parameter not found in doc definition', async () => {
-      await expect(provider).to.hover(
-        `{% content_for 'block', type: unknown-para█m: 'value' %}`,
-        null,
-      );
-    });
-
-    it('should return parameter info from doc definition', async () => {
-      await expect(provider).to.hover(
-        `{% content_for 'block', type: 'product-card', ti█tle: 'My Product' %}`,
-        '### `title`: string\n\nThe title of the product',
-      );
-    });
-  });
-});
-
-const createProvider = (getSnippetDefinition: GetDocDefinitionForURI) => {
-  return new HoverProvider(
-    new DocumentManager(),
-    {
-      graphQL: async () => null,
-      filters: async () => [],
-      objects: async () => [],
-      liquidDrops: async () => [],
-      tags: async () => [],
-      systemTranslations: async () => ({}),
-    },
-    new TranslationProvider(new MockFileSystem({})),
-    async (_rootUri: string) => ({}) as MetafieldDefinitionMap,
-    async () => ({}),
-    async () => [],
-    getSnippetDefinition,
-  );
-};

package/src/hover/providers/ContentForArgumentHoverProvider.ts

@@ -1,56 +0,0 @@
-import { NodeTypes } from '@platformos/liquid-html-parser';
-import {
-  LiquidHtmlNode,
-  GetDocDefinitionForURI,
-  getBlockName,
-} from '@platformos/platformos-check-common';
-import { Hover, HoverParams } from 'vscode-languageserver';
-import { BaseHoverProvider } from '../BaseHoverProvider';
-import { formatLiquidDocParameter } from '../../utils/liquidDoc';
-
-export class ContentForArgumentHoverProvider implements BaseHoverProvider {
-  constructor(private getDocDefinitionForURI: GetDocDefinitionForURI) {}
-
-  async hover(
-    currentNode: LiquidHtmlNode,
-    ancestors: LiquidHtmlNode[],
-    params: HoverParams,
-  ): Promise<Hover | null> {
-    const parentNode = ancestors.at(-1);
-    if (
-      currentNode.type !== NodeTypes.NamedArgument ||
-      !parentNode ||
-      parentNode.type !== NodeTypes.ContentForMarkup ||
-      parentNode.contentForType.type !== NodeTypes.String
-    ) {
-      return null;
-    }
-
-    const blockName = getBlockName(parentNode);
-
-    if (!blockName) {
-      return null;
-    }
-
-    const docDefinition = await this.getDocDefinitionForURI(
-      params.textDocument.uri,
-      'blocks',
-      blockName,
-    );
-
-    const hoverArgument = docDefinition?.liquidDoc?.parameters?.find(
-      (argument) => argument.name === currentNode.name,
-    );
-
-    if (!hoverArgument) {
-      return null;
-    }
-
-    return {
-      contents: {
-        kind: 'markdown',
-        value: formatLiquidDocParameter(hoverArgument, true),
-      },
-    };
-  }
-}

package/src/hover/providers/ContentForTypeHoverProvider.spec.ts

@@ -1,91 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { DocumentManager } from '../../documents';
-import { HoverProvider } from '../HoverProvider';
-import { MetafieldDefinitionMap } from '@platformos/platformos-check-common';
-import { GetDocDefinitionForURI, DocDefinition } from '@platformos/platformos-check-common';
-import { TranslationProvider } from '@platformos/platformos-common';
-import { MockFileSystem } from '@platformos/platformos-check-common/src/test';
-
-const uri = 'file:///blocks/product-card.liquid';
-
-describe('Module: ContentForTypeHoverProvider', async () => {
-  let provider: HoverProvider;
-  const mockSnippetDefinition: DocDefinition = {
-    uri,
-    liquidDoc: {
-      parameters: [
-        {
-          name: 'title',
-          description: 'The title of the product',
-          type: 'string',
-          required: true,
-          nodeType: 'param',
-        },
-      ],
-      description: {
-        content: 'This is a description',
-        nodeType: 'description',
-      },
-      examples: [
-        {
-          content: '{{ product }}',
-          nodeType: 'example',
-        },
-      ],
-    },
-  };
-
-  describe('hover', () => {
-    it('should return snippet definition with all parameters', async () => {
-      provider = createProvider(async () => mockSnippetDefinition);
-      // prettier-ignore
-      const expectedHoverContent = 
-`### product-card
-
-**Description:**
-
-
-This is a description
-
-**Parameters:**
-- \`title\`: string - The title of the product
-
-**Examples:**
-\`\`\`liquid
-{{ product }}
-\`\`\``;
-
-      await expect(provider).to.hover(
-        `{% content_for 'block', type: 'product-car█d' %}`,
-        expectedHoverContent,
-      );
-    });
-
-    it("should return nothing if not in content_for tag's type argument's value", async () => {
-      await expect(provider).to.hover(
-        `{% content_for 'block', type: 'product-card', id: 'some-█string' %}`,
-        null,
-      );
-      await expect(provider).to.hover(`{{ content_for 'bl█ock', type: 'product-card' }}`, null);
-    });
-  });
-});
-
-const createProvider = (getSnippetDefinition: GetDocDefinitionForURI) => {
-  return new HoverProvider(
-    new DocumentManager(),
-    {
-      graphQL: async () => null,
-      filters: async () => [],
-      objects: async () => [],
-      liquidDrops: async () => [],
-      tags: async () => [],
-      systemTranslations: async () => ({}),
-    },
-    new TranslationProvider(new MockFileSystem({})),
-    async (_rootUri: string) => ({}) as MetafieldDefinitionMap,
-    async () => ({}),
-    async () => [],
-    getSnippetDefinition,
-  );
-};

package/src/hover/providers/ContentForTypeHoverProvider.ts

@@ -1,42 +0,0 @@
-import { NodeTypes } from '@platformos/liquid-html-parser';
-import { LiquidHtmlNode, GetDocDefinitionForURI } from '@platformos/platformos-check-common';
-import { Hover, HoverParams } from 'vscode-languageserver';
-import { BaseHoverProvider } from '../BaseHoverProvider';
-import { formatLiquidDocContentMarkdown } from '../../utils/liquidDoc';
-
-export class ContentForTypeHoverProvider implements BaseHoverProvider {
-  constructor(private getDocDefinitionForURI: GetDocDefinitionForURI) {}
-
-  async hover(
-    currentNode: LiquidHtmlNode,
-    ancestors: LiquidHtmlNode[],
-    params: HoverParams,
-  ): Promise<Hover | null> {
-    const parentNode = ancestors.at(-1);
-    const grandParentNode = ancestors.at(-2);
-    if (
-      currentNode.type !== NodeTypes.String ||
-      !parentNode ||
-      !grandParentNode ||
-      parentNode.type !== NodeTypes.NamedArgument ||
-      parentNode.name !== 'type' ||
-      grandParentNode.type !== NodeTypes.ContentForMarkup
-    ) {
-      return null;
-    }
-
-    const blockName = currentNode.value;
-    const docDefinition = await this.getDocDefinitionForURI(
-      params.textDocument.uri,
-      'blocks',
-      blockName,
-    );
-
-    return {
-      contents: {
-        kind: 'markdown',
-        value: formatLiquidDocContentMarkdown(blockName, docDefinition),
-      },
-    };
-  }
-}