vscode-languageserver-protocol 3.15.0-next.1 → 3.15.0-next.13

package/lib/protocol.progress.proposed.d.ts

@@ -0,0 +1,115 @@
+import { NotificationType, NotificationHandler, RequestType, RequestHandler, ProgressType, ProgressToken } from 'vscode-jsonrpc';
+export interface WorkDoneProgressClientCapabilities {
+    /**
+     * Window specific client capabilities.
+     */
+    window?: {
+        /**
+         * Whether client supports handling progress notifications. If set servers are allowed to
+         * report in `workDoneProgress` property in the request specific server capabilities.
+         *
+         * Since 3.15.0
+         */
+        workDoneProgress?: boolean;
+    };
+}
+export interface WorkDoneProgressBegin {
+    kind: 'begin';
+    /**
+     * Mandatory title of the progress operation. Used to briefly inform about
+     * the kind of operation being performed.
+     *
+     * Examples: "Indexing" or "Linking dependencies".
+     */
+    title: string;
+    /**
+     * Controls if a cancel button should show to allow the user to cancel the
+     * long running operation. Clients that don't support cancellation are allowed
+     * to ignore the setting.
+     */
+    cancellable?: boolean;
+    /**
+     * Optional, more detailed associated progress message. Contains
+     * complementary information to the `title`.
+     *
+     * Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
+     * If unset, the previous progress message (if any) is still valid.
+     */
+    message?: string;
+    /**
+     * Optional progress percentage to display (value 100 is considered 100%).
+     * If not provided infinite progress is assumed and clients are allowed
+     * to ignore the `percentage` value in subsequent in report notifications.
+     *
+     * The value should be steadily rising. Clients are free to ignore values
+     * that are not following this rule.
+     */
+    percentage?: number;
+}
+export interface WorkDoneProgressReport {
+    kind: 'report';
+    /**
+     * Controls enablement state of a cancel button. This property is only valid if a cancel
+     * button got requested in the `WorkDoneProgressStart` payload.
+     *
+     * Clients that don't support cancellation or don't support control the button's
+     * enablement state are allowed to ignore the setting.
+     */
+    cancellable?: boolean;
+    /**
+     * Optional, more detailed associated progress message. Contains
+     * complementary information to the `title`.
+     *
+     * Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
+     * If unset, the previous progress message (if any) is still valid.
+     */
+    message?: string;
+    /**
+     * Optional progress percentage to display (value 100 is considered 100%).
+     * If not provided infinite progress is assumed and clients are allowed
+     * to ignore the `percentage` value in subsequent in report notifications.
+     *
+     * The value should be steadily rising. Clients are free to ignore values
+     * that are not following this rule.
+     */
+    percentage?: number;
+}
+export interface WorkDoneProgressEnd {
+    kind: 'end';
+    /**
+     * Optional, a final message indicating to for example indicate the outcome
+     * of the operation.
+     */
+    message?: string;
+}
+export declare namespace WorkDoneProgress {
+    const type: ProgressType<WorkDoneProgressBegin | WorkDoneProgressReport | WorkDoneProgressEnd>;
+}
+export interface WorkDoneProgressCreateParams {
+    /**
+     * The token to be used to report progress.
+     */
+    token: ProgressToken;
+}
+/**
+ * The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress
+ * reporting from the server.
+ */
+export declare namespace WorkDoneProgressCreateRequest {
+    const type: RequestType<WorkDoneProgressCreateParams, void, void, void>;
+    type HandlerSignature = RequestHandler<WorkDoneProgressCreateParams, void, void>;
+}
+export interface WorkDoneProgressCancelParams {
+    /**
+     * The token to be used to report progress.
+     */
+    token: ProgressToken;
+}
+/**
+ * The `window/workDoneProgress/cancel` notification is sent from  the client to the server to cancel a progress
+ * initiated on the server side.
+ */
+export declare namespace WorkDoneProgressCancelNotification {
+    const type: NotificationType<WorkDoneProgressCancelParams, void>;
+    type HandlerSignature = NotificationHandler<WorkDoneProgressCancelParams>;
+}

package/lib/protocol.progress.proposed.js

@@ -0,0 +1,27 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+const vscode_jsonrpc_1 = require("vscode-jsonrpc");
+var WorkDoneProgress;
+(function (WorkDoneProgress) {
+    WorkDoneProgress.type = new vscode_jsonrpc_1.ProgressType();
+})(WorkDoneProgress = exports.WorkDoneProgress || (exports.WorkDoneProgress = {}));
+/**
+ * The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress
+ * reporting from the server.
+ */
+var WorkDoneProgressCreateRequest;
+(function (WorkDoneProgressCreateRequest) {
+    WorkDoneProgressCreateRequest.type = new vscode_jsonrpc_1.RequestType('window/workDoneProgress/create');
+})(WorkDoneProgressCreateRequest = exports.WorkDoneProgressCreateRequest || (exports.WorkDoneProgressCreateRequest = {}));
+/**
+ * The `window/workDoneProgress/cancel` notification is sent from  the client to the server to cancel a progress
+ * initiated on the server side.
+ */
+var WorkDoneProgressCancelNotification;
+(function (WorkDoneProgressCancelNotification) {
+    WorkDoneProgressCancelNotification.type = new vscode_jsonrpc_1.NotificationType('window/workDoneProgress/cancel');
+})(WorkDoneProgressCancelNotification = exports.WorkDoneProgressCancelNotification || (exports.WorkDoneProgressCancelNotification = {}));

package/lib/protocol.selectionRange.d.ts

@@ -1,71 +1,39 @@
-import { RequestType } from 'vscode-jsonrpc';
-import { Range } from 'vscode-languageserver-types';
-import { TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams } from './protocol';
+import { RequestType, RequestHandler, ProgressType } from 'vscode-jsonrpc';
+import { TextDocumentIdentifier, Position, SelectionRange } from 'vscode-languageserver-types';
+import { TextDocumentRegistrationOptions, WorkDoneProgressOptions, StaticRegistrationOptions, WorkDoneProgressParams, PartialResultParams } from './protocol';
 export interface SelectionRangeClientCapabilities {
     /**
-     * The text document client capabilities
+     * Whether implementation supports dynamic registration for selection range providers. If this is set to `true`
+     * the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server
+     * capability as well.
      */
-    textDocument?: {
-        /**
-         * Capabilities specific to `textDocument/selectionRange` requests
-         */
-        selectionRange?: {
-            /**
-             * Whether implementation supports dynamic registration for selection range providers. If this is set to `true`
-             * the client supports the new `(SelectionRangeProviderOptions & TextDocumentRegistrationOptions & StaticRegistrationOptions)`
-             * return value for the corresponding server capability as well.
-             */
-            dynamicRegistration?: boolean;
-        };
-    };
+    dynamicRegistration?: boolean;
 }
-export interface SelectionRangeProviderOptions {
+export interface SelectionRangeOptions extends WorkDoneProgressOptions {
 }
-export interface SelectionRangeServerCapabilities {
-    /**
-     * The server provides selection range support.
-     */
-    selectionRangeProvider?: boolean | SelectionRangeProviderOptions | (SelectionRangeProviderOptions & TextDocumentRegistrationOptions & StaticRegistrationOptions);
-}
-/**
- * Enum of known selection range kinds
- */
-export declare enum SelectionRangeKind {
-    /**
-     * Empty Kind.
-     */
-    Empty = "",
-    /**
-     * The statment kind, its value is `statement`, possible extensions can be
-     * `statement.if` etc
-     */
-    Statement = "statement",
-    /**
-     * The declaration kind, its value is `declaration`, possible extensions can be
-     * `declaration.function`, `declaration.class` etc.
-     */
-    Declaration = "declaration"
+export interface SelectionRangeRegistrationOptions extends SelectionRangeOptions, TextDocumentRegistrationOptions, StaticRegistrationOptions {
 }
 /**
- * Represents a selection range
+ * A parameter literal used in selection range requests.
  */
-export interface SelectionRange {
+export interface SelectionRangeParams extends WorkDoneProgressParams, PartialResultParams {
     /**
-     * Range of the selection.
+     * The text document.
      */
-    range: Range;
+    textDocument: TextDocumentIdentifier;
     /**
-     * Describes the kind of the selection range such as `statemet' or 'declaration'. See
-     * [SelectionRangeKind](#SelectionRangeKind) for an enumeration of standardized kinds.
+     * The positions inside the text document.
      */
-    kind: string;
+    positions: Position[];
 }
 /**
  * A request to provide selection ranges in a document. The request's
- * parameter is of type [TextDocumentPositionParams](#TextDocumentPositionParams), the
+ * parameter is of type [SelectionRangeParams](#SelectionRangeParams), the
  * response is of type [SelectionRange[]](#SelectionRange[]) or a Thenable
  * that resolves to such.
  */
 export declare namespace SelectionRangeRequest {
-    const type: RequestType<TextDocumentPositionParams, SelectionRange[] | null, any, any>;
+    const type: RequestType<SelectionRangeParams, SelectionRange[] | null, any, SelectionRangeRegistrationOptions>;
+    const resultType: ProgressType<SelectionRange[]>;
+    type HandlerSignature = RequestHandler<SelectionRangeParams, SelectionRange[] | null, void>;
 }

package/lib/protocol.selectionRange.js

@@ -5,33 +5,14 @@
  *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 const vscode_jsonrpc_1 = require("vscode-jsonrpc");
-/**
- * Enum of known selection range kinds
- */
-var SelectionRangeKind;
-(function (SelectionRangeKind) {
-    /**
-     * Empty Kind.
-     */
-    SelectionRangeKind["Empty"] = "";
-    /**
-     * The statment kind, its value is `statement`, possible extensions can be
-     * `statement.if` etc
-     */
-    SelectionRangeKind["Statement"] = "statement";
-    /**
-     * The declaration kind, its value is `declaration`, possible extensions can be
-     * `declaration.function`, `declaration.class` etc.
-     */
-    SelectionRangeKind["Declaration"] = "declaration";
-})(SelectionRangeKind = exports.SelectionRangeKind || (exports.SelectionRangeKind = {}));
 /**
  * A request to provide selection ranges in a document. The request's
- * parameter is of type [TextDocumentPositionParams](#TextDocumentPositionParams), the
+ * parameter is of type [SelectionRangeParams](#SelectionRangeParams), the
  * response is of type [SelectionRange[]](#SelectionRange[]) or a Thenable
  * that resolves to such.
  */
 var SelectionRangeRequest;
 (function (SelectionRangeRequest) {
     SelectionRangeRequest.type = new vscode_jsonrpc_1.RequestType('textDocument/selectionRange');
+    SelectionRangeRequest.resultType = new vscode_jsonrpc_1.ProgressType();
 })(SelectionRangeRequest = exports.SelectionRangeRequest || (exports.SelectionRangeRequest = {}));

package/lib/protocol.typeDefinition.d.ts

@@ -1,33 +1,28 @@
-import { RequestType, RequestHandler } from 'vscode-jsonrpc';
+import { RequestType, RequestHandler, ProgressType } from 'vscode-jsonrpc';
 import { Definition, DefinitionLink, LocationLink, Location } from 'vscode-languageserver-types';
-import { TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams } from './protocol';
+import { TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
+/**
+ * Since 3.6.0
+ */
 export interface TypeDefinitionClientCapabilities {
     /**
-     * The text document client capabilities
+     * Whether implementation supports dynamic registration. If this is set to `true`
+     * the client supports the new `TypeDefinitionRegistrationOptions` return value
+     * for the corresponding server capability as well.
      */
-    textDocument?: {
-        /**
-         * Capabilities specific to the `textDocument/typeDefinition`
-         */
-        typeDefinition?: {
-            /**
-             * Whether implementation supports dynamic registration. If this is set to `true`
-             * the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
-             * return value for the corresponding server capability as well.
-             */
-            dynamicRegistration?: boolean;
-            /**
-             * The client supports additional metadata in the form of definition links.
-             */
-            linkSupport?: boolean;
-        };
-    };
-}
-export interface TypeDefinitionServerCapabilities {
+    dynamicRegistration?: boolean;
     /**
-     * The server provides Goto Type Definition support.
+     * The client supports additional metadata in the form of definition links.
+     *
+     * Since 3.14.0
      */
-    typeDefinitionProvider?: boolean | (TextDocumentRegistrationOptions & StaticRegistrationOptions);
+    linkSupport?: boolean;
+}
+export interface TypeDefinitionOptions extends WorkDoneProgressOptions {
+}
+export interface TypeDefinitionRegistrationOptions extends TextDocumentRegistrationOptions, TypeDefinitionOptions, StaticRegistrationOptions {
+}
+export interface TypeDefinitionParams extends TextDocumentPositionParams, WorkDoneProgressParams, PartialResultParams {
 }
 /**
  * A request to resolve the type definition locations of a symbol at a given text
@@ -36,6 +31,7 @@ export interface TypeDefinitionServerCapabilities {
  * Thenable that resolves to such.
  */
 export declare namespace TypeDefinitionRequest {
-    const type: RequestType<TextDocumentPositionParams, Location | Location[] | LocationLink[] | null, void, TextDocumentRegistrationOptions>;
-    type HandlerSignature = RequestHandler<TextDocumentPositionParams, Definition | DefinitionLink[] | null, void>;
+    const type: RequestType<TypeDefinitionParams, Location | Location[] | LocationLink[] | null, void, TypeDefinitionRegistrationOptions>;
+    const resultType: ProgressType<LocationLink[] | Location[]>;
+    type HandlerSignature = RequestHandler<TypeDefinitionParams, Definition | DefinitionLink[] | null, void>;
 }

package/lib/protocol.typeDefinition.js

@@ -16,4 +16,5 @@ let __noDynamicImport;
 var TypeDefinitionRequest;
 (function (TypeDefinitionRequest) {
     TypeDefinitionRequest.type = new vscode_jsonrpc_1.RequestType('textDocument/typeDefinition');
+    TypeDefinitionRequest.resultType = new vscode_jsonrpc_1.ProgressType();
 })(TypeDefinitionRequest = exports.TypeDefinitionRequest || (exports.TypeDefinitionRequest = {}));

package/lib/utils/is.d.ts

@@ -6,4 +6,4 @@ export declare function func(value: any): value is Function;
 export declare function array<T>(value: any): value is T[];
 export declare function stringArray(value: any): value is string[];
 export declare function typedArray<T>(value: any, check: (value: any) => boolean): value is T[];
-export declare function thenable<T>(value: any): value is Thenable<T>;
+export declare function objectLiteral(value: any): value is object;

package/lib/utils/is.js

@@ -36,7 +36,10 @@ function typedArray(value, check) {
     return Array.isArray(value) && value.every(check);
 }
 exports.typedArray = typedArray;
-function thenable(value) {
-    return value && func(value.then);
+function objectLiteral(value) {
+    // Strictly speaking class instances pass this check as well. Since the LSP
+    // doesn't use classes we ignore this for now. If we do we need to add something
+    // like this: `Object.getPrototypeOf(Object.getPrototypeOf(x)) === null`
+    return value !== null && typeof value === 'object';
 }
-exports.thenable = thenable;
+exports.objectLiteral = objectLiteral;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "vscode-languageserver-protocol",
 	"description": "VSCode Language Server Protocol implementation",
-	"version": "3.15.0-next.1",
+	"version": "3.15.0-next.13",
 	"author": "Microsoft Corporation",
 	"license": "MIT",
 	"repository": {
@@ -15,14 +15,14 @@
 	"main": "./lib/main.js",
 	"typings": "./lib/main",
 	"dependencies": {
-		"vscode-jsonrpc": "^4.0.0",
-		"vscode-languageserver-types": "3.14.0"
+		"vscode-jsonrpc": "^5.0.0-next.5",
+		"vscode-languageserver-types": "^3.15.0-next.9"
 	},
 	"scripts": {
 		"prepublishOnly": "npm run clean && npm run compile && npm test",
 		"postpublish": "node ../build/npm/post-publish.js",
-		"compile": "node ../build/bin/tsc -p ./tsconfig.json",
-		"watch": "node ../build/bin/tsc -w -p ./tsconfig.json",
+		"compile": "node ../build/bin/tsc -b ./tsconfig.json",
+		"watch": "node ../build/bin/tsc -b ./tsconfig.json -w",
 		"test": "node ../node_modules/mocha/bin/_mocha",
 		"clean": "node ../node_modules/rimraf/bin.js lib",
 		"preversion": "npm test"