@difizen/libro-language-client 0.1.18

package/src/common/implementation.ts

@@ -0,0 +1,142 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import type {
+  ClientCapabilities,
+  CancellationToken,
+  ServerCapabilities,
+  DocumentSelector,
+  ImplementationRegistrationOptions,
+  ImplementationOptions,
+} from '@difizen/vscode-languageserver-protocol';
+import { ImplementationRequest } from '@difizen/vscode-languageserver-protocol';
+import type {
+  Disposable,
+  TextDocument,
+  ProviderResult,
+  Position as VPosition,
+  Definition as VDefinition,
+  DefinitionLink as VDefinitionLink,
+  ImplementationProvider,
+} from 'vscode';
+
+import type { FeatureClient } from './features.js';
+import { TextDocumentLanguageFeature, ensure } from './features.js';
+import { languages as Languages } from './vscodeAdaptor/vscodeAdaptor.js';
+
+export interface ProvideImplementationSignature {
+  (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    token: CancellationToken,
+  ): ProviderResult<VDefinition | VDefinitionLink[]>;
+}
+
+export interface ImplementationMiddleware {
+  provideImplementation?: (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    token: CancellationToken,
+    next: ProvideImplementationSignature,
+  ) => ProviderResult<VDefinition | VDefinitionLink[]>;
+}
+
+export class ImplementationFeature extends TextDocumentLanguageFeature<
+  boolean | ImplementationOptions,
+  ImplementationRegistrationOptions,
+  ImplementationProvider,
+  ImplementationMiddleware
+> {
+  constructor(client: FeatureClient<ImplementationMiddleware>) {
+    super(client, ImplementationRequest.type);
+  }
+
+  public fillClientCapabilities(capabilities: ClientCapabilities): void {
+    const implementationSupport = ensure(
+      ensure(capabilities, 'textDocument')!,
+      'implementation',
+    )!;
+    implementationSupport.dynamicRegistration = true;
+    implementationSupport.linkSupport = true;
+  }
+
+  public initialize(
+    capabilities: ServerCapabilities,
+    documentSelector: DocumentSelector,
+  ): void {
+    const [id, options] = this.getRegistration(
+      documentSelector,
+      capabilities.implementationProvider,
+    );
+    if (!id || !options) {
+      return;
+    }
+    this.register({ id: id, registerOptions: options });
+  }
+
+  protected registerLanguageProvider(
+    options: ImplementationRegistrationOptions,
+  ): [Disposable, ImplementationProvider] {
+    const selector = options.documentSelector!;
+    const provider: ImplementationProvider = {
+      provideImplementation: (document, position, token) => {
+        const client = this._client;
+        const provideImplementation: ProvideImplementationSignature = (
+          document,
+          position,
+          token,
+        ) => {
+          return client
+            .sendRequest(
+              ImplementationRequest.type,
+              client.code2ProtocolConverter.asTextDocumentPositionParams(
+                document,
+                position,
+              ),
+              token,
+            )
+            .then(
+              (result) => {
+                if (token.isCancellationRequested) {
+                  return null;
+                }
+                return client.protocol2CodeConverter.asDefinitionResult(result, token);
+              },
+              (error) => {
+                return client.handleFailedRequest(
+                  ImplementationRequest.type,
+                  token,
+                  error,
+                  null,
+                );
+              },
+            );
+        };
+        const middleware = client.middleware;
+        return middleware.provideImplementation
+          ? middleware.provideImplementation(
+              document,
+              position,
+              token,
+              provideImplementation,
+            )
+          : provideImplementation(document, position, token);
+      },
+    };
+    return [this.registerProvider(selector, provider), provider];
+  }
+
+  private registerProvider(
+    selector: DocumentSelector,
+    provider: ImplementationProvider,
+  ): Disposable {
+    return Languages.registerImplementationProvider(
+      this._client.protocol2CodeConverter.asDocumentSelector(selector),
+      provider,
+    );
+  }
+}

package/src/common/inlayHint.ts

@@ -0,0 +1,201 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import type {
+  ClientCapabilities,
+  CancellationToken,
+  ServerCapabilities,
+  DocumentSelector,
+  InlayHintOptions,
+  InlayHintRegistrationOptions,
+  InlayHintParams,
+} from '@difizen/vscode-languageserver-protocol';
+import {
+  InlayHintRequest,
+  InlayHintRefreshRequest,
+  InlayHintResolveRequest,
+} from '@difizen/vscode-languageserver-protocol';
+import type {
+  Disposable,
+  TextDocument,
+  ProviderResult,
+  Range as VRange,
+  InlayHint as VInlayHint,
+  InlayHintsProvider,
+} from 'vscode';
+
+import type { FeatureClient } from './features.js';
+import { TextDocumentLanguageFeature, ensure } from './features.js';
+import { languages as Languages, EventEmitter } from './vscodeAdaptor/vscodeAdaptor.js';
+
+export type ProvideInlayHintsSignature = (
+  this: void,
+  document: TextDocument,
+  viewPort: VRange,
+  token: CancellationToken,
+) => ProviderResult<VInlayHint[]>;
+export type ResolveInlayHintSignature = (
+  this: void,
+  item: VInlayHint,
+  token: CancellationToken,
+) => ProviderResult<VInlayHint>;
+
+export type InlayHintsMiddleware = {
+  provideInlayHints?: (
+    this: void,
+    document: TextDocument,
+    viewPort: VRange,
+    token: CancellationToken,
+    next: ProvideInlayHintsSignature,
+  ) => ProviderResult<VInlayHint[]>;
+  resolveInlayHint?: (
+    this: void,
+    item: VInlayHint,
+    token: CancellationToken,
+    next: ResolveInlayHintSignature,
+  ) => ProviderResult<VInlayHint>;
+};
+
+export type InlayHintsProviderShape = {
+  provider: InlayHintsProvider;
+  onDidChangeInlayHints: EventEmitter<void>;
+};
+
+export class InlayHintsFeature extends TextDocumentLanguageFeature<
+  boolean | InlayHintOptions,
+  InlayHintRegistrationOptions,
+  InlayHintsProviderShape,
+  InlayHintsMiddleware
+> {
+  constructor(client: FeatureClient<InlayHintsMiddleware>) {
+    super(client, InlayHintRequest.type);
+  }
+
+  public fillClientCapabilities(capabilities: ClientCapabilities): void {
+    const inlayHint = ensure(ensure(capabilities, 'textDocument')!, 'inlayHint')!;
+    inlayHint.dynamicRegistration = true;
+    inlayHint.resolveSupport = {
+      properties: [
+        'tooltip',
+        'textEdits',
+        'label.tooltip',
+        'label.location',
+        'label.command',
+      ],
+    };
+    ensure(ensure(capabilities, 'workspace')!, 'inlayHint')!.refreshSupport = true;
+  }
+
+  public initialize(
+    capabilities: ServerCapabilities,
+    documentSelector: DocumentSelector,
+  ): void {
+    this._client.onRequest(InlayHintRefreshRequest.type, async () => {
+      for (const provider of this.getAllProviders()) {
+        provider.onDidChangeInlayHints.fire();
+      }
+    });
+
+    const [id, options] = this.getRegistration(
+      documentSelector,
+      capabilities.inlayHintProvider,
+    );
+    if (!id || !options) {
+      return;
+    }
+    this.register({ id: id, registerOptions: options });
+  }
+
+  protected registerLanguageProvider(
+    options: InlayHintRegistrationOptions,
+  ): [Disposable, InlayHintsProviderShape] {
+    const selector = options.documentSelector!;
+    const eventEmitter: EventEmitter<void> = new EventEmitter<void>();
+    const provider: InlayHintsProvider = {
+      onDidChangeInlayHints: eventEmitter.event,
+      provideInlayHints: (document, viewPort, token) => {
+        const client = this._client;
+        const provideInlayHints: ProvideInlayHintsSignature = async (
+          document,
+          viewPort,
+          token,
+        ) => {
+          const requestParams: InlayHintParams = {
+            textDocument:
+              client.code2ProtocolConverter.asTextDocumentIdentifier(document),
+            range: client.code2ProtocolConverter.asRange(viewPort),
+          };
+          try {
+            const values = await client.sendRequest(
+              InlayHintRequest.type,
+              requestParams,
+              token,
+            );
+            if (token.isCancellationRequested) {
+              return null;
+            }
+            return client.protocol2CodeConverter.asInlayHints(values, token);
+          } catch (error) {
+            return client.handleFailedRequest(
+              InlayHintRequest.type,
+              token,
+              error,
+              null,
+            );
+          }
+        };
+        const middleware = client.middleware;
+        return middleware.provideInlayHints
+          ? middleware.provideInlayHints(document, viewPort, token, provideInlayHints)
+          : provideInlayHints(document, viewPort, token);
+      },
+    };
+    provider.resolveInlayHint =
+      options.resolveProvider === true
+        ? (hint, token) => {
+            const client = this._client;
+            const resolveInlayHint: ResolveInlayHintSignature = async (item, token) => {
+              try {
+                const value = await client.sendRequest(
+                  InlayHintResolveRequest.type,
+                  client.code2ProtocolConverter.asInlayHint(item),
+                  token,
+                );
+                if (token.isCancellationRequested) {
+                  return null;
+                }
+                const result = client.protocol2CodeConverter.asInlayHint(value, token);
+                return token.isCancellationRequested ? null : result;
+              } catch (error) {
+                return client.handleFailedRequest(
+                  InlayHintResolveRequest.type,
+                  token,
+                  error,
+                  null,
+                );
+              }
+            };
+            const middleware = client.middleware;
+            return middleware.resolveInlayHint
+              ? middleware.resolveInlayHint(hint, token, resolveInlayHint)
+              : resolveInlayHint(hint, token);
+          }
+        : undefined;
+    return [
+      this.registerProvider(selector, provider),
+      { provider: provider, onDidChangeInlayHints: eventEmitter },
+    ];
+  }
+
+  private registerProvider(
+    selector: DocumentSelector,
+    provider: InlayHintsProvider,
+  ): Disposable {
+    return Languages.registerInlayHintsProvider(
+      this._client.protocol2CodeConverter.asDocumentSelector(selector),
+      provider,
+    );
+  }
+}

package/src/common/inlineCompletion.ts

@@ -0,0 +1,160 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import type {
+  ClientCapabilities,
+  InlineCompletionOptions,
+  InlineCompletionRegistrationOptions,
+  DocumentSelector,
+  ServerCapabilities,
+} from '@difizen/vscode-languageserver-protocol';
+import { InlineCompletionRequest } from '@difizen/vscode-languageserver-protocol';
+import type {
+  TextDocument,
+  Disposable,
+  Position as VPosition,
+  InlineCompletionContext as VInlineCompletionContext,
+  CancellationToken,
+  ProviderResult,
+  InlineCompletionItem as VInlineCompletionItem,
+  InlineCompletionList as VInlineCompletionList,
+  InlineCompletionItemProvider,
+} from 'vscode';
+
+import type { FeatureClient } from './features.js';
+import { ensure, TextDocumentLanguageFeature } from './features.js';
+import * as UUID from './utils/uuid.js';
+import { languages as Languages } from './vscodeAdaptor/vscodeAdaptor.js';
+
+export interface ProvideInlineCompletionItemsSignature {
+  (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    context: VInlineCompletionContext,
+    token: CancellationToken,
+  ): ProviderResult<VInlineCompletionItem[] | VInlineCompletionList>;
+}
+
+export interface InlineCompletionMiddleware {
+  provideInlineCompletionItems?: (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    context: VInlineCompletionContext,
+    token: CancellationToken,
+    next: ProvideInlineCompletionItemsSignature,
+  ) => ProviderResult<VInlineCompletionItem[] | VInlineCompletionList>;
+}
+
+export type InlineCompletionProviderShape = {
+  provider: InlineCompletionItemProvider;
+};
+
+export class InlineCompletionItemFeature extends TextDocumentLanguageFeature<
+  boolean | InlineCompletionOptions,
+  InlineCompletionRegistrationOptions,
+  InlineCompletionItemProvider,
+  InlineCompletionMiddleware
+> {
+  constructor(client: FeatureClient<InlineCompletionMiddleware>) {
+    super(client, InlineCompletionRequest.type);
+  }
+
+  public fillClientCapabilities(capabilities: ClientCapabilities): void {
+    const inlineCompletion = ensure(
+      ensure(capabilities, 'textDocument')!,
+      'inlineCompletion',
+    )!;
+    inlineCompletion.dynamicRegistration = true;
+  }
+
+  public initialize(
+    capabilities: ServerCapabilities,
+    documentSelector: DocumentSelector,
+  ): void {
+    const options = this.getRegistrationOptions(
+      documentSelector,
+      capabilities.inlineCompletionProvider,
+    );
+    if (!options) {
+      return;
+    }
+
+    this.register({
+      id: UUID.generateUuid(),
+      registerOptions: options,
+    });
+  }
+
+  protected registerLanguageProvider(
+    options: InlineCompletionRegistrationOptions,
+  ): [Disposable, InlineCompletionItemProvider] {
+    const selector = options.documentSelector!;
+    const provider: InlineCompletionItemProvider = {
+      provideInlineCompletionItems: (
+        document: TextDocument,
+        position: VPosition,
+        context: VInlineCompletionContext,
+        token: CancellationToken,
+      ): ProviderResult<VInlineCompletionList | VInlineCompletionItem[]> => {
+        const client = this._client;
+        const middleware = this._client.middleware;
+        const provideInlineCompletionItems: ProvideInlineCompletionItemsSignature = (
+          document,
+          position,
+          context,
+          token,
+        ) => {
+          return client
+            .sendRequest(
+              InlineCompletionRequest.type,
+              client.code2ProtocolConverter.asInlineCompletionParams(
+                document,
+                position,
+                context,
+              ),
+              token,
+            )
+            .then(
+              (result) => {
+                if (token.isCancellationRequested) {
+                  return null;
+                }
+                return client.protocol2CodeConverter.asInlineCompletionResult(
+                  result,
+                  token,
+                );
+              },
+              (error) => {
+                return client.handleFailedRequest(
+                  InlineCompletionRequest.type,
+                  token,
+                  error,
+                  null,
+                );
+              },
+            );
+        };
+        return middleware.provideInlineCompletionItems
+          ? middleware.provideInlineCompletionItems(
+              document,
+              position,
+              context,
+              token,
+              provideInlineCompletionItems,
+            )
+          : provideInlineCompletionItems(document, position, context, token);
+      },
+    };
+    return [
+      Languages.registerInlineCompletionItemProvider(
+        this._client.protocol2CodeConverter.asDocumentSelector(selector),
+        provider,
+      ),
+      provider,
+    ];
+  }
+}

package/src/common/inlineValue.ts

@@ -0,0 +1,158 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import type {
+  ClientCapabilities,
+  CancellationToken,
+  ServerCapabilities,
+  DocumentSelector,
+  InlineValueOptions,
+  InlineValueRegistrationOptions,
+  InlineValueParams,
+} from '@difizen/vscode-languageserver-protocol';
+import {
+  InlineValueRefreshRequest,
+  InlineValueRequest,
+} from '@difizen/vscode-languageserver-protocol';
+import type {
+  Disposable,
+  TextDocument,
+  ProviderResult,
+  Range as VRange,
+  InlineValueContext as VInlineValueContext,
+  InlineValue as VInlineValue,
+  InlineValuesProvider,
+} from 'vscode';
+
+import type { FeatureClient } from './features.js';
+import { TextDocumentLanguageFeature, ensure } from './features.js';
+import { languages as Languages, EventEmitter } from './vscodeAdaptor/vscodeAdaptor.js';
+
+export type ProvideInlineValuesSignature = (
+  this: void,
+  document: TextDocument,
+  viewPort: VRange,
+  context: VInlineValueContext,
+  token: CancellationToken,
+) => ProviderResult<VInlineValue[]>;
+
+export type InlineValueMiddleware = {
+  provideInlineValues?: (
+    this: void,
+    document: TextDocument,
+    viewPort: VRange,
+    context: VInlineValueContext,
+    token: CancellationToken,
+    next: ProvideInlineValuesSignature,
+  ) => ProviderResult<VInlineValue[]>;
+};
+
+export type InlineValueProviderShape = {
+  provider: InlineValuesProvider;
+  onDidChangeInlineValues: EventEmitter<void>;
+};
+
+export class InlineValueFeature extends TextDocumentLanguageFeature<
+  boolean | InlineValueOptions,
+  InlineValueRegistrationOptions,
+  InlineValueProviderShape,
+  InlineValueMiddleware
+> {
+  constructor(client: FeatureClient<InlineValueMiddleware>) {
+    super(client, InlineValueRequest.type);
+  }
+
+  public fillClientCapabilities(capabilities: ClientCapabilities): void {
+    ensure(ensure(capabilities, 'textDocument')!, 'inlineValue')!.dynamicRegistration =
+      true;
+    ensure(ensure(capabilities, 'workspace')!, 'inlineValue')!.refreshSupport = true;
+  }
+
+  public initialize(
+    capabilities: ServerCapabilities,
+    documentSelector: DocumentSelector,
+  ): void {
+    this._client.onRequest(InlineValueRefreshRequest.type, async () => {
+      for (const provider of this.getAllProviders()) {
+        provider.onDidChangeInlineValues.fire();
+      }
+    });
+
+    const [id, options] = this.getRegistration(
+      documentSelector,
+      capabilities.inlineValueProvider,
+    );
+    if (!id || !options) {
+      return;
+    }
+    this.register({ id: id, registerOptions: options });
+  }
+
+  protected registerLanguageProvider(
+    options: InlineValueRegistrationOptions,
+  ): [Disposable, InlineValueProviderShape] {
+    const selector = options.documentSelector!;
+    const eventEmitter: EventEmitter<void> = new EventEmitter<void>();
+    const provider: InlineValuesProvider = {
+      onDidChangeInlineValues: eventEmitter.event,
+      provideInlineValues: (document, viewPort, context, token) => {
+        const client = this._client;
+        const provideInlineValues: ProvideInlineValuesSignature = (
+          document,
+          viewPort,
+          context,
+          token,
+        ) => {
+          const requestParams: InlineValueParams = {
+            textDocument:
+              client.code2ProtocolConverter.asTextDocumentIdentifier(document),
+            range: client.code2ProtocolConverter.asRange(viewPort),
+            context: client.code2ProtocolConverter.asInlineValueContext(context),
+          };
+          return client.sendRequest(InlineValueRequest.type, requestParams, token).then(
+            (values) => {
+              if (token.isCancellationRequested) {
+                return null;
+              }
+              return client.protocol2CodeConverter.asInlineValues(values, token);
+            },
+            (error: any) => {
+              return client.handleFailedRequest(
+                InlineValueRequest.type,
+                token,
+                error,
+                null,
+              );
+            },
+          );
+        };
+        const middleware = client.middleware;
+        return middleware.provideInlineValues
+          ? middleware.provideInlineValues(
+              document,
+              viewPort,
+              context,
+              token,
+              provideInlineValues,
+            )
+          : provideInlineValues(document, viewPort, context, token);
+      },
+    };
+    return [
+      this.registerProvider(selector, provider),
+      { provider: provider, onDidChangeInlineValues: eventEmitter },
+    ];
+  }
+
+  private registerProvider(
+    selector: DocumentSelector,
+    provider: InlineValuesProvider,
+  ): Disposable {
+    return Languages.registerInlineValuesProvider(
+      this._client.protocol2CodeConverter.asDocumentSelector(selector),
+      provider,
+    );
+  }
+}