monaco-languageclient 10.7.0 → 11.0.0-next.0

package/src/fs/definitions.ts

@@ -6,117 +6,114 @@
 import type { ILogger } from '@codingame/monaco-vscode-log-service-override';
 
 export interface FileReadRequest {
-    resourceUri: string
+  resourceUri: string;
 }
 
 export type FileReadResultStatus = 'success' | 'denied';
 
 export interface FileReadRequestResult {
-    status: FileReadResultStatus
-    content: string | ArrayBuffer | ArrayBufferLike | BlobPart
+  status: FileReadResultStatus;
+  content: string | ArrayBuffer | ArrayBufferLike | BlobPart;
 }
 
 export interface FileUpdate {
-    resourceUri: string
-    content: string | ArrayBuffer | ArrayBufferLike | BlobPart
+  resourceUri: string;
+  content: string | ArrayBuffer | ArrayBufferLike | BlobPart;
 }
 
 export type FileUpdateResultStatus = 'equal' | 'updated' | 'created' | 'denied';
 
 export interface FileUpdateResult {
-    status: FileUpdateResultStatus
-    message?: string
+  status: FileUpdateResultStatus;
+  message?: string;
 }
 
 export interface DirectoryListingRequest {
-    directoryUri: string
+  directoryUri: string;
 }
 
 export interface DirectoryListingRequestResult {
-    files: string[]
+  files: string[];
 }
 
 export type StatsRequestType = 'directory' | 'file';
 
 export interface StatsRequest {
-    type: StatsRequestType,
-    resourceUri: string
+  type: StatsRequestType;
+  resourceUri: string;
 }
 
 export interface StatsRequestResult {
-    type: StatsRequestType
-    size: number
-    name: string
-    mtime: number
+  type: StatsRequestType;
+  size: number;
+  name: string;
+  mtime: number;
 }
 
 export type EndpointType = 'DRIVER' | 'FOLLOWER' | 'LOCAL' | 'EMPTY';
 
 export interface FileSystemCapabilities {
-
-    /**
-     * Get a text file content
-     * @param params the resourceUri of the file
-     * @returns The ReadFileResult containing the content of the file
-     */
-    readFile(params: FileReadRequest): Promise<FileReadRequestResult>
-
-    /**
-     * Save a file on the filesystem
-     * @param params the resourceUri and the content of the file
-     * @returns The FileUpdateResult containing the result of the operation and an optional message
-     */
-    writeFile(params: FileUpdate): Promise<FileUpdateResult>;
-
-    /**
-     * The implementation has to decide if the file at given uri at need to be updated
-     * @param params the resourceUri and the content of the file
-     * @returns The FileUpdateResult containing the result of the operation and an optional message
-     */
-    syncFile(params: FileUpdate): Promise<FileUpdateResult>;
-
-    /**
-     * Get file stats on a given file
-     * @param params the resourceUri and if a file or a directory is requested
-     */
-    getFileStats(params: StatsRequest): Promise<StatsRequestResult>
-
-    /**
-     * List the files of a directory
-     * @param resourceUri the Uri of the directory
-     */
-    listFiles(params: DirectoryListingRequest): Promise<DirectoryListingRequestResult>
-
+  /**
+   * Get a text file content
+   * @param params the resourceUri of the file
+   * @returns The ReadFileResult containing the content of the file
+   */
+  readFile(params: FileReadRequest): Promise<FileReadRequestResult>;
+
+  /**
+   * Save a file on the filesystem
+   * @param params the resourceUri and the content of the file
+   * @returns The FileUpdateResult containing the result of the operation and an optional message
+   */
+  writeFile(params: FileUpdate): Promise<FileUpdateResult>;
+
+  /**
+   * The implementation has to decide if the file at given uri at need to be updated
+   * @param params the resourceUri and the content of the file
+   * @returns The FileUpdateResult containing the result of the operation and an optional message
+   */
+  syncFile(params: FileUpdate): Promise<FileUpdateResult>;
+
+  /**
+   * Get file stats on a given file
+   * @param params the resourceUri and if a file or a directory is requested
+   */
+  getFileStats(params: StatsRequest): Promise<StatsRequestResult>;
+
+  /**
+   * List the files of a directory
+   * @param resourceUri the Uri of the directory
+   */
+  listFiles(params: DirectoryListingRequest): Promise<DirectoryListingRequestResult>;
 }
 
 /**
  * Defines the APT for a file system endpoint
  */
 export interface FileSystemEndpoint extends FileSystemCapabilities {
-
-    /**
-     * Whatever can't be handled in the constructor should be done here
-     */
-    init?(): void;
-
-    /**
-     * Set an optional logger
-     * @param logger the logger implemenation
-     */
-    setLogger?(logger: ILogger): void;
-
-    /**
-     * Get the type of the client
-     */
-    getEndpointType(): EndpointType;
-
-    /**
-     * Provide info about the file system
-     */
-    getFileSystemInfo(): string;
-
-    /**
-     * Signal readiness
-     */
-    ready?(): void;
+  /**
+   * Whatever can't be handled in the constructor should be done here
+   */
+  init?(): void;
+
+  /**
+   * Set an optional logger
+   * @param logger the logger implemenation
+   */
+  setLogger?(logger: ILogger): void;
+
+  /**
+   * Get the type of the client
+   */
+  getEndpointType(): EndpointType;
+
+  /**
+   * Provide info about the file system
+   */
+  getFileSystemInfo(): string;
+
+  /**
+   * Signal readiness
+   */
+  ready?(): void;
 }

package/src/fs/endpoints/defaultEndpoint.ts

@@ -4,57 +4,66 @@
  * ------------------------------------------------------------------------------------------ */
 
 import { type ILogger } from '@codingame/monaco-vscode-log-service-override';
-import type { DirectoryListingRequest, DirectoryListingRequestResult, EndpointType, FileReadRequest, FileReadRequestResult, FileSystemEndpoint, FileUpdate, FileUpdateResult, StatsRequest, StatsRequestResult } from '../definitions.js';
+import type {
+  DirectoryListingRequest,
+  DirectoryListingRequestResult,
+  EndpointType,
+  FileReadRequest,
+  FileReadRequestResult,
+  FileSystemEndpoint,
+  FileUpdate,
+  FileUpdateResult,
+  StatsRequest,
+  StatsRequestResult
+} from '../definitions.js';
 
 export class EmptyFileSystemEndpoint implements FileSystemEndpoint {
+  private endpointType: EndpointType;
+  private logger?: ILogger;
 
-    private endpointType: EndpointType;
-    private logger?: ILogger;
+  constructor(endpointType: EndpointType) {
+    this.endpointType = endpointType;
+  }
 
-    constructor(endpointType: EndpointType) {
-        this.endpointType = endpointType;
-    }
+  init(): void {}
 
-    init(): void { }
+  getFileSystemInfo(): string {
+    return 'This file system performs no operations.';
+  }
 
-    getFileSystemInfo(): string {
-        return 'This file system performs no operations.';
-    }
+  setLogger(logger: ILogger): void {
+    this.logger = logger;
+  }
 
-    setLogger(logger: ILogger): void {
-        this.logger = logger;
-    }
+  getEndpointType(): EndpointType {
+    return this.endpointType;
+  }
 
-    getEndpointType(): EndpointType {
-        return this.endpointType;
-    }
+  readFile(params: FileReadRequest): Promise<FileReadRequestResult> {
+    this.logger?.info(`Reading file: ${params.resourceUri}`);
+    return Promise.resolve({
+      status: 'denied',
+      content: ''
+    });
+  }
 
-    readFile(params: FileReadRequest): Promise<FileReadRequestResult> {
-        this.logger?.info(`Reading file: ${params.resourceUri}`);
-        return Promise.resolve({
-            status: 'denied',
-            content: ''
-        });
-    }
+  writeFile(params: FileUpdate): Promise<FileUpdateResult> {
+    this.logger?.info(`Writing file: ${params.resourceUri}`);
+    return Promise.resolve({ status: 'denied' });
+  }
 
-    writeFile(params: FileUpdate): Promise<FileUpdateResult> {
-        this.logger?.info(`Writing file: ${params.resourceUri}`);
-        return Promise.resolve({ status: 'denied' });
-    }
+  syncFile(params: FileUpdate): Promise<FileUpdateResult> {
+    this.logger?.info(`Syncing file: ${params.resourceUri}`);
+    return Promise.resolve({ status: 'denied' });
+  }
 
-    syncFile(params: FileUpdate): Promise<FileUpdateResult> {
-        this.logger?.info(`Syncing file: ${params.resourceUri}`);
-        return Promise.resolve({ status: 'denied' });
-    }
-
-    getFileStats(params: StatsRequest): Promise<StatsRequestResult> {
-        this.logger?.info(`Getting file stats for: "${params.resourceUri}" (${params.type})`);
-        return Promise.reject('No stats available.');
-    }
-
-    listFiles(params: DirectoryListingRequest): Promise<DirectoryListingRequestResult> {
-        this.logger?.info(`Listing files for directory: "${params.directoryUri}"`);
-        return Promise.reject('No file listing possible.');
-    }
+  getFileStats(params: StatsRequest): Promise<StatsRequestResult> {
+    this.logger?.info(`Getting file stats for: "${params.resourceUri}" (${params.type})`);
+    return Promise.reject('No stats available.');
+  }
 
+  listFiles(params: DirectoryListingRequest): Promise<DirectoryListingRequestResult> {
+    this.logger?.info(`Listing files for directory: "${params.directoryUri}"`);
+    return Promise.reject('No file listing possible.');
+  }
 }

package/src/index.ts

@@ -3,31 +3,31 @@
  * Licensed under the MIT License. See LICENSE in the package root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import { BaseLanguageClient, MessageTransports, ProposedFeatures, type LanguageClientOptions } from 'vscode-languageclient/browser.js';
+import { BaseLanguageClient, MessageTransports, ProposedFeatures, type LanguageClientOptions } from 'vscode-languageclient/browser';
 
 export type MonacoLanguageClientOptions = {
-    name: string;
-    id?: string;
-    clientOptions: LanguageClientOptions;
-    messageTransports: MessageTransports;
-}
+  name: string;
+  id?: string;
+  clientOptions: LanguageClientOptions;
+  messageTransports: MessageTransports;
+};
 
 export class MonacoLanguageClient extends BaseLanguageClient {
-    protected readonly messageTransports: MessageTransports;
+  protected readonly messageTransports: MessageTransports;
 
-    constructor({ id, name, clientOptions, messageTransports }: MonacoLanguageClientOptions) {
-        super(id ?? name.toLowerCase(), name, clientOptions);
-        this.messageTransports = messageTransports;
-    }
+  constructor({ id, name, clientOptions, messageTransports }: MonacoLanguageClientOptions) {
+    super(id ?? name.toLowerCase(), name, clientOptions);
+    this.messageTransports = messageTransports;
+  }
 
-    protected override createMessageTransports(_encoding: string): Promise<MessageTransports> {
-        return Promise.resolve(this.messageTransports);
-    }
+  protected override createMessageTransports(_encoding: string): Promise<MessageTransports> {
+    return Promise.resolve(this.messageTransports);
+  }
 }
 
 export class MonacoLanguageClientWithProposedFeatures extends MonacoLanguageClient {
-    constructor({ id, name, clientOptions, messageTransports }: MonacoLanguageClientOptions) {
-        super({ id, name, clientOptions, messageTransports });
-        ProposedFeatures.createAll(this);
-    }
+  constructor({ id, name, clientOptions, messageTransports }: MonacoLanguageClientOptions) {
+    super({ id, name, clientOptions, messageTransports });
+    ProposedFeatures.createAll(this);
+  }
 }