@difizen/libro-language-client 0.1.18

package/src/common/configuration.ts

@@ -0,0 +1,338 @@
+/* --------------------------------------------------------------------------------------------
+ * 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,
+  DidChangeConfigurationRegistrationOptions,
+  RegistrationType,
+} from '@difizen/vscode-languageserver-protocol';
+import {
+  ConfigurationRequest,
+  DidChangeConfigurationNotification,
+} from '@difizen/vscode-languageserver-protocol';
+import type {
+  Uri,
+  Disposable,
+  ConfigurationChangeEvent,
+  FileSystemWatcher as VFileSystemWatcher,
+  WorkspaceFolder as VWorkspaceFolder,
+} from 'vscode';
+
+import type {
+  StaticFeature,
+  FeatureClient,
+  FeatureState,
+  DynamicFeature,
+  RegistrationData,
+} from './features.js';
+import { ensure } from './features.js';
+import * as Is from './utils/is.js';
+import * as UUID from './utils/uuid.js';
+import { workspace } from './vscodeAdaptor/vscodeAdaptor.js';
+
+export interface ConfigurationMiddleware {
+  configuration?: ConfigurationRequest.MiddlewareSignature;
+}
+
+interface ConfigurationWorkspaceMiddleware {
+  workspace?: ConfigurationMiddleware;
+}
+
+/**
+ * Configuration pull model. From server to client.
+ */
+export class ConfigurationFeature implements StaticFeature {
+  private readonly _client: FeatureClient<ConfigurationWorkspaceMiddleware>;
+
+  constructor(client: FeatureClient<ConfigurationWorkspaceMiddleware>) {
+    this._client = client;
+  }
+
+  getState(): FeatureState {
+    return { kind: 'static' };
+  }
+
+  public fillClientCapabilities(capabilities: ClientCapabilities): void {
+    capabilities.workspace = capabilities.workspace || {};
+    capabilities.workspace!.configuration = true;
+  }
+
+  public initialize(): void {
+    const client = this._client;
+    client.onRequest(ConfigurationRequest.type, (params, token) => {
+      const configuration: ConfigurationRequest.HandlerSignature = (params) => {
+        const result: any[] = [];
+        for (const item of params.items) {
+          const resource =
+            item.scopeUri !== void 0 && item.scopeUri !== null
+              ? this._client.protocol2CodeConverter.asUri(item.scopeUri)
+              : undefined;
+          result.push(
+            this.getConfiguration(
+              resource,
+              item.section !== null ? item.section : undefined,
+            ),
+          );
+        }
+        return result;
+      };
+      const middleware = client.middleware.workspace;
+      return middleware && middleware.configuration
+        ? middleware.configuration(params, token, configuration)
+        : configuration(params, token);
+    });
+  }
+
+  private getConfiguration(
+    resource: Uri | undefined,
+    section: string | undefined,
+  ): any {
+    let result: any = null;
+    if (section) {
+      const index = section.lastIndexOf('.');
+      if (index === -1) {
+        result = toJSONObject(
+          workspace.getConfiguration(undefined, resource).get(section),
+        );
+      } else {
+        const config = workspace.getConfiguration(section.substr(0, index), resource);
+        if (config) {
+          result = toJSONObject(config.get(section.substr(index + 1)));
+        }
+      }
+    } else {
+      const config = workspace.getConfiguration(undefined, resource);
+      result = {};
+      for (const key of Object.keys(config)) {
+        if (config.has(key)) {
+          result[key] = toJSONObject(config.get(key));
+        }
+      }
+    }
+    if (result === undefined) {
+      result = null;
+    }
+    return result;
+  }
+
+  public clear(): void {
+    return;
+  }
+}
+
+export function toJSONObject(obj: any): any {
+  if (obj) {
+    if (Array.isArray(obj)) {
+      return obj.map(toJSONObject);
+    } else if (typeof obj === 'object') {
+      const res = Object.create(null);
+      for (const key in obj) {
+        if (Object.prototype.hasOwnProperty.call(obj, key)) {
+          res[key] = toJSONObject(obj[key]);
+        }
+      }
+      return res;
+    }
+  }
+  return obj;
+}
+
+export interface DidChangeConfigurationSignature {
+  (this: void, sections: string[] | undefined): Promise<void>;
+}
+
+export interface DidChangeConfigurationMiddleware {
+  didChangeConfiguration?: (
+    this: void,
+    sections: string[] | undefined,
+    next: DidChangeConfigurationSignature,
+  ) => Promise<void>;
+}
+
+interface DidChangeConfigurationWorkspaceMiddleware {
+  workspace?: DidChangeConfigurationMiddleware;
+}
+
+export type SynchronizeOptions = {
+  /**
+   * The configuration sections to synchronize. Pushing settings from the
+   * client to the server is deprecated in favour of the new pull model
+   * that allows servers to query settings scoped on resources. In this
+   * model the client can only deliver an empty change event since the
+   * actually setting value can vary on the provided resource scope.
+   *
+   * @deprecated Use the new pull model (`workspace/configuration` request)
+   */
+  configurationSection?: string | string[];
+
+  /**
+   * Asks the client to send file change events to the server. Watchers
+   * operate on workspace folders. The LSP client doesn't support watching
+   * files outside a workspace folder.
+   */
+  fileEvents?: VFileSystemWatcher | VFileSystemWatcher[];
+};
+
+export type $ConfigurationOptions = {
+  synchronize?: SynchronizeOptions;
+  workspaceFolder?: VWorkspaceFolder;
+};
+
+export class SyncConfigurationFeature
+  implements DynamicFeature<DidChangeConfigurationRegistrationOptions>
+{
+  private isCleared: boolean;
+  private readonly _listeners: Map<string, Disposable>;
+
+  constructor(
+    private _client: FeatureClient<
+      DidChangeConfigurationWorkspaceMiddleware,
+      $ConfigurationOptions
+    >,
+  ) {
+    this.isCleared = false;
+    this._listeners = new Map();
+  }
+
+  public getState(): FeatureState {
+    return {
+      kind: 'workspace',
+      id: this.registrationType.method,
+      registrations: this._listeners.size > 0,
+    };
+  }
+
+  public get registrationType(): RegistrationType<DidChangeConfigurationRegistrationOptions> {
+    return DidChangeConfigurationNotification.type;
+  }
+
+  public fillClientCapabilities(capabilities: ClientCapabilities): void {
+    ensure(
+      ensure(capabilities, 'workspace')!,
+      'didChangeConfiguration',
+    )!.dynamicRegistration = true;
+  }
+
+  public initialize(): void {
+    this.isCleared = false;
+    const section = this._client.clientOptions.synchronize?.configurationSection;
+    if (section !== undefined) {
+      this.register({
+        id: UUID.generateUuid(),
+        registerOptions: {
+          section: section,
+        },
+      });
+    }
+  }
+
+  public register(
+    data: RegistrationData<DidChangeConfigurationRegistrationOptions>,
+  ): void {
+    const disposable = workspace.onDidChangeConfiguration((event) => {
+      this.onDidChangeConfiguration(data.registerOptions.section, event);
+    });
+    this._listeners.set(data.id, disposable);
+    if (data.registerOptions.section !== undefined) {
+      this.onDidChangeConfiguration(data.registerOptions.section, undefined);
+    }
+  }
+
+  public unregister(id: string): void {
+    const disposable = this._listeners.get(id);
+    if (disposable) {
+      this._listeners.delete(id);
+      disposable.dispose();
+    }
+  }
+
+  public clear(): void {
+    for (const disposable of this._listeners.values()) {
+      disposable.dispose();
+    }
+    this._listeners.clear();
+    this.isCleared = true;
+  }
+
+  private onDidChangeConfiguration(
+    configurationSection: string | string[] | undefined,
+    event: ConfigurationChangeEvent | undefined,
+  ): void {
+    if (this.isCleared) {
+      return;
+    }
+    let sections: string[] | undefined;
+    if (Is.string(configurationSection)) {
+      sections = [configurationSection];
+    } else {
+      sections = configurationSection;
+    }
+    if (sections !== undefined && event !== undefined) {
+      const affected = sections.some((section) => event.affectsConfiguration(section));
+      if (!affected) {
+        return;
+      }
+    }
+    const didChangeConfiguration = async (
+      sections: string[] | undefined,
+    ): Promise<void> => {
+      if (sections === undefined) {
+        return this._client.sendNotification(DidChangeConfigurationNotification.type, {
+          settings: null,
+        });
+      } else {
+        return this._client.sendNotification(DidChangeConfigurationNotification.type, {
+          settings: this.extractSettingsInformation(sections),
+        });
+      }
+    };
+    const middleware = this._client.middleware.workspace?.didChangeConfiguration;
+    (middleware
+      ? middleware(sections, didChangeConfiguration)
+      : didChangeConfiguration(sections)
+    ).catch((error) => {
+      this._client.error(
+        `Sending notification ${DidChangeConfigurationNotification.type.method} failed`,
+        error,
+      );
+    });
+  }
+
+  private extractSettingsInformation(keys: string[]): any {
+    function ensurePath(config: any, path: string[]): any {
+      let current = config;
+      for (let i = 0; i < path.length - 1; i++) {
+        let obj = current[path[i]];
+        if (!obj) {
+          obj = Object.create(null);
+          current[path[i]] = obj;
+        }
+        current = obj;
+      }
+      return current;
+    }
+    const resource: Uri | undefined = this._client.clientOptions.workspaceFolder
+      ? this._client.clientOptions.workspaceFolder.uri
+      : undefined;
+    const result = Object.create(null);
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      const index: number = key.indexOf('.');
+      let config: any = null;
+      if (index >= 0) {
+        config = workspace
+          .getConfiguration(key.substr(0, index), resource)
+          .get(key.substr(index + 1));
+      } else {
+        config = workspace.getConfiguration(undefined, resource).get(key);
+      }
+      if (config) {
+        const path = keys[i].split('.');
+        ensurePath(result, path)[path[path.length - 1]] = toJSONObject(config);
+      }
+    }
+    return result;
+  }
+}

package/src/common/declaration.ts

@@ -0,0 +1,140 @@
+/* --------------------------------------------------------------------------------------------
+ * 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,
+  DeclarationRegistrationOptions,
+  DeclarationOptions,
+} from '@difizen/vscode-languageserver-protocol';
+import { DeclarationRequest } from '@difizen/vscode-languageserver-protocol';
+import type {
+  Disposable,
+  TextDocument,
+  ProviderResult,
+  Position as VPosition,
+  Declaration as VDeclaration,
+  DeclarationProvider,
+} from 'vscode';
+
+import type { FeatureClient } from './features.js';
+import { TextDocumentLanguageFeature, ensure } from './features.js';
+import { languages as Languages } from './vscodeAdaptor/vscodeAdaptor.js';
+
+export interface ProvideDeclarationSignature {
+  (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    token: CancellationToken,
+  ): ProviderResult<VDeclaration>;
+}
+
+export interface DeclarationMiddleware {
+  provideDeclaration?: (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    token: CancellationToken,
+    next: ProvideDeclarationSignature,
+  ) => ProviderResult<VDeclaration>;
+}
+
+export class DeclarationFeature extends TextDocumentLanguageFeature<
+  boolean | DeclarationOptions,
+  DeclarationRegistrationOptions,
+  DeclarationProvider,
+  DeclarationMiddleware
+> {
+  constructor(client: FeatureClient<DeclarationMiddleware>) {
+    super(client, DeclarationRequest.type);
+  }
+
+  public fillClientCapabilities(capabilities: ClientCapabilities): void {
+    const declarationSupport = ensure(
+      ensure(capabilities, 'textDocument')!,
+      'declaration',
+    )!;
+    declarationSupport.dynamicRegistration = true;
+    declarationSupport.linkSupport = true;
+  }
+
+  public initialize(
+    capabilities: ServerCapabilities,
+    documentSelector: DocumentSelector,
+  ): void {
+    const [id, options] = this.getRegistration(
+      documentSelector,
+      capabilities.declarationProvider,
+    );
+    if (!id || !options) {
+      return;
+    }
+    this.register({ id: id, registerOptions: options });
+  }
+
+  protected registerLanguageProvider(
+    options: DeclarationRegistrationOptions,
+  ): [Disposable, DeclarationProvider] {
+    const selector = options.documentSelector!;
+    const provider: DeclarationProvider = {
+      provideDeclaration: (
+        document: TextDocument,
+        position: VPosition,
+        token: CancellationToken,
+      ): ProviderResult<VDeclaration> => {
+        const client = this._client;
+        const provideDeclaration: ProvideDeclarationSignature = (
+          document,
+          position,
+          token,
+        ) => {
+          return client
+            .sendRequest(
+              DeclarationRequest.type,
+              client.code2ProtocolConverter.asTextDocumentPositionParams(
+                document,
+                position,
+              ),
+              token,
+            )
+            .then(
+              (result) => {
+                if (token.isCancellationRequested) {
+                  return null;
+                }
+                return client.protocol2CodeConverter.asDeclarationResult(result, token);
+              },
+              (error) => {
+                return client.handleFailedRequest(
+                  DeclarationRequest.type,
+                  token,
+                  error,
+                  null,
+                );
+              },
+            );
+        };
+        const middleware = client.middleware;
+        return middleware.provideDeclaration
+          ? middleware.provideDeclaration(document, position, token, provideDeclaration)
+          : provideDeclaration(document, position, token);
+      },
+    };
+    return [this.registerProvider(selector, provider), provider];
+  }
+
+  private registerProvider(
+    selector: DocumentSelector,
+    provider: DeclarationProvider,
+  ): Disposable {
+    return Languages.registerDeclarationProvider(
+      this._client.protocol2CodeConverter.asDocumentSelector(selector),
+      provider,
+    );
+  }
+}

package/src/common/definition.ts

@@ -0,0 +1,138 @@
+/* --------------------------------------------------------------------------------------------
+ * 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,
+  DefinitionOptions,
+  DefinitionRegistrationOptions,
+  DocumentSelector,
+  ServerCapabilities,
+} from '@difizen/vscode-languageserver-protocol';
+import { DefinitionRequest } from '@difizen/vscode-languageserver-protocol';
+import type {
+  TextDocument,
+  Disposable,
+  Position as VPosition,
+  CancellationToken,
+  ProviderResult,
+  DefinitionProvider,
+  Definition as VDefinition,
+  DefinitionLink as VDefinitionLink,
+} 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 ProvideDefinitionSignature {
+  (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    token: CancellationToken,
+  ): ProviderResult<VDefinition | VDefinitionLink[]>;
+}
+
+export interface DefinitionMiddleware {
+  provideDefinition?: (
+    this: void,
+    document: TextDocument,
+    position: VPosition,
+    token: CancellationToken,
+    next: ProvideDefinitionSignature,
+  ) => ProviderResult<VDefinition | VDefinitionLink[]>;
+}
+
+export class DefinitionFeature extends TextDocumentLanguageFeature<
+  boolean | DefinitionOptions,
+  DefinitionRegistrationOptions,
+  DefinitionProvider,
+  DefinitionMiddleware
+> {
+  constructor(client: FeatureClient<DefinitionMiddleware>) {
+    super(client, DefinitionRequest.type);
+  }
+
+  public fillClientCapabilities(capabilities: ClientCapabilities): void {
+    const definitionSupport = ensure(
+      ensure(capabilities, 'textDocument')!,
+      'definition',
+    )!;
+    definitionSupport.dynamicRegistration = true;
+    definitionSupport.linkSupport = true;
+  }
+
+  public initialize(
+    capabilities: ServerCapabilities,
+    documentSelector: DocumentSelector,
+  ): void {
+    const options = this.getRegistrationOptions(
+      documentSelector,
+      capabilities.definitionProvider,
+    );
+    if (!options) {
+      return;
+    }
+    this.register({ id: UUID.generateUuid(), registerOptions: options });
+  }
+
+  protected registerLanguageProvider(
+    options: DefinitionRegistrationOptions,
+  ): [Disposable, DefinitionProvider] {
+    const selector = options.documentSelector!;
+    const provider: DefinitionProvider = {
+      provideDefinition: (document, position, token) => {
+        const client = this._client;
+        const provideDefinition: ProvideDefinitionSignature = (
+          document,
+          position,
+          token,
+        ) => {
+          return client
+            .sendRequest(
+              DefinitionRequest.type,
+              client.code2ProtocolConverter.asTextDocumentPositionParams(
+                document,
+                position,
+              ),
+              token,
+            )
+            .then(
+              (result) => {
+                if (token.isCancellationRequested) {
+                  return null;
+                }
+                return client.protocol2CodeConverter.asDefinitionResult(result, token);
+              },
+              (error) => {
+                return client.handleFailedRequest(
+                  DefinitionRequest.type,
+                  token,
+                  error,
+                  null,
+                );
+              },
+            );
+        };
+        const middleware = client.middleware;
+        return middleware.provideDefinition
+          ? middleware.provideDefinition(document, position, token, provideDefinition)
+          : provideDefinition(document, position, token);
+      },
+    };
+    return [this.registerProvider(selector, provider), provider];
+  }
+
+  private registerProvider(
+    selector: DocumentSelector,
+    provider: DefinitionProvider,
+  ): Disposable {
+    return Languages.registerDefinitionProvider(
+      this._client.protocol2CodeConverter.asDocumentSelector(selector),
+      provider,
+    );
+  }
+}