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

package/src/completions/providers/ContentForParameterCompletionProvider.spec.ts

@@ -1,362 +0,0 @@
-import { describe, afterEach, beforeEach, it, expect, vi } from 'vitest';
-import { CompletionsProvider } from '../CompletionsProvider';
-import { DocumentManager } from '../../documents';
-import { MetafieldDefinitionMap } from '@platformos/platformos-check-common';
-import { TextEdit, InsertTextFormat } from 'vscode-languageserver-protocol';
-import { TextDocument } from 'vscode-languageserver-textdocument';
-import { CURSOR } from '../params';
-
-vi.mock('./data/contentForParameterCompletionOptions', async () => {
-  const actual = (await vi.importActual(
-    './data/contentForParameterCompletionOptions',
-  )) as typeof import('./data/contentForParameterCompletionOptions');
-  return {
-    DEFAULT_COMPLETION_OPTIONS: {
-      ...actual.DEFAULT_COMPLETION_OPTIONS,
-      // Add another option here so we can properly test some scenarios that
-      // we wouldn't be able to otherwise.
-      testOption: '',
-    },
-  };
-});
-
-describe('Module: ContentForBlockParameterCompletionProvider', async () => {
-  let provider: CompletionsProvider;
-
-  beforeEach(async () => {
-    provider = new CompletionsProvider({
-      documentManager: new DocumentManager(),
-      themeDocset: {
-        graphQL: async () => null,
-        filters: async () => [],
-        objects: async () => [],
-        liquidDrops: async () => [],
-        tags: async () => [],
-        systemTranslations: async () => ({}),
-      },
-      getMetafieldDefinitions: async (_rootUri: string) => ({} as MetafieldDefinitionMap),
-    });
-  });
-
-  afterEach(() => {
-    vi.restoreAllMocks();
-  });
-
-  it('offers a full list of completion items', async () => {
-    await expect(provider).to.complete('{% content_for "block", █ %}', [
-      'type',
-      'id',
-      'closest',
-      'testOption',
-    ]);
-  });
-
-  it('does not offer completion items if they are already present', async () => {
-    const context = `{% content_for "block", type: "fake-block", id: "fake-id", █ %}`;
-
-    await expect(provider).to.complete(context, ['closest', 'testOption']);
-  });
-
-  it('uses text edits to insert the completion item', async () => {
-    //                               char 24 ⌄
-    const context = `{% content_for "block", █ %}`;
-
-    const textEdit: TextEdit = {
-      newText: "type: '$1'",
-      range: {
-        end: { line: 0, character: 24 },
-        start: { line: 0, character: 24 },
-      },
-    };
-
-    await expect(provider).to.complete(
-      context,
-      expect.arrayContaining([
-        expect.objectContaining({
-          label: 'type',
-          insertTextFormat: InsertTextFormat.Snippet,
-          textEdit,
-        }),
-      ]),
-    );
-
-    const textDocument = TextDocument.create('', 'liquid', 0, context.replace(CURSOR, ''));
-
-    expect(TextDocument.applyEdits(textDocument, [textEdit])).toBe(
-      `{% content_for "block", type: '$1' %}`,
-    );
-  });
-
-  it('provides a different style of completion for "closest"', async () => {
-    //                               char 24 ⌄
-    const context = `{% content_for "block", █ %}`;
-
-    const textEdit: TextEdit = {
-      newText: 'closest.',
-      range: {
-        end: { line: 0, character: 24 },
-        start: { line: 0, character: 24 },
-      },
-    };
-
-    await expect(provider).to.complete(
-      context,
-      expect.arrayContaining([
-        expect.objectContaining({
-          label: 'closest',
-          insertTextFormat: InsertTextFormat.PlainText,
-          textEdit,
-        }),
-      ]),
-    );
-
-    const textDocument = TextDocument.create('', 'liquid', 0, context.replace(CURSOR, ''));
-
-    expect(TextDocument.applyEdits(textDocument, [textEdit])).toBe(
-      `{% content_for "block", closest. %}`,
-    );
-  });
-
-  describe("when we're completing for blocks we allow `closest`", () => {
-    it('does something', async () => {
-      await expect(provider).to.complete('{% content_for "blocks", █ %}', ['closest']);
-    });
-  });
-
-  describe('when the user has already started typing the name of the parameter', () => {
-    it('filters the completion options to only include ones that match', async () => {
-      await expect(provider).to.complete('{% content_for "block", t█ %}', ['type', 'testOption']);
-    });
-  });
-
-  describe('when the user has already typed out a parameter name', () => {
-    describe('and the cursor is in the middle of the parameter', () => {
-      it('changes the range depending on the completion item', async () => {
-        //                              char 24 ⌄               ⌄ char 38
-        const context = `{% content_for "block", t█ype: "button" %}`;
-        //                                            ⌃ char 28
-
-        const typeTextEdit: TextEdit = {
-          newText: 'type',
-          range: {
-            end: { line: 0, character: 28 },
-            start: { line: 0, character: 24 },
-          },
-        };
-
-        const testTextEdit: TextEdit = {
-          newText: "testOption: '$1'",
-          range: {
-            end: { line: 0, character: 38 },
-            start: { line: 0, character: 24 },
-          },
-        };
-
-        await expect(provider).to.complete(context, [
-          expect.objectContaining({
-            label: 'type',
-            insertTextFormat: InsertTextFormat.PlainText,
-            textEdit: expect.objectContaining(typeTextEdit),
-          }),
-          expect.objectContaining({
-            label: 'testOption',
-            insertTextFormat: InsertTextFormat.Snippet,
-            textEdit: expect.objectContaining(testTextEdit),
-          }),
-        ]);
-
-        const textDocument = TextDocument.create('', 'liquid', 0, context.replace(CURSOR, ''));
-
-        expect(TextDocument.applyEdits(textDocument, [testTextEdit])).toBe(
-          `{% content_for "block", testOption: '$1' %}`,
-        );
-
-        expect(TextDocument.applyEdits(textDocument, [typeTextEdit])).toBe(
-          `{% content_for "block", type: "button" %}`,
-        );
-      });
-    });
-
-    describe('and the cursor is at the beginning of the parameter', () => {
-      it('offers a full list of completion items', async () => {
-        const context = `{% content_for "block", █type: "button" %}`;
-
-        await expect(provider).to.complete(context, ['type', 'id', 'closest', 'testOption']);
-      });
-
-      it('does not replace the existing text', async () => {
-        //                               char 24 ⌄
-        const context = `{% content_for "block", █type: "button" %}`;
-
-        const textEdit: TextEdit = {
-          newText: "testOption: '$1', ",
-          range: {
-            end: { line: 0, character: 24 },
-            start: { line: 0, character: 24 },
-          },
-        };
-
-        await expect(provider).to.complete(
-          context,
-          expect.arrayContaining([
-            expect.objectContaining({
-              label: 'testOption',
-              insertTextFormat: InsertTextFormat.Snippet,
-              textEdit,
-            }),
-          ]),
-        );
-
-        const textDocument = TextDocument.create('', 'liquid', 0, context.replace(CURSOR, ''));
-
-        expect(TextDocument.applyEdits(textDocument, [textEdit])).toBe(
-          `{% content_for "block", testOption: '$1', type: "button" %}`,
-        );
-      });
-    });
-
-    describe('and the cursor is at the end of the parameter', () => {
-      it('offers only the same completion item', async () => {
-        const context = `{% content_for "block", type█: "button" %}`;
-
-        await expect(provider).to.complete(context, ['type']);
-      });
-
-      it('only replaces the parameter name', async () => {
-        //                              char 24 ⌄     ⌄ char 28
-        const context = `{% content_for "block", type█: "button" %}`;
-
-        const textEdit: TextEdit = {
-          newText: 'type',
-          range: {
-            end: { line: 0, character: 28 },
-            start: { line: 0, character: 24 },
-          },
-        };
-
-        await expect(provider).to.complete(
-          context,
-          expect.arrayContaining([
-            expect.objectContaining({
-              label: 'type',
-              insertTextFormat: InsertTextFormat.PlainText,
-              textEdit,
-            }),
-          ]),
-        );
-
-        const textDocument = TextDocument.create('', 'liquid', 0, context.replace(CURSOR, ''));
-
-        expect(TextDocument.applyEdits(textDocument, [textEdit])).toBe(
-          `{% content_for "block", type: "button" %}`,
-        );
-      });
-    });
-  });
-
-  describe('when the referred block has LiquidDoc parameters', () => {
-    beforeEach(async () => {
-      provider = new CompletionsProvider({
-        documentManager: new DocumentManager(),
-        themeDocset: {
-          graphQL: async () => null,
-          filters: async () => [],
-          objects: async () => [],
-          liquidDrops: async () => [],
-          tags: async () => [],
-          systemTranslations: async () => ({}),
-        },
-        getMetafieldDefinitions: async (_rootUri: string) => ({} as MetafieldDefinitionMap),
-        getDocDefinitionForURI: async (_uri, _category, _name) => {
-          return {
-            uri: 'file:///blocks/product-card.liquid',
-            liquidDoc: {
-              parameters: [
-                {
-                  nodeType: 'param',
-                  name: 'example-string-param',
-                  type: 'string',
-                  description: 'An example string parameter',
-                  required: true,
-                },
-                {
-                  nodeType: 'param',
-                  name: 'example-number-param',
-                  type: 'number',
-                  description: 'An example number parameter',
-                  required: true,
-                },
-                {
-                  nodeType: 'param',
-                  name: 'example-boolean-param',
-                  type: 'boolean',
-                  description: 'An example boolean parameter',
-                  required: true,
-                },
-                {
-                  nodeType: 'param',
-                  name: 'example-object-param',
-                  type: 'object',
-                  description: 'An example object parameter',
-                  required: true,
-                },
-                {
-                  nodeType: 'param',
-                  name: 'example-unknown-param',
-                  type: 'unknown',
-                  description: 'An example unknown parameter',
-                  required: true,
-                },
-              ],
-            },
-          };
-        },
-      });
-    });
-
-    it('offers the LiquidDoc parameters as completions', async () => {
-      const context = `{% content_for "block", type: 'fake-block', █ %}`;
-
-      await expect(provider).to.complete(
-        context,
-        expect.arrayContaining([
-          expect.objectContaining({
-            label: 'example-string-param',
-            insertTextFormat: InsertTextFormat.Snippet,
-            textEdit: expect.objectContaining({
-              newText: "example-string-param: '$1'$0",
-            }),
-          }),
-          expect.objectContaining({
-            label: 'example-number-param',
-            insertTextFormat: InsertTextFormat.Snippet,
-            textEdit: expect.objectContaining({
-              newText: 'example-number-param: ${1:0}$0',
-            }),
-          }),
-          expect.objectContaining({
-            label: 'example-boolean-param',
-            insertTextFormat: InsertTextFormat.Snippet,
-            textEdit: expect.objectContaining({
-              newText: 'example-boolean-param: ${1:false}$0',
-            }),
-          }),
-          expect.objectContaining({
-            label: 'example-object-param',
-            insertTextFormat: InsertTextFormat.Snippet,
-            textEdit: expect.objectContaining({
-              newText: 'example-object-param: ${1:}$0',
-            }),
-          }),
-          expect.objectContaining({
-            label: 'example-unknown-param',
-            insertTextFormat: InsertTextFormat.Snippet,
-            textEdit: expect.objectContaining({
-              newText: 'example-unknown-param: ${1:}$0',
-            }),
-          }),
-        ]),
-      );
-    });
-  });
-});

package/src/completions/providers/ContentForParameterCompletionProvider.ts

@@ -1,187 +0,0 @@
-import { LiquidVariableLookup, NodeTypes } from '@platformos/liquid-html-parser';
-import {
-  CompletionItem,
-  CompletionItemKind,
-  InsertTextFormat,
-  TextEdit,
-} from 'vscode-languageserver';
-import { CURSOR, LiquidCompletionParams } from '../params';
-import { Provider } from './common';
-import { AugmentedLiquidSourceCode } from '../../documents';
-import { DEFAULT_COMPLETION_OPTIONS } from './data/contentForParameterCompletionOptions';
-import { DocDefinition, GetDocDefinitionForURI } from '@platformos/platformos-check-common';
-import { getParameterCompletionTemplate } from '../../utils/liquidDoc';
-
-/**
- * Offers completions for parameters for the `content_for` tag after a user has
- * specificied the type.
- *
- * @example {% content_for "block", █ %}
- */
-export class ContentForParameterCompletionProvider implements Provider {
-  constructor(private readonly getDocDefinitionForURI: GetDocDefinitionForURI) {}
-
-  async completions(params: LiquidCompletionParams): Promise<CompletionItem[]> {
-    if (!params.completionContext) return [];
-
-    const { node, ancestors } = params.completionContext;
-
-    const parentNode = ancestors.at(-1);
-
-    const parentIsContentFor = parentNode?.type == NodeTypes.ContentForMarkup;
-    const nodeIsVariableLookup = node?.type == NodeTypes.VariableLookup;
-
-    if (!parentIsContentFor || !nodeIsVariableLookup) {
-      return [];
-    }
-
-    if (!node.name || node.lookups.length > 0) {
-      return [];
-    }
-
-    const completionItems = this.staticCompletions(
-      node,
-      parentNode.contentForType.value == 'blocks',
-      params.document,
-    );
-
-    if (parentNode.contentForType.value === 'block') {
-      const typeArg = parentNode.args.find((arg) => arg.name === 'type')?.value;
-
-      if (typeArg?.type === NodeTypes.String) {
-        const snippetDefinition = await this.getDocDefinitionForURI(
-          params.textDocument.uri,
-          'blocks',
-          typeArg.value,
-        );
-
-        completionItems.push(
-          ...this.liquidDocParameterCompletions(node, params.document, snippetDefinition),
-        );
-      }
-    }
-
-    // We need to find out existing params in the content_for tag so we don't offer it again for completion
-    const existingParams = parentNode.args
-      .filter((arg) => arg.type === NodeTypes.NamedArgument)
-      .map((arg) => arg.name);
-
-    return completionItems.filter((item) => !existingParams.includes(item.label));
-  }
-
-  textEdit(
-    node: LiquidVariableLookup,
-    document: AugmentedLiquidSourceCode,
-    name: string,
-    textTemplate: string = `${name}: '$1'`,
-  ): {
-    textEdit: TextEdit;
-    format: InsertTextFormat;
-  } {
-    const remainingText = document.source.slice(node.position.end);
-
-    // Match all the way up to the termination of the parameter which could be
-    // another parameter (`,`), filter (`|`), or the end of a liquid statement.
-    const match = remainingText.match(/^(.*?)\s*(?=,|\||-?\}\}|-?\%\})|^(.*)$/);
-    const offset = match ? match[0].trimEnd().length : remainingText.length;
-    const existingParameterOffset = remainingText.match(/[^a-zA-Z]/)?.index ?? remainingText.length;
-
-    let start = document.textDocument.positionAt(node.position.start);
-    let end = document.textDocument.positionAt(node.position.end + offset);
-    let newText = name === 'closest' ? `${name}.` : textTemplate;
-    let format = name === 'closest' ? InsertTextFormat.PlainText : InsertTextFormat.Snippet;
-
-    // If the cursor is inside the parameter or at the end and it's the same
-    // value as the one we're offering a completion for then we want to restrict
-    // the insert to just the name of the parameter.
-    // e.g. `{% content_for "block", t█ype: "button" %}` and we're offering `type`
-    if (node.name + remainingText.slice(0, existingParameterOffset) == name) {
-      newText = name;
-      format = InsertTextFormat.PlainText;
-      end = document.textDocument.positionAt(node.position.end + existingParameterOffset);
-    }
-
-    // If the cursor is at the beginning of the string we can consider all
-    // options and should not replace any text.
-    // e.g. `{% content_for "block", █type: "button" %}`
-    // e.g. `{% content_for "block", █ %}`
-    if (node.name === CURSOR) {
-      end = start;
-
-      // If we're inserting text in front of an existing parameter then we need
-      // to add a comma to separate them.
-      if (existingParameterOffset > 0) {
-        newText += ', ';
-      }
-    }
-
-    return {
-      textEdit: TextEdit.replace(
-        {
-          start,
-          end,
-        },
-        newText,
-      ),
-      format,
-    };
-  }
-
-  private staticCompletions(
-    node: LiquidVariableLookup,
-    isTypeBlocks: boolean,
-    document: AugmentedLiquidSourceCode,
-  ) {
-    let options = DEFAULT_COMPLETION_OPTIONS;
-
-    const partial = node.name!.replace(CURSOR, '');
-
-    if (isTypeBlocks) {
-      options = {
-        closest: DEFAULT_COMPLETION_OPTIONS.closest,
-      };
-    }
-
-    return Object.entries(options)
-      .filter(([keyword, _description]) => keyword.startsWith(partial))
-      .map(([keyword, description]): CompletionItem => {
-        const { textEdit, format } = this.textEdit(node, document, keyword);
-        return {
-          label: keyword,
-          kind: CompletionItemKind.Keyword,
-          documentation: {
-            kind: 'markdown',
-            value: description,
-          },
-          insertTextFormat: format,
-          textEdit,
-        };
-      });
-  }
-
-  private liquidDocParameterCompletions(
-    node: LiquidVariableLookup,
-    document: AugmentedLiquidSourceCode,
-    docDefinition?: DocDefinition,
-  ) {
-    return (docDefinition?.liquidDoc?.parameters || []).map((liquidDocParam): CompletionItem => {
-      const { textEdit, format } = this.textEdit(
-        node,
-        document,
-        liquidDocParam.name,
-        getParameterCompletionTemplate(liquidDocParam.name, liquidDocParam.type),
-      );
-
-      return {
-        label: liquidDocParam.name,
-        kind: CompletionItemKind.Keyword,
-        documentation: {
-          kind: 'markdown',
-          value: liquidDocParam.description || '',
-        },
-        insertTextFormat: format,
-        textEdit,
-      };
-    });
-  }
-}

package/src/completions/providers/data/contentForParameterCompletionOptions.ts

@@ -1,9 +0,0 @@
-/**
- * These definitions are not currently available in the generated Liquid Docs
- * so we're hardcoding them here in the interim.
- */
-export const DEFAULT_COMPLETION_OPTIONS: { [key: string]: string } = {
-  type: "The type (name) of an existing theme block in your theme’s /blocks folder. Only applicable when `content_type` is 'block'.",
-  id: "A unique identifier and literal string within the section or block that contains the static blocks. Only applicable when `content_type` is 'block'.",
-  closest: 'A path that provides a way to access the closest resource of a given type.',
-};