vscode-languageserver-protocol 3.12.0 → 3.13.0

package/lib/main.d.ts

@@ -1,7 +1,8 @@
-import { ErrorCodes, ResponseError, CancellationToken, CancellationTokenSource, Disposable, Event, Emitter, Trace, SetTraceNotification, LogTraceNotification, Message, NotificationMessage, RequestMessage, MessageType as RPCMessageType, RequestType, RequestType0, RequestHandler, RequestHandler0, GenericRequestHandler, StarRequestHandler, NotificationType, NotificationType0, NotificationHandler, NotificationHandler0, GenericNotificationHandler, StarNotificationHandler, MessageReader, MessageWriter, Logger, ConnectionStrategy, StreamMessageReader, StreamMessageWriter, IPCMessageReader, IPCMessageWriter, createClientPipeTransport, createServerPipeTransport, generateRandomPipeName, DataCallback, createClientSocketTransport, createServerSocketTransport, Tracer } from 'vscode-jsonrpc';
-export { ErrorCodes, ResponseError, CancellationToken, CancellationTokenSource, Disposable, Event, Emitter, Trace, SetTraceNotification, LogTraceNotification, Message, NotificationMessage, RequestMessage, RPCMessageType, RequestType, RequestType0, RequestHandler, RequestHandler0, GenericRequestHandler, StarRequestHandler, NotificationType, NotificationType0, NotificationHandler, NotificationHandler0, GenericNotificationHandler, StarNotificationHandler, MessageReader, MessageWriter, Logger, ConnectionStrategy, StreamMessageReader, StreamMessageWriter, IPCMessageReader, IPCMessageWriter, createClientPipeTransport, createServerPipeTransport, generateRandomPipeName, DataCallback, createClientSocketTransport, createServerSocketTransport, Tracer };
+import { ErrorCodes, ResponseError, CancellationToken, CancellationTokenSource, Disposable, Event, Emitter, Trace, Tracer, TraceFormat, TraceOptions, SetTraceNotification, LogTraceNotification, Message, NotificationMessage, RequestMessage, MessageType as RPCMessageType, RequestType, RequestType0, RequestHandler, RequestHandler0, GenericRequestHandler, StarRequestHandler, NotificationType, NotificationType0, NotificationHandler, NotificationHandler0, GenericNotificationHandler, StarNotificationHandler, MessageReader, MessageWriter, Logger, ConnectionStrategy, StreamMessageReader, StreamMessageWriter, IPCMessageReader, IPCMessageWriter, createClientPipeTransport, createServerPipeTransport, generateRandomPipeName, DataCallback, createClientSocketTransport, createServerSocketTransport } from 'vscode-jsonrpc';
+export { ErrorCodes, ResponseError, CancellationToken, CancellationTokenSource, Disposable, Event, Emitter, Trace, Tracer, TraceFormat, TraceOptions, SetTraceNotification, LogTraceNotification, Message, NotificationMessage, RequestMessage, RPCMessageType, RequestType, RequestType0, RequestHandler, RequestHandler0, GenericRequestHandler, StarRequestHandler, NotificationType, NotificationType0, NotificationHandler, NotificationHandler0, GenericNotificationHandler, StarNotificationHandler, MessageReader, MessageWriter, Logger, ConnectionStrategy, StreamMessageReader, StreamMessageWriter, IPCMessageReader, IPCMessageWriter, createClientPipeTransport, createServerPipeTransport, generateRandomPipeName, DataCallback, createClientSocketTransport, createServerSocketTransport, };
 export * from 'vscode-languageserver-types';
 export * from './protocol';
+export { FoldingRangeParams as FoldingRangeRequestParam } from './protocol';
 export declare namespace Proposed {
 }
 export interface ProtocolConnection {
@@ -111,6 +112,7 @@ export interface ProtocolConnection {
      * Enables tracing mode for the connection.
      */
     trace(value: Trace, tracer: Tracer, sendNotification?: boolean): void;
+    trace(value: Trace, tracer: Tracer, traceOptions?: TraceOptions): void;
     /**
      * An event emitter firing when an error occurs on the connection.
      */

package/lib/main.js

@@ -16,6 +16,7 @@ exports.Disposable = vscode_jsonrpc_1.Disposable;
 exports.Event = vscode_jsonrpc_1.Event;
 exports.Emitter = vscode_jsonrpc_1.Emitter;
 exports.Trace = vscode_jsonrpc_1.Trace;
+exports.TraceFormat = vscode_jsonrpc_1.TraceFormat;
 exports.SetTraceNotification = vscode_jsonrpc_1.SetTraceNotification;
 exports.LogTraceNotification = vscode_jsonrpc_1.LogTraceNotification;
 exports.RequestType = vscode_jsonrpc_1.RequestType;

package/lib/protocol.configuration.d.ts

@@ -13,6 +13,11 @@ export interface ConfigurationClientCapabilities {
 /**
  * The 'workspace/configuration' request is sent from the server to the client to fetch a certain
  * configuration setting.
+ *
+ * This pull model replaces the old push model were the client signaled configuration change via an
+ * event. If the server still needs to react to configuration changes (since the server caches the
+ * result of `workspace/configuration` requests) the server should register for an empty configuration
+ * change event and empty the cache if such an event is received.
  */
 export declare namespace ConfigurationRequest {
     const type: RequestType<ConfigurationParams, any[], void, void>;

package/lib/protocol.configuration.js

@@ -8,6 +8,11 @@ const vscode_jsonrpc_1 = require("vscode-jsonrpc");
 /**
  * The 'workspace/configuration' request is sent from the server to the client to fetch a certain
  * configuration setting.
+ *
+ * This pull model replaces the old push model were the client signaled configuration change via an
+ * event. If the server still needs to react to configuration changes (since the server caches the
+ * result of `workspace/configuration` requests) the server should register for an empty configuration
+ * change event and empty the cache if such an event is received.
  */
 var ConfigurationRequest;
 (function (ConfigurationRequest) {

package/lib/protocol.d.ts

@@ -5,7 +5,7 @@ import { TypeDefinitionRequest, TypeDefinitionClientCapabilities, TypeDefinition
 import { WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams, WorkspaceFolder, WorkspaceFoldersChangeEvent, WorkspaceFoldersInitializeParams, WorkspaceFoldersClientCapabilities, WorkspaceFoldersServerCapabilities } from './protocol.workspaceFolders';
 import { ConfigurationRequest, ConfigurationParams, ConfigurationItem, ConfigurationClientCapabilities } from './protocol.configuration';
 import { DocumentColorRequest, ColorPresentationRequest, ColorProviderOptions, DocumentColorParams, ColorPresentationParams, ColorServerCapabilities, ColorClientCapabilities } from './protocol.colorProvider';
-import { FoldingRangeClientCapabilities, FoldingRangeProviderOptions, FoldingRangeRequest, FoldingRangeRequestParam, FoldingRangeServerCapabilities } from './protocol.foldingRange';
+import { FoldingRangeClientCapabilities, FoldingRangeProviderOptions, FoldingRangeRequest, FoldingRangeParams, FoldingRangeServerCapabilities } from './protocol.foldingRange';
 /**
  * A document filter denotes a document by different properties like
  * the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
@@ -111,6 +111,48 @@ export interface TextDocumentPositionParams {
      */
     position: Position;
 }
+/**
+ * The kind of resource operations supported by the client.
+ */
+export declare type ResourceOperationKind = 'create' | 'rename' | 'delete';
+export declare namespace ResourceOperationKind {
+    /**
+     * Supports creating new resources.
+     */
+    const Create: ResourceOperationKind;
+    /**
+     * Supports renaming existing resources.
+     */
+    const Rename: ResourceOperationKind;
+    /**
+     * Supports deleting existing resources.
+     */
+    const Delete: ResourceOperationKind;
+}
+export declare type FailureHandlingKind = 'abort' | 'transactional' | 'undo' | 'textOnlyTransactional';
+export declare namespace FailureHandlingKind {
+    /**
+     * Applying the workspace change is simply aborted if one of the changes provided
+     * fails. All operations executed before the failing operation stay executed.
+     */
+    const Abort: FailureHandlingKind;
+    /**
+     * All operations are executed transactional. That means they either all
+     * succeed or no changes at all are applied to the workspace.
+     */
+    const Transactional: FailureHandlingKind;
+    /**
+     * If the workspace edit contains only textual file changes they are executed transactional.
+     * If resource changes (create, rename or delete file) are part of the change the failure
+     * handling startegy is abort.
+     */
+    const TextOnlyTransactional: FailureHandlingKind;
+    /**
+     * The client tries to undo the operations already executed. But there is no
+     * guaruntee that this is succeeding.
+     */
+    const Undo: FailureHandlingKind;
+}
 /**
  * Workspace specific client capabilities.
  */
@@ -129,6 +171,16 @@ export interface WorkspaceClientCapabilities {
          * The client supports versioned document changes in `WorkspaceEdit`s
          */
         documentChanges?: boolean;
+        /**
+         * The resource operations the client supports. Clients should at least
+         * support 'create', 'rename' and 'delete'.
+         */
+        resourceOperations?: ResourceOperationKind[];
+        /**
+         * The failure handling strategy of a client if applying the workspace edit
+         * failes.
+         */
+        failureHandling?: FailureHandlingKind;
     };
     /**
      * Capabilities specific to the `workspace/didChangeConfiguration` notification.
@@ -996,7 +1048,7 @@ export interface DidChangeTextDocumentParams {
     /**
      * The actual content changes. The content changes describe single state changes
      * to the document. So if there are two content changes c1 and c2 for a document
-     * in state S10 then c1 move the document to S11 and c2 to S12.
+     * in state S then c1 move the document to S' and c2 to S''.
      */
     contentChanges: TextDocumentContentChangeEvent[];
 }
@@ -1556,6 +1608,12 @@ export interface ApplyWorkspaceEditResponse {
      * Indicates whether the edit was applied or not.
      */
     applied: boolean;
+    /**
+     * Depending on the client's failure handling strategy `failedChange` might
+     * contain the index of the change that failed. This property is only available
+     * if the client signals a `failureHandlingStrategy` in its client capabilities.
+     */
+    failedChange?: number;
 }
 /**
  * A request sent from the server to the client to modified certain resources.
@@ -1563,4 +1621,4 @@ export interface ApplyWorkspaceEditResponse {
 export declare namespace ApplyWorkspaceEditRequest {
     const type: RequestType<ApplyWorkspaceEditParams, ApplyWorkspaceEditResponse, void, void>;
 }
-export { ImplementationRequest, TypeDefinitionRequest, WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams, WorkspaceFolder, WorkspaceFoldersChangeEvent, ConfigurationRequest, ConfigurationParams, ConfigurationItem, DocumentColorRequest, ColorPresentationRequest, ColorProviderOptions, DocumentColorParams, ColorPresentationParams, FoldingRangeClientCapabilities, FoldingRangeProviderOptions, FoldingRangeRequest, FoldingRangeRequestParam, FoldingRangeServerCapabilities };
+export { ImplementationRequest, TypeDefinitionRequest, WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams, WorkspaceFolder, WorkspaceFoldersChangeEvent, ConfigurationRequest, ConfigurationParams, ConfigurationItem, DocumentColorRequest, ColorPresentationRequest, ColorProviderOptions, DocumentColorParams, ColorPresentationParams, FoldingRangeClientCapabilities, FoldingRangeProviderOptions, FoldingRangeRequest, FoldingRangeParams, FoldingRangeServerCapabilities };

package/lib/protocol.foldingRange.d.ts

@@ -84,7 +84,7 @@ export interface FoldingRange {
 /**
  * Parameters for a [FoldingRangeRequest](#FoldingRangeRequest).
  */
-export interface FoldingRangeRequestParam {
+export interface FoldingRangeParams {
     /**
      * The text document.
      */
@@ -92,10 +92,10 @@ export interface FoldingRangeRequestParam {
 }
 /**
  * A request to provide folding ranges in a document. The request's
- * parameter is of type [FoldingRangeRequestParam](#FoldingRangeRequestParam), the
+ * parameter is of type [FoldingRangeParams](#FoldingRangeParams), the
  * response is of type [FoldingRangeList](#FoldingRangeList) or a Thenable
  * that resolves to such.
  */
 export declare namespace FoldingRangeRequest {
-    const type: RequestType<FoldingRangeRequestParam, FoldingRange[] | null, any, any>;
+    const type: RequestType<FoldingRangeParams, FoldingRange[] | null, any, any>;
 }

package/lib/protocol.foldingRange.js

@@ -25,7 +25,7 @@ var FoldingRangeKind;
 })(FoldingRangeKind = exports.FoldingRangeKind || (exports.FoldingRangeKind = {}));
 /**
  * A request to provide folding ranges in a document. The request's
- * parameter is of type [FoldingRangeRequestParam](#FoldingRangeRequestParam), the
+ * parameter is of type [FoldingRangeParams](#FoldingRangeParams), the
  * response is of type [FoldingRangeList](#FoldingRangeList) or a Thenable
  * that resolves to such.
  */

package/lib/protocol.js

@@ -44,6 +44,45 @@ var UnregistrationRequest;
 (function (UnregistrationRequest) {
     UnregistrationRequest.type = new vscode_jsonrpc_1.RequestType('client/unregisterCapability');
 })(UnregistrationRequest = exports.UnregistrationRequest || (exports.UnregistrationRequest = {}));
+var ResourceOperationKind;
+(function (ResourceOperationKind) {
+    /**
+     * Supports creating new resources.
+     */
+    ResourceOperationKind.Create = 'create';
+    /**
+     * Supports renaming existing resources.
+     */
+    ResourceOperationKind.Rename = 'rename';
+    /**
+     * Supports deleting existing resources.
+     */
+    ResourceOperationKind.Delete = 'delete';
+})(ResourceOperationKind = exports.ResourceOperationKind || (exports.ResourceOperationKind = {}));
+var FailureHandlingKind;
+(function (FailureHandlingKind) {
+    /**
+     * Applying the workspace change is simply aborted if one of the changes provided
+     * fails. All operations executed before the failing operation stay executed.
+     */
+    FailureHandlingKind.Abort = 'abort';
+    /**
+     * All operations are executed transactional. That means they either all
+     * succeed or no changes at all are applied to the workspace.
+     */
+    FailureHandlingKind.Transactional = 'transactional';
+    /**
+     * If the workspace edit contains only textual file changes they are executed transactional.
+     * If resource changes (create, rename or delete file) are part of the change the failure
+     * handling startegy is abort.
+     */
+    FailureHandlingKind.TextOnlyTransactional = 'textOnlyTransactional';
+    /**
+     * The client tries to undo the operations already executed. But there is no
+     * guaruntee that this is succeeding.
+     */
+    FailureHandlingKind.Undo = 'undo';
+})(FailureHandlingKind = exports.FailureHandlingKind || (exports.FailureHandlingKind = {}));
 /**
  * Defines how the host (editor) should sync
  * document changes to the language server.

package/lib/utils/is.js

@@ -4,25 +4,24 @@
  * ------------------------------------------------------------------------------------------ */
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });
-const toString = Object.prototype.toString;
 function boolean(value) {
     return value === true || value === false;
 }
 exports.boolean = boolean;
 function string(value) {
-    return toString.call(value) === '[object String]';
+    return typeof value === 'string' || value instanceof String;
 }
 exports.string = string;
 function number(value) {
-    return toString.call(value) === '[object Number]';
+    return typeof value === 'number' || value instanceof Number;
 }
 exports.number = number;
 function error(value) {
-    return toString.call(value) === '[object Error]';
+    return value instanceof Error;
 }
 exports.error = error;
 function func(value) {
-    return toString.call(value) === '[object Function]';
+    return typeof value === 'function';
 }
 exports.func = func;
 function array(value) {

package/package.json

@@ -1,29 +1,29 @@
-{
-	"name": "vscode-languageserver-protocol",
-	"description": "VSCode Language Server Protocol implementation",
-	"version": "3.12.0",
-	"author": "Microsoft Corporation",
-	"license": "MIT",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/Microsoft/vscode-languageserver-node.git"
-	},
-	"bugs": {
-		"url": "https://github.com/Microsoft/vscode-languageserver-node/issues"
-	},
-	"main": "./lib/main.js",
-	"typings": "./lib/main",
-	"dependencies": {
-		"vscode-jsonrpc": "^3.6.2",
-		"vscode-languageserver-types": "^3.12.0"
-	},
-	"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",
-		"test": "node ../node_modules/mocha/bin/_mocha",
-		"clean": "node ../node_modules/rimraf/bin.js lib",
-		"preversion": "npm test"
-	}
-}
+{
+	"name": "vscode-languageserver-protocol",
+	"description": "VSCode Language Server Protocol implementation",
+	"version": "3.13.0",
+	"author": "Microsoft Corporation",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/Microsoft/vscode-languageserver-node.git"
+	},
+	"bugs": {
+		"url": "https://github.com/Microsoft/vscode-languageserver-node/issues"
+	},
+	"main": "./lib/main.js",
+	"typings": "./lib/main",
+	"dependencies": {
+		"vscode-jsonrpc": "^4.0.0",
+		"vscode-languageserver-types": "3.13.0"
+	},
+	"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",
+		"test": "node ../node_modules/mocha/bin/_mocha",
+		"clean": "node ../node_modules/rimraf/bin.js lib",
+		"preversion": "npm test"
+	}
+}