vscode-languageserver-protocol 3.17.0-next.9 → 3.17.2-next.1

package/README.md

@@ -4,7 +4,7 @@
 [![NPM Downloads](https://img.shields.io/npm/dm/vscode-languageserver-protocol.svg)](https://npmjs.org/package/vscode-languageclient)
 [![Build Status](https://travis-ci.org/Microsoft/vscode-languageserver-node.svg?branch=master)](https://travis-ci.org/Microsoft/vscode-languageserver-node)
 
-This npm module is a tool independent implementation of the language server protocol and can be used in any type of node application.
+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.
 
 See [here](https://github.com/Microsoft/language-server-protocol) for a detailed documentation on the language server protocol.
 

package/lib/browser/main.js

@@ -5,7 +5,11 @@
  * ------------------------------------------------------------------------------------------ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/common/api.d.ts

@@ -53,42 +53,6 @@ export declare namespace LSPErrorCodes {
     */
     const lspReservedErrorRangeEnd: integer;
 }
-import * as diag from './proposed.diagnostic';
-import * as typeh from './proposed.typeHierarchy';
+export declare type LSPErrorCodes = integer;
 export declare namespace Proposed {
-    type DiagnosticClientCapabilities = diag.DiagnosticClientCapabilities;
-    type $DiagnosticClientCapabilities = diag.$DiagnosticClientCapabilities;
-    type DiagnosticOptions = diag.DiagnosticOptions;
-    type DiagnosticRegistrationOptions = diag.DiagnosticRegistrationOptions;
-    type $DiagnosticServerCapabilities = diag.$DiagnosticServerCapabilities;
-    type DocumentDiagnosticParams = diag.DocumentDiagnosticParams;
-    type DiagnosticServerCancellationData = diag.DiagnosticServerCancellationData;
-    const DiagnosticServerCancellationData: typeof diag.DiagnosticServerCancellationData;
-    type DocumentDiagnosticReportKind = diag.DocumentDiagnosticReportKind;
-    const DocumentDiagnosticReportKind: typeof diag.DocumentDiagnosticReportKind;
-    type FullDocumentDiagnosticReport = diag.FullDocumentDiagnosticReport;
-    type RelatedFullDocumentDiagnosticReport = diag.RelatedFullDocumentDiagnosticReport;
-    type UnchangedDocumentDiagnosticReport = diag.UnchangedDocumentDiagnosticReport;
-    type RelatedUnchangedDocumentDiagnosticReport = diag.RelatedUnchangedDocumentDiagnosticReport;
-    type DocumentDiagnosticReport = diag.DocumentDiagnosticReport;
-    type DocumentDiagnosticReportPartialResult = diag.DocumentDiagnosticReportPartialResult;
-    const DocumentDiagnosticRequest: typeof diag.DocumentDiagnosticRequest;
-    type PreviousResultId = diag.PreviousResultId;
-    type WorkspaceDiagnosticParams = diag.WorkspaceDiagnosticParams;
-    type WorkspaceFullDocumentDiagnosticReport = diag.WorkspaceFullDocumentDiagnosticReport;
-    type WorkspaceUnchangedDocumentDiagnosticReport = diag.WorkspaceUnchangedDocumentDiagnosticReport;
-    type WorkspaceDocumentDiagnosticReport = diag.WorkspaceDocumentDiagnosticReport;
-    type WorkspaceDiagnosticReport = diag.WorkspaceDiagnosticReport;
-    type WorkspaceDiagnosticReportPartialResult = diag.WorkspaceDiagnosticReportPartialResult;
-    const WorkspaceDiagnosticRequest: typeof diag.WorkspaceDiagnosticRequest;
-    const DiagnosticRefreshRequest: typeof diag.DiagnosticRefreshRequest;
-    type TypeHierarchyClientCapabilities = typeh.TypeHierarchyClientCapabilities;
-    type TypeHierarchyOptions = typeh.TypeHierarchyOptions;
-    type TypeHierarchyRegistrationOptions = typeh.TypeHierarchyRegistrationOptions;
-    type TypeHierarchyPrepareParams = typeh.TypeHierarchyPrepareParams;
-    type TypeHierarchySupertypesParams = typeh.TypeHierarchySupertypesParams;
-    type TypeHierarchySubtypesParams = typeh.TypeHierarchySubtypesParams;
-    const TypeHierarchyPrepareRequest: typeof typeh.TypeHierarchyPrepareRequest;
-    const TypeHierarchySupertypesRequest: typeof typeh.TypeHierarchySupertypesRequest;
-    const TypeHierarchySubtypesRequest: typeof typeh.TypeHierarchySubtypesRequest;
 }

package/lib/common/api.js

@@ -5,7 +5,11 @@
  * ------------------------------------------------------------------------------------------ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -14,7 +18,7 @@ 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.Proposed = exports.LSPErrorCodes = exports.createProtocolConnection = void 0;
+exports.LSPErrorCodes = exports.createProtocolConnection = void 0;
 __exportStar(require("vscode-jsonrpc"), exports);
 __exportStar(require("vscode-languageserver-types"), exports);
 __exportStar(require("./messages"), exports);
@@ -71,17 +75,4 @@ var LSPErrorCodes;
     */
     LSPErrorCodes.lspReservedErrorRangeEnd = -32800;
 })(LSPErrorCodes = exports.LSPErrorCodes || (exports.LSPErrorCodes = {}));
-const diag = require("./proposed.diagnostic");
-const typeh = require("./proposed.typeHierarchy");
-var Proposed;
-(function (Proposed) {
-    Proposed.DiagnosticServerCancellationData = diag.DiagnosticServerCancellationData;
-    Proposed.DocumentDiagnosticReportKind = diag.DocumentDiagnosticReportKind;
-    Proposed.DocumentDiagnosticRequest = diag.DocumentDiagnosticRequest;
-    Proposed.WorkspaceDiagnosticRequest = diag.WorkspaceDiagnosticRequest;
-    Proposed.DiagnosticRefreshRequest = diag.DiagnosticRefreshRequest;
-    Proposed.TypeHierarchyPrepareRequest = typeh.TypeHierarchyPrepareRequest;
-    Proposed.TypeHierarchySupertypesRequest = typeh.TypeHierarchySupertypesRequest;
-    Proposed.TypeHierarchySubtypesRequest = typeh.TypeHierarchySubtypesRequest;
-})(Proposed = exports.Proposed || (exports.Proposed = {}));
 //# sourceMappingURL=api.js.map

package/lib/common/connection.d.ts

@@ -42,6 +42,7 @@ export interface ProtocolConnection {
      *
      * @param type The request type to install the handler for.
      * @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;
@@ -50,6 +51,7 @@ export interface ProtocolConnection {
      *
      * @param type The request type to install the handler for.
      * @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;
@@ -58,12 +60,20 @@ export interface ProtocolConnection {
      *
      * @param methods the message signature or the method name to install a handler for.
      * @param handler The actual handler.
+     * @returns A disposable to remove the handler.
      */
     onRequest<R, E>(method: MessageSignature | string, handler: GenericRequestHandler<R, E>): Disposable;
+    /**
+     * Returns true if the connection has a pending response.
+     * Otherwise false is returned.
+     */
+    hasPendingResponse(): boolean;
     /**
      * Sends a notification.
      *
      * @param type the notification's type to send.
+     * @returns A promise that resolves when the notification is written to the
+     * network layer.
      */
     sendNotification(type: NotificationType0): Promise<void>;
     sendNotification<RO>(type: ProtocolNotificationType0<RO>): Promise<void>;
@@ -72,6 +82,8 @@ export interface ProtocolConnection {
      *
      * @param type the notification's type to send.
      * @param params the notification's parameters.
+     * @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>;
@@ -79,6 +91,8 @@ export interface ProtocolConnection {
      * Sends a notification.
      *
      * @param method the notification's method signature or the method name.
+     * @returns A promise that resolves when the notification is written to the
+     * network layer.
      */
     sendNotification(method: MessageSignature | string): Promise<void>;
     /**
@@ -86,6 +100,8 @@ export interface ProtocolConnection {
      *
      * @param method the notification's method signature or the method name.
      * @param params the notification's parameters.
+     * @returns A promise that resolves when the notification is written to the
+     * network layer.
      */
     sendNotification(method: MessageSignature | string, params: any): Promise<void>;
     /**
@@ -93,6 +109,7 @@ export interface ProtocolConnection {
      *
      * @param type The notification type to install the handler for.
      * @param handler The actual handler.
+     * @returns A disposable to remove the handler.
      */
     onNotification<RO>(type: ProtocolNotificationType0<RO>, handler: NotificationHandler0): Disposable;
     onNotification(type: NotificationType0, handler: NotificationHandler0): Disposable;
@@ -101,6 +118,7 @@ export interface ProtocolConnection {
      *
      * @param type The notification type to install the handler for.
      * @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;
@@ -109,6 +127,7 @@ export interface ProtocolConnection {
      *
      * @param methods The message signature or the method name to install the handler for.
      * @param handler The actual handler.
+     * @returns A disposable to remove the handler.
      */
     onNotification(method: MessageSignature | string, handler: GenericNotificationHandler): Disposable;
     /**
@@ -116,6 +135,7 @@ export interface ProtocolConnection {
      * @param type the progress type
      * @param token the token
      * @param handler the handler
+     * @returns A disposable to remove the handler.
      */
     onProgress<P>(type: ProgressType<P>, token: string | number, handler: NotificationHandler<P>): Disposable;
     /**
@@ -123,13 +143,17 @@ export interface ProtocolConnection {
      * @param type the progress type
      * @param token the token to use
      * @param value the progress value
+     * @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>;
     /**
      * Enables tracing mode for the connection.
+     * @returns A promise that resolves when the trace value is written to the
+     * network layer.
      */
-    trace(value: Trace, tracer: Tracer, sendNotification?: boolean): void;
-    trace(value: Trace, tracer: Tracer, traceOptions?: TraceOptions): void;
+    trace(value: Trace, tracer: Tracer, sendNotification?: boolean): Promise<void>;
+    trace(value: Trace, tracer: Tracer, traceOptions?: TraceOptions): Promise<void>;
     /**
      * An event emitter firing when an error occurs on the connection.
      */

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

@@ -0,0 +1 @@
+export {};

package/lib/common/protocol.$.js

@@ -0,0 +1,36 @@
+"use strict";
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) TypeFox, Microsoft and others. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const vscode_jsonrpc_1 = require("vscode-jsonrpc");
+const messages_1 = require("./messages");
+const api_1 = require("./api");
+// This file is used to define the $ notification partly specified in JSON-RPC
+// so that we generate proper data for them in the meta model.
+// @ts-ignore 6196
+var SetTraceNotification;
+(function (SetTraceNotification) {
+    SetTraceNotification.type = new messages_1.ProtocolNotificationType('$/setTrace');
+})(SetTraceNotification || (SetTraceNotification = {}));
+// @ts-ignore 6196
+var LogTraceNotification;
+(function (LogTraceNotification) {
+    LogTraceNotification.type = new messages_1.ProtocolNotificationType('$/logTrace');
+})(LogTraceNotification || (LogTraceNotification = {}));
+// @ts-ignore 6196
+const $ErrorCodes = vscode_jsonrpc_1.ErrorCodes;
+// @ts-ignore 6196
+const $LSPErrorCodes = api_1.LSPErrorCodes;
+// @ts-ignore 6196
+var CancelNotification;
+(function (CancelNotification) {
+    CancelNotification.type = new messages_1.ProtocolNotificationType('$/cancelRequest');
+})(CancelNotification || (CancelNotification = {}));
+// @ts-ignore 6196
+var ProgressNotification;
+(function (ProgressNotification) {
+    ProgressNotification.type = new messages_1.ProtocolNotificationType('$/progress');
+})(ProgressNotification || (ProgressNotification = {}));
+//# sourceMappingURL=protocol.$.js.map

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 { ProtocolRequestType } from './messages';
-import { TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
+import type { TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
 /**
  * @since 3.16.0
  */

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 { ProtocolRequestType } from './messages';
-import { TextDocumentRegistrationOptions, StaticRegistrationOptions, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
+import type { TextDocumentRegistrationOptions, StaticRegistrationOptions, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
 export interface DocumentColorClientCapabilities {
     /**
      * Whether implementation supports dynamic registration. If this is set to `true`

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

@@ -1,19 +1,7 @@
 import { RequestHandler, HandlerResult, CancellationToken } from 'vscode-jsonrpc';
+import { LSPAny } from 'vscode-languageserver-types';
 import { ProtocolRequestType } from './messages';
-import { PartialResultParams } from './protocol';
-export interface ConfigurationClientCapabilities {
-    /**
-     * The workspace client capabilities
-     */
-    workspace?: {
-        /**
-         * The client supports `workspace/configuration` requests.
-         *
-         * @since 3.6.0
-         */
-        configuration?: boolean;
-    };
-}
+import type { PartialResultParams } from './protocol';
 /**
  * The 'workspace/configuration' request is sent from the server to the client to fetch a certain
  * configuration setting.
@@ -25,8 +13,8 @@ export interface ConfigurationClientCapabilities {
  */
 export declare namespace ConfigurationRequest {
     const type: ProtocolRequestType<ConfigurationParams & PartialResultParams, any[], never, void, void>;
-    type HandlerSignature = RequestHandler<ConfigurationParams, any[], void>;
-    type MiddlewareSignature = (params: ConfigurationParams, token: CancellationToken, next: HandlerSignature) => HandlerResult<any[], void>;
+    type HandlerSignature = RequestHandler<ConfigurationParams, LSPAny[], void>;
+    type MiddlewareSignature = (params: ConfigurationParams, token: CancellationToken, next: HandlerSignature) => HandlerResult<LSPAny[], void>;
 }
 export interface ConfigurationItem {
     /**

package/lib/common/protocol.configuration.js

@@ -6,6 +6,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigurationRequest = void 0;
 const messages_1 = require("./messages");
+//---- Get Configuration request ----
 /**
  * The 'workspace/configuration' request is sent from the server to the client to fetch a certain
  * configuration setting.