@difizen/libro-language-client 0.1.18

package/src/common/protocolDiagnostic.ts

@@ -0,0 +1,47 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import type { LSPAny } from '@difizen/vscode-languageserver-protocol';
+
+import * as Is from './utils/is.js';
+import type { Range, DiagnosticSeverity } from './vscodeAdaptor/vscodeAdaptor.js';
+import { Diagnostic } from './vscodeAdaptor/vscodeAdaptor.js';
+
+/**
+ * We keep this for a while to not break servers which adopted
+ * proposed API.
+ */
+export interface DiagnosticCode {
+  value: string | number;
+  target: string;
+}
+
+export namespace DiagnosticCode {
+  export function is(value: any): value is DiagnosticCode {
+    const candidate: DiagnosticCode = value as DiagnosticCode;
+    return (
+      candidate !== undefined &&
+      candidate !== null &&
+      (Is.number(candidate.value) || Is.string(candidate.value)) &&
+      Is.string(candidate.target)
+    );
+  }
+}
+
+export class ProtocolDiagnostic extends Diagnostic {
+  public readonly data: LSPAny | undefined;
+  public hasDiagnosticCode: boolean;
+
+  constructor(
+    range: Range,
+    message: string,
+    severity: DiagnosticSeverity,
+    data: LSPAny | undefined,
+  ) {
+    super(range, message, severity);
+    this.data = data;
+    this.hasDiagnosticCode = false;
+  }
+}

package/src/common/protocolDocumentLink.ts

@@ -0,0 +1,17 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import type { Uri } from 'vscode';
+
+import type { Range } from './vscodeAdaptor/vscodeAdaptor.js';
+import { DocumentLink } from './vscodeAdaptor/vscodeAdaptor.js';
+
+export default class ProtocolDocumentLink extends DocumentLink {
+  public data: any;
+
+  constructor(range: Range, target?: Uri | undefined) {
+    super(range, target);
+  }
+}

package/src/common/protocolInlayHint.ts

@@ -0,0 +1,21 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import type { InlayHintKind } from 'vscode';
+
+import type { InlayHintLabelPart, Position } from './vscodeAdaptor/vscodeAdaptor.js';
+import { InlayHint } from './vscodeAdaptor/vscodeAdaptor.js';
+
+export default class ProtocolInlayHint extends InlayHint {
+  public data: any;
+
+  constructor(
+    position: Position,
+    label: string | InlayHintLabelPart[],
+    kind?: InlayHintKind,
+  ) {
+    super(position, label, kind);
+  }
+}

package/src/common/protocolTypeHierarchyItem.ts

@@ -0,0 +1,29 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import type { LSPAny } from '@difizen/vscode-languageserver-protocol';
+import type { SymbolKind, Uri } from 'vscode';
+
+import type { Range } from './vscodeAdaptor/vscodeAdaptor.js';
+import { TypeHierarchyItem } from './vscodeAdaptor/vscodeAdaptor.js';
+
+export default class ProtocolTypeHierarchyItem extends TypeHierarchyItem {
+  public data?: LSPAny;
+
+  constructor(
+    kind: SymbolKind,
+    name: string,
+    detail: string,
+    uri: Uri,
+    range: Range,
+    selectionRange: Range,
+    data?: LSPAny,
+  ) {
+    super(kind, name, detail, uri, range, selectionRange);
+    if (data !== undefined) {
+      this.data = data;
+    }
+  }
+}

package/src/common/protocolWorkspaceSymbol.ts

@@ -0,0 +1,39 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import type { LSPAny } from '@difizen/vscode-languageserver-protocol';
+import type { SymbolKind } from 'vscode';
+
+import {
+  SymbolInformation,
+  Location,
+  Range,
+  Uri,
+} from './vscodeAdaptor/vscodeAdaptor.js';
+
+export default class WorkspaceSymbol extends SymbolInformation {
+  public data?: LSPAny;
+  public readonly hasRange: boolean;
+
+  constructor(
+    name: string,
+    kind: SymbolKind,
+    containerName: string,
+    locationOrUri: Location | Uri,
+    data: LSPAny | undefined,
+  ) {
+    const hasRange = !(locationOrUri instanceof Uri);
+    super(
+      name,
+      kind,
+      containerName,
+      hasRange ? locationOrUri : new Location(locationOrUri, new Range(0, 0, 0, 0)),
+    );
+    this.hasRange = hasRange;
+    if (data !== undefined) {
+      this.data = data;
+    }
+  }
+}

package/src/common/reference.ts

@@ -0,0 +1,144 @@
+/* --------------------------------------------------------------------------------------------
+ * 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,
+  DocumentSelector,
+  ReferenceOptions,
+  ReferenceRegistrationOptions,
+  ServerCapabilities,
+  TextDocumentRegistrationOptions,
+} from '@difizen/vscode-languageserver-protocol';
+import { ReferencesRequest } from '@difizen/vscode-languageserver-protocol';
+import type {
+  TextDocument,
+  Disposable,
+  Position as VPosition,
+  CancellationToken,
+  ProviderResult,
+  ReferenceProvider,
+  Location as VLocation,
+} 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 ProvideReferencesSignature {
+  (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    options: { includeDeclaration: boolean },
+    token: CancellationToken,
+  ): ProviderResult<VLocation[]>;
+}
+
+export interface ReferencesMiddleware {
+  provideReferences?: (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    options: { includeDeclaration: boolean },
+    token: CancellationToken,
+    next: ProvideReferencesSignature,
+  ) => ProviderResult<VLocation[]>;
+}
+
+export class ReferencesFeature extends TextDocumentLanguageFeature<
+  boolean | ReferenceOptions,
+  ReferenceRegistrationOptions,
+  ReferenceProvider,
+  ReferencesMiddleware
+> {
+  constructor(client: FeatureClient<ReferencesMiddleware>) {
+    super(client, ReferencesRequest.type);
+  }
+
+  public fillClientCapabilities(capabilities: ClientCapabilities): void {
+    ensure(ensure(capabilities, 'textDocument')!, 'references')!.dynamicRegistration =
+      true;
+  }
+
+  public initialize(
+    capabilities: ServerCapabilities,
+    documentSelector: DocumentSelector,
+  ): void {
+    const options = this.getRegistrationOptions(
+      documentSelector,
+      capabilities.referencesProvider,
+    );
+    if (!options) {
+      return;
+    }
+    this.register({ id: UUID.generateUuid(), registerOptions: options });
+  }
+
+  protected registerLanguageProvider(
+    options: TextDocumentRegistrationOptions,
+  ): [Disposable, ReferenceProvider] {
+    const selector = options.documentSelector!;
+    const provider: ReferenceProvider = {
+      provideReferences: (document, position, options, token) => {
+        const client = this._client;
+        const _providerReferences: ProvideReferencesSignature = (
+          document,
+          position,
+          options,
+          token,
+        ) => {
+          return client
+            .sendRequest(
+              ReferencesRequest.type,
+              client.code2ProtocolConverter.asReferenceParams(
+                document,
+                position,
+                options,
+              ),
+              token,
+            )
+            .then(
+              (result) => {
+                if (token.isCancellationRequested) {
+                  return null;
+                }
+                return client.protocol2CodeConverter.asReferences(result, token);
+              },
+              (error) => {
+                return client.handleFailedRequest(
+                  ReferencesRequest.type,
+                  token,
+                  error,
+                  null,
+                );
+              },
+            );
+        };
+        const middleware = client.middleware;
+        return middleware.provideReferences
+          ? middleware.provideReferences(
+              document,
+              position,
+              options,
+              token,
+              _providerReferences,
+            )
+          : _providerReferences(document, position, options, token);
+      },
+    };
+    return [this.registerProvider(selector, provider), provider];
+  }
+
+  private registerProvider(
+    selector: DocumentSelector,
+    provider: ReferenceProvider,
+  ): Disposable {
+    return Languages.registerReferenceProvider(
+      this._client.protocol2CodeConverter.asDocumentSelector(selector),
+      provider,
+    );
+  }
+}

package/src/common/rename.ts

@@ -0,0 +1,230 @@
+/* --------------------------------------------------------------------------------------------
+ * 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,
+  RenameOptions,
+  RenameRegistrationOptions,
+  RenameParams,
+  ResponseError,
+  TextDocumentPositionParams,
+} from '@difizen/vscode-languageserver-protocol';
+import {
+  RenameRequest,
+  PrepareSupportDefaultBehavior,
+  PrepareRenameRequest,
+  Range,
+} from '@difizen/vscode-languageserver-protocol';
+import type {
+  Disposable,
+  TextDocument,
+  ProviderResult,
+  Range as VRange,
+  Position as VPosition,
+  WorkspaceEdit as VWorkspaceEdit,
+  RenameProvider,
+} from 'vscode';
+
+import type { FeatureClient, DocumentSelectorOptions } from './features.js';
+import { TextDocumentLanguageFeature, ensure } from './features.js';
+import * as Is from './utils/is.js';
+import * as UUID from './utils/uuid.js';
+import { languages as Languages } from './vscodeAdaptor/vscodeAdaptor.js';
+
+export interface ProvideRenameEditsSignature {
+  (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    newName: string,
+    token: CancellationToken,
+  ): ProviderResult<VWorkspaceEdit>;
+}
+
+export interface PrepareRenameSignature {
+  (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    token: CancellationToken,
+  ): ProviderResult<VRange | { range: VRange; placeholder: string }>;
+}
+
+export interface RenameMiddleware {
+  provideRenameEdits?: (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    newName: string,
+    token: CancellationToken,
+    next: ProvideRenameEditsSignature,
+  ) => ProviderResult<VWorkspaceEdit>;
+  prepareRename?: (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    token: CancellationToken,
+    next: PrepareRenameSignature,
+  ) => ProviderResult<VRange | { range: VRange; placeholder: string }>;
+}
+
+type DefaultBehavior = {
+  defaultBehavior: boolean;
+};
+
+export class RenameFeature extends TextDocumentLanguageFeature<
+  boolean | RenameOptions,
+  RenameRegistrationOptions,
+  RenameProvider,
+  RenameMiddleware
+> {
+  constructor(client: FeatureClient<RenameMiddleware>) {
+    super(client, RenameRequest.type);
+  }
+
+  public fillClientCapabilities(capabilities: ClientCapabilities): void {
+    const rename = ensure(ensure(capabilities, 'textDocument')!, 'rename')!;
+    rename.dynamicRegistration = true;
+    rename.prepareSupport = true;
+    rename.prepareSupportDefaultBehavior = PrepareSupportDefaultBehavior.Identifier;
+    rename.honorsChangeAnnotations = true;
+  }
+
+  public initialize(
+    capabilities: ServerCapabilities,
+    documentSelector: DocumentSelector,
+  ): void {
+    const options = this.getRegistrationOptions(
+      documentSelector,
+      capabilities.renameProvider,
+    );
+    if (!options) {
+      return;
+    }
+    if (Is.boolean(capabilities.renameProvider)) {
+      options.prepareProvider = false;
+    }
+    this.register({ id: UUID.generateUuid(), registerOptions: options });
+  }
+
+  protected registerLanguageProvider(
+    options: RenameRegistrationOptions & DocumentSelectorOptions,
+  ): [Disposable, RenameProvider] {
+    const selector = options.documentSelector;
+    const provider: RenameProvider = {
+      provideRenameEdits: (document, position, newName, token) => {
+        const client = this._client;
+        const provideRenameEdits: ProvideRenameEditsSignature = (
+          document,
+          position,
+          newName,
+          token,
+        ) => {
+          const params: RenameParams = {
+            textDocument:
+              client.code2ProtocolConverter.asTextDocumentIdentifier(document),
+            position: client.code2ProtocolConverter.asPosition(position),
+            newName: newName,
+          };
+          return client.sendRequest(RenameRequest.type, params, token).then(
+            (result) => {
+              if (token.isCancellationRequested) {
+                return null;
+              }
+              return client.protocol2CodeConverter.asWorkspaceEdit(result, token);
+            },
+            (error: ResponseError<void>) => {
+              return client.handleFailedRequest(
+                RenameRequest.type,
+                token,
+                error,
+                null,
+                false,
+              );
+            },
+          );
+        };
+        const middleware = client.middleware;
+        return middleware.provideRenameEdits
+          ? middleware.provideRenameEdits(
+              document,
+              position,
+              newName,
+              token,
+              provideRenameEdits,
+            )
+          : provideRenameEdits(document, position, newName, token);
+      },
+      prepareRename: options.prepareProvider
+        ? (document, position, token) => {
+            const client = this._client;
+            const prepareRename: PrepareRenameSignature = (
+              document,
+              position,
+              token,
+            ) => {
+              const params: TextDocumentPositionParams = {
+                textDocument:
+                  client.code2ProtocolConverter.asTextDocumentIdentifier(document),
+                position: client.code2ProtocolConverter.asPosition(position),
+              };
+              return client.sendRequest(PrepareRenameRequest.type, params, token).then(
+                (result) => {
+                  if (token.isCancellationRequested) {
+                    return null;
+                  }
+                  if (Range.is(result)) {
+                    return client.protocol2CodeConverter.asRange(result);
+                  } else if (this.isDefaultBehavior(result)) {
+                    return result.defaultBehavior === true
+                      ? null
+                      : Promise.reject(new Error(`The element can't be renamed.`));
+                  } else if (result && Range.is(result.range)) {
+                    return {
+                      range: client.protocol2CodeConverter.asRange(result.range),
+                      placeholder: result.placeholder,
+                    };
+                  }
+                  // To cancel the rename vscode API expects a rejected promise.
+                  // eslint-disable-next-line promise/no-return-wrap
+                  return Promise.reject(new Error(`The element can't be renamed.`));
+                },
+                (error: ResponseError<void>) => {
+                  if (typeof error.message === 'string') {
+                    throw new Error(error.message);
+                  } else {
+                    throw new Error(`The element can't be renamed.`);
+                  }
+                },
+              );
+            };
+            const middleware = client.middleware;
+            return middleware.prepareRename
+              ? middleware.prepareRename(document, position, token, prepareRename)
+              : prepareRename(document, position, token);
+          }
+        : undefined,
+    };
+    return [this.registerProvider(selector, provider), provider];
+  }
+
+  private registerProvider(
+    selector: RenameOptions & DocumentSelector,
+    provider: RenameProvider,
+  ): Disposable {
+    return Languages.registerRenameProvider(
+      this._client.protocol2CodeConverter.asDocumentSelector(selector),
+      provider,
+    );
+  }
+
+  private isDefaultBehavior(value: any): value is DefaultBehavior {
+    const candidate: DefaultBehavior = value;
+    return candidate && Is.boolean(candidate.defaultBehavior);
+  }
+}

package/src/common/selectionRange.ts

@@ -0,0 +1,136 @@
+/* --------------------------------------------------------------------------------------------
+ * 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,
+  SelectionRangeParams,
+  SelectionRangeOptions,
+  SelectionRangeRegistrationOptions,
+} from '@difizen/vscode-languageserver-protocol';
+import { SelectionRangeRequest } from '@difizen/vscode-languageserver-protocol';
+import type {
+  Disposable,
+  TextDocument,
+  ProviderResult,
+  Position as VPosition,
+  SelectionRange as VSelectionRange,
+  SelectionRangeProvider,
+} from 'vscode';
+
+import type { FeatureClient } from './features.js';
+import { TextDocumentLanguageFeature, ensure } from './features.js';
+import { languages as Languages } from './vscodeAdaptor/vscodeAdaptor.js';
+
+export interface ProvideSelectionRangeSignature {
+  (
+    this: void,
+    document: TextDocument,
+    positions: readonly VPosition[],
+    token: CancellationToken,
+  ): ProviderResult<VSelectionRange[]>;
+}
+
+export interface SelectionRangeProviderMiddleware {
+  provideSelectionRanges?: (
+    this: void,
+    document: TextDocument,
+    positions: readonly VPosition[],
+    token: CancellationToken,
+    next: ProvideSelectionRangeSignature,
+  ) => ProviderResult<VSelectionRange[]>;
+}
+
+export class SelectionRangeFeature extends TextDocumentLanguageFeature<
+  boolean | SelectionRangeOptions,
+  SelectionRangeRegistrationOptions,
+  SelectionRangeProvider,
+  SelectionRangeProviderMiddleware
+> {
+  constructor(client: FeatureClient<SelectionRangeProviderMiddleware>) {
+    super(client, SelectionRangeRequest.type);
+  }
+
+  public fillClientCapabilities(capabilities: ClientCapabilities): void {
+    const capability = ensure(ensure(capabilities, 'textDocument')!, 'selectionRange')!;
+    capability.dynamicRegistration = true;
+  }
+
+  public initialize(
+    capabilities: ServerCapabilities,
+    documentSelector: DocumentSelector,
+  ): void {
+    const [id, options] = this.getRegistration(
+      documentSelector,
+      capabilities.selectionRangeProvider,
+    );
+    if (!id || !options) {
+      return;
+    }
+    this.register({ id: id, registerOptions: options });
+  }
+
+  protected registerLanguageProvider(
+    options: SelectionRangeRegistrationOptions,
+  ): [Disposable, SelectionRangeProvider] {
+    const selector = options.documentSelector!;
+    const provider: SelectionRangeProvider = {
+      provideSelectionRanges: (document, positions, token) => {
+        const client = this._client;
+        const provideSelectionRanges: ProvideSelectionRangeSignature = async (
+          document,
+          positions,
+          token,
+        ) => {
+          const requestParams: SelectionRangeParams = {
+            textDocument:
+              client.code2ProtocolConverter.asTextDocumentIdentifier(document),
+            positions: client.code2ProtocolConverter.asPositionsSync(positions, token),
+          };
+          return client
+            .sendRequest(SelectionRangeRequest.type, requestParams, token)
+            .then(
+              (ranges) => {
+                if (token.isCancellationRequested) {
+                  return null;
+                }
+                return client.protocol2CodeConverter.asSelectionRanges(ranges, token);
+              },
+              (error: any) => {
+                return client.handleFailedRequest(
+                  SelectionRangeRequest.type,
+                  token,
+                  error,
+                  null,
+                );
+              },
+            );
+        };
+        const middleware = client.middleware;
+        return middleware.provideSelectionRanges
+          ? middleware.provideSelectionRanges(
+              document,
+              positions,
+              token,
+              provideSelectionRanges,
+            )
+          : provideSelectionRanges(document, positions, token);
+      },
+    };
+    return [this.registerProvider(selector, provider), provider];
+  }
+
+  private registerProvider(
+    selector: DocumentSelector,
+    provider: SelectionRangeProvider,
+  ): Disposable {
+    return Languages.registerSelectionRangeProvider(
+      this._client.protocol2CodeConverter.asDocumentSelector(selector),
+      provider,
+    );
+  }
+}