@prisma-next/language-server 0.14.0-dev.37 → 0.14.0-dev.38

package/src/completion-provider.ts

@@ -0,0 +1,454 @@
+import {
+  type AuthoringPslBlockDescriptorNamespace,
+  isAuthoringPslBlockDescriptor,
+} from '@prisma-next/framework-components/authoring';
+import {
+  findBlockDescriptor,
+  type NamespaceSymbol,
+  type SymbolTable,
+} from '@prisma-next/psl-parser';
+import type { GenericBlockDeclarationAst, SourceFile } from '@prisma-next/psl-parser/syntax';
+import { type CompletionItem, CompletionItemKind, InsertTextFormat } from 'vscode-languageserver';
+import type {
+  DeclarationKeywordCompletionContext,
+  GenericBlockKeyCompletionContext,
+  ModelTypeCompletionContext,
+  NamespaceMemberCompletionContext,
+  PslCompletionContext,
+} from './completion-context';
+
+export interface PslCompletionCandidateSource {
+  readonly scalarTypes: readonly string[];
+  readonly pslBlockDescriptors: AuthoringPslBlockDescriptorNamespace;
+  readonly symbolTable?: SymbolTable;
+}
+
+export interface ProvidePslCompletionItemsInput {
+  readonly context: PslCompletionContext;
+  readonly sourceFile: SourceFile;
+  readonly candidates: PslCompletionCandidateSource;
+  readonly clientSupportsSnippets: boolean;
+}
+
+type DeclarationKeywordCompletionCandidateCategory = 'native' | 'genericBlock';
+
+type ModelTypeCompletionCandidateCategory =
+  | 'configuredScalar'
+  | 'topLevelModel'
+  | 'topLevelCompositeType'
+  | 'scalar'
+  | 'typeAlias'
+  | 'namespace'
+  | 'namespaceModel'
+  | 'namespaceCompositeType';
+
+interface DeclarationKeywordCompletionCandidate {
+  readonly category: DeclarationKeywordCompletionCandidateCategory;
+  readonly label: string;
+  readonly insertText: string;
+  readonly snippetText: string;
+  readonly detail: string;
+  readonly kind: CompletionItemKind;
+}
+
+interface ModelTypeCompletionCandidate {
+  readonly category: ModelTypeCompletionCandidateCategory;
+  readonly label: string;
+  readonly insertText: string;
+  readonly filterText: string;
+  readonly detail: string;
+  readonly kind: CompletionItemKind;
+}
+
+const categoryOrder: Record<ModelTypeCompletionCandidateCategory, number> = {
+  configuredScalar: 0,
+  topLevelModel: 1,
+  topLevelCompositeType: 2,
+  scalar: 3,
+  typeAlias: 4,
+  namespace: 5,
+  namespaceModel: 6,
+  namespaceCompositeType: 7,
+};
+
+const declarationKeywordCategoryOrder: Record<
+  DeclarationKeywordCompletionCandidateCategory,
+  number
+> = {
+  native: 0,
+  genericBlock: 1,
+};
+
+const nameSnippetPlaceholder = '$' + '{1:Name}';
+const namespaceSnippetPlaceholder = '$' + '{1:name}';
+
+const documentNativeDeclarationKeywords: readonly DeclarationKeywordCompletionCandidate[] = [
+  nativeDeclarationKeyword('model', 'model ', `model ${nameSnippetPlaceholder} {\n  $0\n}`),
+  nativeDeclarationKeyword('type', 'type ', `type ${nameSnippetPlaceholder} {\n  $0\n}`),
+  nativeDeclarationKeyword('types', 'types ', 'types {\n  $0\n}'),
+  nativeDeclarationKeyword(
+    'namespace',
+    'namespace ',
+    `namespace ${namespaceSnippetPlaceholder} {\n  $0\n}`,
+  ),
+];
+
+const namespaceNativeDeclarationKeywords: readonly DeclarationKeywordCompletionCandidate[] = [
+  nativeDeclarationKeyword('model', 'model ', `model ${nameSnippetPlaceholder} {\n  $0\n}`),
+  nativeDeclarationKeyword('type', 'type ', `type ${nameSnippetPlaceholder} {\n  $0\n}`),
+];
+
+export function providePslCompletionItems(
+  input: ProvidePslCompletionItemsInput,
+): readonly CompletionItem[] {
+  const { context } = input;
+  switch (context.kind) {
+    case 'unsupported':
+      return [];
+    // Foreign contract-space members require the multi-input symbol table; no
+    // contract-space registry exists today, so this position yields nothing yet.
+    case 'spaceMember':
+      return [];
+    // Parameter-value completion (option allowed-values / ref scopes) is future
+    // work.
+    case 'genericBlockValue':
+      return [];
+    case 'declarationKeyword':
+      return provideDeclarationKeywordCompletionItems(
+        context,
+        input.sourceFile,
+        input.candidates,
+        input.clientSupportsSnippets,
+      );
+    case 'genericBlockKey':
+      return provideGenericBlockKeyCompletionItems(context, input.sourceFile, input.candidates);
+    case 'modelType':
+      return provideModelTypeCompletionItems(context, input.sourceFile, input.candidates);
+    case 'namespaceMember':
+      return provideNamespaceMemberCompletionItems(context, input.sourceFile, input.candidates);
+  }
+}
+
+function provideDeclarationKeywordCompletionItems(
+  context: DeclarationKeywordCompletionContext,
+  sourceFile: SourceFile,
+  source: PslCompletionCandidateSource,
+  clientSupportsSnippets: boolean,
+): readonly CompletionItem[] {
+  const replacementRange = {
+    start: sourceFile.positionAt(context.replacementStartOffset),
+    end: sourceFile.positionAt(context.offset),
+  };
+
+  return declarationKeywordCandidates(context.scope, source).map((candidate) => ({
+    label: candidate.label,
+    kind: candidate.kind,
+    detail: candidate.detail,
+    sortText: declarationKeywordSortText(candidate),
+    filterText: candidate.label,
+    ...(clientSupportsSnippets ? { insertTextFormat: InsertTextFormat.Snippet } : {}),
+    textEdit: {
+      range: replacementRange,
+      newText: clientSupportsSnippets ? candidate.snippetText : candidate.insertText,
+    },
+  }));
+}
+
+function declarationKeywordCandidates(
+  scope: DeclarationKeywordCompletionContext['scope'],
+  source: PslCompletionCandidateSource,
+): readonly DeclarationKeywordCompletionCandidate[] {
+  const nativeCandidates =
+    scope === 'namespace' ? namespaceNativeDeclarationKeywords : documentNativeDeclarationKeywords;
+  return [
+    ...nativeCandidates,
+    ...genericBlockDeclarationKeywordCandidates(source.pslBlockDescriptors),
+  ];
+}
+
+function nativeDeclarationKeyword(
+  label: string,
+  insertText: string,
+  snippetText: string,
+): DeclarationKeywordCompletionCandidate {
+  return {
+    category: 'native',
+    label,
+    insertText,
+    snippetText,
+    detail: 'PSL declaration keyword',
+    kind: CompletionItemKind.Keyword,
+  };
+}
+
+function genericBlockDeclarationKeywordCandidates(
+  descriptors: AuthoringPslBlockDescriptorNamespace,
+): readonly DeclarationKeywordCompletionCandidate[] {
+  return descriptorBlockKeywords(descriptors).map((keyword) => ({
+    category: 'genericBlock',
+    label: keyword,
+    insertText: `${keyword} `,
+    snippetText: `${keyword} ${nameSnippetPlaceholder} {\n  $0\n}`,
+    detail: 'Generic block keyword',
+    kind: CompletionItemKind.Keyword,
+  }));
+}
+
+function descriptorBlockKeywords(
+  descriptors: AuthoringPslBlockDescriptorNamespace,
+): readonly string[] {
+  const keywords: string[] = [];
+  collectDescriptorBlockKeywords(descriptors, keywords);
+  return sortedUnique(keywords);
+}
+
+function collectDescriptorBlockKeywords(
+  descriptors: AuthoringPslBlockDescriptorNamespace,
+  keywords: string[],
+): void {
+  for (const value of Object.values(descriptors)) {
+    if (isAuthoringPslBlockDescriptor(value)) {
+      keywords.push(value.keyword);
+      continue;
+    }
+    collectDescriptorBlockKeywords(value, keywords);
+  }
+}
+
+function declarationKeywordSortText(candidate: DeclarationKeywordCompletionCandidate): string {
+  return `${declarationKeywordCategoryOrder[candidate.category]}:${candidate.label}`;
+}
+
+function provideGenericBlockKeyCompletionItems(
+  context: GenericBlockKeyCompletionContext,
+  sourceFile: SourceFile,
+  source: PslCompletionCandidateSource,
+): readonly CompletionItem[] {
+  const descriptor = findBlockDescriptor(source.pslBlockDescriptors, context.blockKeyword);
+  if (descriptor === undefined) {
+    return [];
+  }
+
+  const existing = existingGenericBlockParameterNames(context.block, context.offset);
+  const replacementRange = {
+    start: sourceFile.positionAt(context.replacementStartOffset),
+    end: sourceFile.positionAt(context.offset),
+  };
+
+  return Object.keys(descriptor.parameters)
+    .filter((parameterName) => !existing.has(parameterName))
+    .map((parameterName, index) => ({
+      label: parameterName,
+      kind: CompletionItemKind.Property,
+      detail: 'Generic block parameter',
+      sortText: genericBlockParameterSortText(index, parameterName),
+      filterText: parameterName,
+      textEdit: {
+        range: replacementRange,
+        newText: parameterName,
+      },
+    }));
+}
+
+function existingGenericBlockParameterNames(
+  block: GenericBlockDeclarationAst,
+  cursorOffset: number,
+): Set<string> {
+  const names = new Set<string>();
+  for (const entry of block.entries()) {
+    if (!entry.syntax.isOutside(cursorOffset)) {
+      continue;
+    }
+    const name = entry.key()?.name();
+    if (name !== undefined) {
+      names.add(name);
+    }
+  }
+  return names;
+}
+
+function provideModelTypeCompletionItems(
+  context: ModelTypeCompletionContext,
+  sourceFile: SourceFile,
+  source: PslCompletionCandidateSource,
+): readonly CompletionItem[] {
+  return modelTypeCompletionItems(context, sourceFile, [
+    ...configuredScalarCandidates(source.scalarTypes),
+    ...topLevelSymbolCandidates(source.symbolTable),
+    ...allNamespaceCandidates(source.symbolTable),
+  ]);
+}
+
+function provideNamespaceMemberCompletionItems(
+  context: NamespaceMemberCompletionContext,
+  sourceFile: SourceFile,
+  source: PslCompletionCandidateSource,
+): readonly CompletionItem[] {
+  // A foreign contract-space reference resolves against external symbols that no
+  // registry exposes yet; local namespace members must not stand in for them.
+  if (context.space !== undefined) {
+    return [];
+  }
+  return modelTypeCompletionItems(
+    context,
+    sourceFile,
+    namespaceCandidates(source.symbolTable?.topLevel.namespaces[context.namespace]),
+  );
+}
+
+function modelTypeCompletionItems(
+  context: ModelTypeCompletionContext | NamespaceMemberCompletionContext,
+  sourceFile: SourceFile,
+  candidates: readonly ModelTypeCompletionCandidate[],
+): readonly CompletionItem[] {
+  const replacementRange = {
+    start: sourceFile.positionAt(context.replacementStartOffset),
+    end: sourceFile.positionAt(context.offset),
+  };
+
+  return candidates.map((candidate) => ({
+    label: candidate.label,
+    kind: candidate.kind,
+    detail: candidate.detail,
+    sortText: sortText(candidate),
+    filterText: candidate.filterText,
+    textEdit: {
+      range: replacementRange,
+      newText: candidate.insertText,
+    },
+  }));
+}
+
+function configuredScalarCandidates(
+  scalarTypes: readonly string[],
+): readonly ModelTypeCompletionCandidate[] {
+  return sortedUnique(scalarTypes).map((name) => ({
+    category: 'configuredScalar',
+    label: name,
+    insertText: name,
+    filterText: name,
+    detail: 'Configured scalar type',
+    kind: CompletionItemKind.Keyword,
+  }));
+}
+
+function topLevelSymbolCandidates(
+  symbolTable: SymbolTable | undefined,
+): readonly ModelTypeCompletionCandidate[] {
+  if (symbolTable === undefined) {
+    return [];
+  }
+  const { topLevel } = symbolTable;
+  return [
+    ...symbolCandidates(
+      recordNames(topLevel.models),
+      'topLevelModel',
+      'Model',
+      CompletionItemKind.Class,
+    ),
+    ...symbolCandidates(
+      recordNames(topLevel.compositeTypes),
+      'topLevelCompositeType',
+      'Composite type',
+      CompletionItemKind.Struct,
+    ),
+    ...symbolCandidates(
+      recordNames(topLevel.scalars),
+      'scalar',
+      'Scalar type',
+      CompletionItemKind.Unit,
+    ),
+    ...symbolCandidates(
+      recordNames(topLevel.typeAliases),
+      'typeAlias',
+      'Type alias',
+      CompletionItemKind.Reference,
+    ),
+  ];
+}
+
+function allNamespaceCandidates(
+  symbolTable: SymbolTable | undefined,
+): readonly ModelTypeCompletionCandidate[] {
+  if (symbolTable === undefined) {
+    return [];
+  }
+  return Object.values(symbolTable.topLevel.namespaces)
+    .sort((left, right) => compareNames(left.name, right.name))
+    .map(namespaceQualifierCandidate);
+}
+
+function namespaceCandidates(
+  namespace: NamespaceSymbol | undefined,
+): readonly ModelTypeCompletionCandidate[] {
+  if (namespace === undefined) {
+    return [];
+  }
+  return [
+    ...symbolCandidates(
+      recordNames(namespace.models),
+      'namespaceModel',
+      `Model in namespace ${namespace.name}`,
+      CompletionItemKind.Class,
+    ),
+    ...symbolCandidates(
+      recordNames(namespace.compositeTypes),
+      'namespaceCompositeType',
+      `Composite type in namespace ${namespace.name}`,
+      CompletionItemKind.Struct,
+    ),
+  ];
+}
+
+function namespaceQualifierCandidate(namespace: NamespaceSymbol): ModelTypeCompletionCandidate {
+  return {
+    category: 'namespace',
+    label: namespace.name,
+    insertText: namespace.name,
+    filterText: namespace.name,
+    detail: 'Namespace',
+    kind: CompletionItemKind.Module,
+  };
+}
+
+function symbolCandidates(
+  names: readonly string[],
+  category: ModelTypeCompletionCandidateCategory,
+  detail: string,
+  kind: CompletionItemKind,
+): readonly ModelTypeCompletionCandidate[] {
+  return names.map((name) => ({
+    category,
+    label: name,
+    insertText: name,
+    filterText: name,
+    detail,
+    kind,
+  }));
+}
+
+function recordNames<T extends { readonly name: string }>(
+  record: Record<string, T>,
+): readonly string[] {
+  return Object.values(record)
+    .map((symbol) => symbol.name)
+    .sort(compareNames);
+}
+
+function sortedUnique(names: readonly string[]): readonly string[] {
+  return [...new Set(names)].sort(compareNames);
+}
+
+function sortText(candidate: ModelTypeCompletionCandidate): string {
+  return `${categoryOrder[candidate.category]}:${candidate.label}`;
+}
+
+function genericBlockParameterSortText(index: number, label: string): string {
+  return `${index.toString().padStart(4, '0')}:${label}`;
+}
+
+function compareNames(left: string, right: string): number {
+  if (left < right) return -1;
+  if (left > right) return 1;
+  return 0;
+}

package/src/semantic-tokens.ts

@@ -13,6 +13,7 @@ import {
   FieldDeclarationAst,
   FunctionCallAst,
   filterChildren,
+  findChildToken,
   type GenericBlockMemberAst,
   IdentifierAst,
   ModelDeclarationAst,
@@ -352,13 +353,15 @@ function collectAttribute(
   tokens: PendingSemanticToken[],
   namespace: string | undefined,
 ): void {
-  collectDecoratorName(attribute.name(), source.sourceFile.text, tokens);
+  const marker =
+    findChildToken(attribute.syntax, 'At') ?? findChildToken(attribute.syntax, 'DoubleAt');
+  collectDecoratorName(attribute.name(), marker, tokens);
   collectAttributeArgList(attribute.argList(), source, tokens, namespace);
 }
 
 function collectDecoratorName(
   name: QualifiedNameAst | undefined,
-  sourceText: string,
+  marker: SyntaxToken | undefined,
   tokens: PendingSemanticToken[],
 ): void {
   if (name === undefined) {
@@ -366,7 +369,7 @@ function collectDecoratorName(
   }
   const segments = identifierSegments(name);
   for (const [index, segment] of segments.entries()) {
-    tokens.push(rangeForDecoratorIdentifier(segment.identifier, sourceText, index === 0));
+    tokens.push(rangeForDecoratorIdentifier(segment.identifier, index === 0 ? marker : undefined));
   }
 }
 
@@ -622,20 +625,14 @@ function rangeForIdentifier(
 
 function rangeForDecoratorIdentifier(
   identifier: IdentifierAst,
-  sourceText: string,
-  includePrefix: boolean,
+  marker: SyntaxToken | undefined,
 ): PendingSemanticToken {
   const range = rangeForIdentifier(identifier, 'decorator');
-  if (!includePrefix) {
+  if (marker === undefined || marker.offset >= range.startOffset) {
     return range;
   }
-
-  let startOffset = range.startOffset;
-  while (startOffset > 0 && sourceText.charAt(startOffset - 1) === '@') {
-    startOffset--;
-  }
   return createPendingSemanticToken(
-    startOffset,
+    marker.offset,
     range.endOffset,
     'decorator',
     range.modifierBitset,