vscode-languageserver-protocol 3.17.6-next.8 → 3.18.0

package/README.md

@@ -1,8 +1,8 @@
 # VSCode Language Server - Protocol Module
 
-[![NPM Version](https://img.shields.io/npm/v/vscode-languageserver-protocol.svg)](https://npmjs.org/package/vscode-languageclient)
-[![NPM Downloads](https://img.shields.io/npm/dm/vscode-languageserver-protocol.svg)](https://npmjs.org/package/vscode-languageclient)
-[![Build Status](https://dev.azure.com/ms/vscode-languageserver-node/_apis/build/status/microsoft.vscode-languageserver-node?branchName=main)](https://dev.azure.com/ms/vscode-languageserver-node/_build/latest?definitionId=439&branchName=main)
+[![NPM Version](https://img.shields.io/npm/v/vscode-languageserver-protocol.svg)](https://npmjs.org/package/vscode-languageserver-protocol)
+[![NPM Downloads](https://img.shields.io/npm/dm/vscode-languageserver-protocol.svg)](https://npmjs.org/package/vscode-languageserver-protocol)
+[![Build Status](https://dev.azure.com/vscode/vscode-languageserver-node/_apis/build/status%2Fvscode-languageserver-node?branchName=main)](https://dev.azure.com/vscode/vscode-languageserver-node/_build/latest?definitionId=52&branchName=main)
 
 This npm module is a tool independent implementation of the language server protocol and can be used in any type of node application. Please note that the protocol is versioned using the LSP specification version number. Since the protocol depends on the `vscode-jsonrpc` version a a breaking change on that dependencies might not be reflected in a major version change of this module. Changing the major version number in these cases was more confusing this it would result in a version mismatch between the protocol and the LSP specification.
 

package/eslint.config.js

@@ -0,0 +1,13 @@
+// @ts-check
+'use strict';
+
+const { createConfig } = require('../eslint.config.base.js');
+
+module.exports = createConfig(
+	['src/common/tsconfig.json', 'src/browser/tsconfig.json', 'src/browser/test/tsconfig.json', 'src/node/tsconfig.json', 'src/node/test/tsconfig.json'],
+	undefined,
+	{
+		'no-console': 'error',
+		'@typescript-eslint/no-floating-promises': 'error',
+	}
+);

package/lib/browser/main.js

@@ -18,11 +18,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createProtocolConnection = void 0;
+exports.createProtocolConnection = createProtocolConnection;
 const browser_1 = require("vscode-jsonrpc/browser");
 __exportStar(require("vscode-jsonrpc/browser"), exports);
 __exportStar(require("../common/api"), exports);
 function createProtocolConnection(reader, writer, logger, options) {
     return (0, browser_1.createMessageConnection)(reader, writer, logger, options);
 }
-exports.createProtocolConnection = createProtocolConnection;

package/lib/common/connection.d.ts

@@ -1,4 +1,4 @@
-import { Message, NotificationMessage, CancellationToken, RequestHandler0, RequestHandler, GenericRequestHandler, NotificationHandler0, NotificationHandler, GenericNotificationHandler, ProgressType, Trace, Tracer, TraceOptions, Disposable, Event, MessageReader, MessageWriter, Logger, ConnectionStrategy, ConnectionOptions, RequestType0, RequestType, NotificationType0, NotificationType } from 'vscode-jsonrpc';
+import { Message, NotificationMessage, CancellationToken, RequestHandler0, RequestHandler, GenericRequestHandler, NotificationHandler0, NotificationHandler, GenericNotificationHandler, ProgressType, Trace, Tracer, TraceOptions, Disposable, Event, MessageReader, MessageWriter, Logger, ConnectionStrategy, ConnectionOptions, RequestType0, RequestType, NotificationType0, NotificationType, RequestParam } from 'vscode-jsonrpc';
 import { ProtocolRequestType, ProtocolRequestType0, ProtocolNotificationType, ProtocolNotificationType0 } from './messages';
 export interface ProtocolConnection {
     /**
@@ -18,8 +18,8 @@ export interface ProtocolConnection {
      * @param token An optional cancellation token.
      * @returns A promise resolving to the request's result.
      */
-    sendRequest<P, R, PR, E, RO>(type: ProtocolRequestType<P, R, PR, E, RO>, params: P, token?: CancellationToken): Promise<R>;
-    sendRequest<P, R, E>(type: RequestType<P, R, E>, params: P, token?: CancellationToken): Promise<R>;
+    sendRequest<P, R, PR, E, RO>(type: ProtocolRequestType<P, R, PR, E, RO>, params: NoInfer<RequestParam<P>>, token?: CancellationToken): Promise<R>;
+    sendRequest<P, R, E>(type: RequestType<P, R, E>, params: NoInfer<RequestParam<P>>, token?: CancellationToken): Promise<R>;
     /**
      * Sends a request and returns a promise resolving to the result of the request.
      *
@@ -44,8 +44,8 @@ export interface ProtocolConnection {
      * @param handler The actual handler.
      * @returns A disposable to remove the handler.
      */
-    onRequest<R, PR, E, RO>(type: ProtocolRequestType0<R, PR, E, RO>, handler: RequestHandler0<R, E>): Disposable;
-    onRequest<R, E>(type: RequestType0<R, E>, handler: RequestHandler0<R, E>): Disposable;
+    onRequest<R, PR, E, RO>(type: ProtocolRequestType0<R, PR, E, RO>, handler: NoInfer<RequestHandler0<R, E>>): Disposable;
+    onRequest<R, E>(type: RequestType0<R, E>, handler: NoInfer<RequestHandler0<R, E>>): Disposable;
     /**
      * Installs a request handler.
      *
@@ -53,8 +53,8 @@ export interface ProtocolConnection {
      * @param handler The actual handler.
      * @returns A disposable to remove the handler.
      */
-    onRequest<P, R, PR, E, RO>(type: ProtocolRequestType<P, R, PR, E, RO>, handler: RequestHandler<P, R, E>): Disposable;
-    onRequest<P, R, E>(type: RequestType<P, R, E>, handler: RequestHandler<P, R, E>): Disposable;
+    onRequest<P, R, PR, E, RO>(type: ProtocolRequestType<P, R, PR, E, RO>, handler: NoInfer<RequestHandler<P, R, E>>): Disposable;
+    onRequest<P, R, E>(type: RequestType<P, R, E>, handler: NoInfer<RequestHandler<P, R, E>>): Disposable;
     /**
      * Installs a request handler.
      *
@@ -85,8 +85,8 @@ export interface ProtocolConnection {
      * @returns A promise that resolves when the notification is written to the
      * network layer.
      */
-    sendNotification<P, RO>(type: ProtocolNotificationType<P, RO>, params?: P): Promise<void>;
-    sendNotification<P>(type: NotificationType<P>, params?: P): Promise<void>;
+    sendNotification<P, RO>(type: ProtocolNotificationType<P, RO>, params?: NoInfer<RequestParam<P>>): Promise<void>;
+    sendNotification<P>(type: NotificationType<P>, params?: NoInfer<RequestParam<P>>): Promise<void>;
     /**
      * Sends a notification.
      *
@@ -120,8 +120,8 @@ export interface ProtocolConnection {
      * @param handler The actual handler.
      * @returns A disposable to remove the handler.
      */
-    onNotification<P, RO>(type: ProtocolNotificationType<P, RO>, handler: NotificationHandler<P>): Disposable;
-    onNotification<P>(type: NotificationType<P>, handler: NotificationHandler<P>): Disposable;
+    onNotification<P, RO>(type: ProtocolNotificationType<P, RO>, handler: NoInfer<NotificationHandler<P>>): Disposable;
+    onNotification<P>(type: NotificationType<P>, handler: NoInfer<NotificationHandler<P>>): Disposable;
     /**
      * Installs a notification handler.
      *
@@ -137,7 +137,7 @@ export interface ProtocolConnection {
      * @param handler the handler
      * @returns A disposable to remove the handler.
      */
-    onProgress<P>(type: ProgressType<P>, token: string | number, handler: NotificationHandler<P>): Disposable;
+    onProgress<P>(type: ProgressType<P>, token: string | number, handler: NoInfer<NotificationHandler<P>>): Disposable;
     /**
      * Sends progress.
      * @param type the progress type
@@ -146,7 +146,7 @@ export interface ProtocolConnection {
      * @returns A promise that resolves when the progress is written to the
      * network layer.
      */
-    sendProgress<P>(type: ProgressType<P>, token: string | number, value: P): Promise<void>;
+    sendProgress<P>(type: ProgressType<P>, token: string | number, value: NoInfer<RequestParam<P>>): Promise<void>;
     /**
      * Enables tracing mode for the connection.
      * @returns A promise that resolves when the trace value is written to the

package/lib/common/connection.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createProtocolConnection = void 0;
+exports.createProtocolConnection = createProtocolConnection;
 const vscode_jsonrpc_1 = require("vscode-jsonrpc");
 function createProtocolConnection(input, output, logger, options) {
     if (vscode_jsonrpc_1.ConnectionStrategy.is(options)) {
@@ -12,4 +12,3 @@ function createProtocolConnection(input, output, logger, options) {
     }
     return (0, vscode_jsonrpc_1.createMessageConnection)(input, output, logger, options);
 }
-exports.createProtocolConnection = createProtocolConnection;

package/lib/common/messages.d.ts

@@ -49,3 +49,10 @@ export declare class ProtocolNotificationType<P, RO> extends NotificationType<P>
     readonly ____: [RO, _EM] | undefined;
     constructor(method: string);
 }
+export type CM<C extends string | undefined, S extends string | undefined> = {
+    client: C;
+    server: S;
+};
+export declare namespace CM {
+    function create<C extends string | undefined, S extends string | undefined>(client: C, server: S): CM<C, S>;
+}

package/lib/common/messages.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProtocolNotificationType = exports.ProtocolNotificationType0 = exports.ProtocolRequestType = exports.ProtocolRequestType0 = exports.RegistrationType = exports.MessageDirection = void 0;
+exports.CM = exports.ProtocolNotificationType = exports.ProtocolNotificationType0 = exports.ProtocolRequestType = exports.ProtocolRequestType0 = exports.RegistrationType = exports.MessageDirection = void 0;
 const vscode_jsonrpc_1 = require("vscode-jsonrpc");
 var MessageDirection;
 (function (MessageDirection) {
@@ -72,3 +72,10 @@ class ProtocolNotificationType extends vscode_jsonrpc_1.NotificationType {
     }
 }
 exports.ProtocolNotificationType = ProtocolNotificationType;
+var CM;
+(function (CM) {
+    function create(client, server) {
+        return { client, server };
+    }
+    CM.create = create;
+})(CM || (exports.CM = CM = {}));

package/lib/common/protocol.callHierarchy.d.ts

@@ -1,7 +1,7 @@
 import { RequestHandler } from 'vscode-jsonrpc';
 import { CallHierarchyItem, CallHierarchyIncomingCall, CallHierarchyOutgoingCall } from 'vscode-languageserver-types';
-import { MessageDirection, ProtocolRequestType } from './messages';
-import type { TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
+import { CM, MessageDirection, ProtocolRequestType } from './messages';
+import { type TextDocumentRegistrationOptions, type StaticRegistrationOptions, type TextDocumentPositionParams, type PartialResultParams, type WorkDoneProgressParams, type WorkDoneProgressOptions } from './protocol';
 /**
  * @since 3.16.0
  */
@@ -45,6 +45,7 @@ export declare namespace CallHierarchyPrepareRequest {
     const messageDirection: MessageDirection;
     const type: ProtocolRequestType<CallHierarchyPrepareParams, CallHierarchyItem[] | null, never, void, CallHierarchyRegistrationOptions>;
     type HandlerSignature = RequestHandler<CallHierarchyPrepareParams, CallHierarchyItem[] | null, void>;
+    const capabilities: CM<"textDocument.callHierarchy", "callHierarchyProvider">;
 }
 /**
  * The parameter of a `callHierarchy/incomingCalls` request.
@@ -64,6 +65,7 @@ export declare namespace CallHierarchyIncomingCallsRequest {
     const messageDirection: MessageDirection;
     const type: ProtocolRequestType<CallHierarchyIncomingCallsParams, CallHierarchyIncomingCall[] | null, CallHierarchyIncomingCall[], void, void>;
     type HandlerSignature = RequestHandler<CallHierarchyIncomingCallsParams, CallHierarchyIncomingCall[] | null, void>;
+    const capabilities: CM<"textDocument.callHierarchy", "callHierarchyProvider">;
 }
 /**
  * The parameter of a `callHierarchy/outgoingCalls` request.
@@ -83,4 +85,5 @@ export declare namespace CallHierarchyOutgoingCallsRequest {
     const messageDirection: MessageDirection;
     const type: ProtocolRequestType<CallHierarchyOutgoingCallsParams, CallHierarchyOutgoingCall[] | null, CallHierarchyOutgoingCall[], void, void>;
     type HandlerSignature = RequestHandler<CallHierarchyOutgoingCallsParams, CallHierarchyOutgoingCall[] | null, void>;
+    const capabilities: CM<"textDocument.callHierarchy", "callHierarchyProvider">;
 }

package/lib/common/protocol.callHierarchy.js

@@ -17,6 +17,7 @@ var CallHierarchyPrepareRequest;
     CallHierarchyPrepareRequest.method = 'textDocument/prepareCallHierarchy';
     CallHierarchyPrepareRequest.messageDirection = messages_1.MessageDirection.clientToServer;
     CallHierarchyPrepareRequest.type = new messages_1.ProtocolRequestType(CallHierarchyPrepareRequest.method);
+    CallHierarchyPrepareRequest.capabilities = messages_1.CM.create('textDocument.callHierarchy', 'callHierarchyProvider');
 })(CallHierarchyPrepareRequest || (exports.CallHierarchyPrepareRequest = CallHierarchyPrepareRequest = {}));
 /**
  * A request to resolve the incoming calls for a given `CallHierarchyItem`.
@@ -28,6 +29,7 @@ var CallHierarchyIncomingCallsRequest;
     CallHierarchyIncomingCallsRequest.method = 'callHierarchy/incomingCalls';
     CallHierarchyIncomingCallsRequest.messageDirection = messages_1.MessageDirection.clientToServer;
     CallHierarchyIncomingCallsRequest.type = new messages_1.ProtocolRequestType(CallHierarchyIncomingCallsRequest.method);
+    CallHierarchyIncomingCallsRequest.capabilities = messages_1.CM.create('textDocument.callHierarchy', 'callHierarchyProvider');
 })(CallHierarchyIncomingCallsRequest || (exports.CallHierarchyIncomingCallsRequest = CallHierarchyIncomingCallsRequest = {}));
 /**
  * A request to resolve the outgoing calls for a given `CallHierarchyItem`.
@@ -39,4 +41,5 @@ var CallHierarchyOutgoingCallsRequest;
     CallHierarchyOutgoingCallsRequest.method = 'callHierarchy/outgoingCalls';
     CallHierarchyOutgoingCallsRequest.messageDirection = messages_1.MessageDirection.clientToServer;
     CallHierarchyOutgoingCallsRequest.type = new messages_1.ProtocolRequestType(CallHierarchyOutgoingCallsRequest.method);
+    CallHierarchyOutgoingCallsRequest.capabilities = messages_1.CM.create('textDocument.callHierarchy', 'callHierarchyProvider');
 })(CallHierarchyOutgoingCallsRequest || (exports.CallHierarchyOutgoingCallsRequest = CallHierarchyOutgoingCallsRequest = {}));

package/lib/common/protocol.colorProvider.d.ts

@@ -1,7 +1,7 @@
 import { RequestHandler } from 'vscode-jsonrpc';
 import { TextDocumentIdentifier, Range, Color, ColorInformation, ColorPresentation } from 'vscode-languageserver-types';
-import { MessageDirection, ProtocolRequestType } from './messages';
-import type { TextDocumentRegistrationOptions, StaticRegistrationOptions, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
+import { CM, MessageDirection, ProtocolRequestType } from './messages';
+import { type TextDocumentRegistrationOptions, type StaticRegistrationOptions, type PartialResultParams, type WorkDoneProgressParams, type WorkDoneProgressOptions } from './protocol';
 export interface DocumentColorClientCapabilities {
     /**
      * Whether implementation supports dynamic registration. If this is set to `true`
@@ -34,6 +34,7 @@ export declare namespace DocumentColorRequest {
     const messageDirection: MessageDirection;
     const type: ProtocolRequestType<DocumentColorParams, ColorInformation[], ColorInformation[], void, DocumentColorRegistrationOptions>;
     type HandlerSignature = RequestHandler<DocumentColorParams, ColorInformation[], void>;
+    const capabilities: CM<"textDocument.colorProvider", "colorProvider">;
 }
 /**
  * Parameters for a {@link ColorPresentationRequest}.
@@ -55,7 +56,7 @@ export interface ColorPresentationParams extends WorkDoneProgressParams, Partial
 /**
  * A request to list all presentation for a color. The request's
  * parameter is of type {@link ColorPresentationParams} the
- * response is of type {@link ColorInformation ColorInformation[]} or a Thenable
+ * response is of type {@link ColorPresentation ColorPresentation[]} or a Thenable
  * that resolves to such.
  */
 export declare namespace ColorPresentationRequest {
@@ -63,4 +64,5 @@ export declare namespace ColorPresentationRequest {
     const messageDirection: MessageDirection;
     const type: ProtocolRequestType<ColorPresentationParams, ColorPresentation[], ColorPresentation[], void, WorkDoneProgressOptions & TextDocumentRegistrationOptions>;
     type HandlerSignature = RequestHandler<ColorPresentationParams, ColorPresentation[], void>;
+    const capabilities: CM<"textDocument.colorProvider", "colorProvider">;
 }

package/lib/common/protocol.colorProvider.js

@@ -17,11 +17,12 @@ var DocumentColorRequest;
     DocumentColorRequest.method = 'textDocument/documentColor';
     DocumentColorRequest.messageDirection = messages_1.MessageDirection.clientToServer;
     DocumentColorRequest.type = new messages_1.ProtocolRequestType(DocumentColorRequest.method);
+    DocumentColorRequest.capabilities = messages_1.CM.create('textDocument.colorProvider', 'colorProvider');
 })(DocumentColorRequest || (exports.DocumentColorRequest = DocumentColorRequest = {}));
 /**
  * A request to list all presentation for a color. The request's
  * parameter is of type {@link ColorPresentationParams} the
- * response is of type {@link ColorInformation ColorInformation[]} or a Thenable
+ * response is of type {@link ColorPresentation ColorPresentation[]} or a Thenable
  * that resolves to such.
  */
 var ColorPresentationRequest;
@@ -29,4 +30,5 @@ var ColorPresentationRequest;
     ColorPresentationRequest.method = 'textDocument/colorPresentation';
     ColorPresentationRequest.messageDirection = messages_1.MessageDirection.clientToServer;
     ColorPresentationRequest.type = new messages_1.ProtocolRequestType(ColorPresentationRequest.method);
+    ColorPresentationRequest.capabilities = messages_1.CM.create('textDocument.colorProvider', 'colorProvider');
 })(ColorPresentationRequest || (exports.ColorPresentationRequest = ColorPresentationRequest = {}));

package/lib/common/protocol.configuration.d.ts

@@ -1,6 +1,6 @@
 import { RequestHandler, HandlerResult, CancellationToken } from 'vscode-jsonrpc';
 import { LSPAny, URI } from 'vscode-languageserver-types';
-import { MessageDirection, ProtocolRequestType } from './messages';
+import { CM, MessageDirection, ProtocolRequestType } from './messages';
 /**
  * The 'workspace/configuration' request is sent from the server to the client to fetch a certain
  * configuration setting.
@@ -16,6 +16,7 @@ export declare namespace ConfigurationRequest {
     const type: ProtocolRequestType<ConfigurationParams, any[], never, void, void>;
     type HandlerSignature = RequestHandler<ConfigurationParams, LSPAny[], void>;
     type MiddlewareSignature = (params: ConfigurationParams, token: CancellationToken, next: HandlerSignature) => HandlerResult<LSPAny[], void>;
+    const capabilities: CM<"workspace.configuration", undefined>;
 }
 export interface ConfigurationItem {
     /**

package/lib/common/protocol.configuration.js

@@ -21,4 +21,5 @@ var ConfigurationRequest;
     ConfigurationRequest.method = 'workspace/configuration';
     ConfigurationRequest.messageDirection = messages_1.MessageDirection.serverToClient;
     ConfigurationRequest.type = new messages_1.ProtocolRequestType(ConfigurationRequest.method);
+    ConfigurationRequest.capabilities = messages_1.CM.create('workspace.configuration', undefined);
 })(ConfigurationRequest || (exports.ConfigurationRequest = ConfigurationRequest = {}));