vscode-languageserver-protocol - npm Package Compare versions

Comparing version 3.5.0 to 3.6.0-next.1

lib/main.d.ts

@@ -8,2 +8,3 @@ 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';
 import * as color from './protocol.colorProvider.proposed';
+import { InitializeParams } from './protocol';
 export declare namespace Proposed {
@@ -18,4 +19,5 @@ type ConfigurationClientCapabilities = config.ConfigurationClientCapabilities;
     }
-    type WorkspaceFoldersInitializeParams = folders.WorkspaceFoldersInitializeParams;
+    type WorkspaceFoldersInitializeParams = InitializeParams & folders.WorkspaceFoldersInitializeParams;
     type WorkspaceFoldersClientCapabilities = folders.WorkspaceFoldersClientCapabilities;
+    type WorkspaceFoldersServerCapabilities = folders.WorkspaceFoldersServerCapabilities;
     type WorkspaceFolder = folders.WorkspaceFolder;
@@ -22,0 +24,0 @@ type WorkspaceFoldersChangeEvent = folders.WorkspaceFoldersChangeEvent;

lib/protocol.configuration.proposed.d.ts

@@ -6,3 +6,3 @@ import { RequestType, RequestHandler, HandlerResult, CancellationToken } from 'vscode-jsonrpc';
      */
-    workspace: {
+    workspace?: {
         /**
@@ -9,0 +9,0 @@ * The client supports `workspace/configuration` requests.

lib/protocol.d.ts

 import { RequestType, RequestType0, NotificationType, NotificationType0 } from 'vscode-jsonrpc';
-import { TextDocumentContentChangeEvent, Position, Range, Location, Diagnostic, Command, TextEdit, WorkspaceEdit, WorkspaceSymbolParams, TextDocumentIdentifier, VersionedTextDocumentIdentifier, TextDocumentItem, TextDocumentSaveReason, CompletionItem, CompletionList, Hover, SignatureHelp, Definition, ReferenceContext, DocumentHighlight, DocumentSymbolParams, SymbolInformation, CodeLens, CodeActionContext, FormattingOptions, DocumentLink } from 'vscode-languageserver-types';
+import { TextDocumentContentChangeEvent, Position, Range, Location, Diagnostic, Command, TextEdit, WorkspaceEdit, WorkspaceSymbolParams, TextDocumentIdentifier, VersionedTextDocumentIdentifier, TextDocumentItem, TextDocumentSaveReason, CompletionItem, CompletionList, Hover, SignatureHelp, Definition, ReferenceContext, DocumentHighlight, DocumentSymbolParams, SymbolInformation, CodeLens, CodeActionContext, FormattingOptions, DocumentLink, MarkupKind, SymbolKind, CompletionItemKind } from 'vscode-languageserver-types';
 /**
@@ -153,2 +153,18 @@ * A document filter denotes a document by different properties like
         dynamicRegistration?: boolean;
+        /**
+         * Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
+         */
+        symbolKind?: {
+            /**
+             * The symbol kind values the client supports. When this
+             * property exists the client also guarantees that it will
+             * handle values outside its set gracefully and falls back
+             * to a default value when unknown.
+             *
+             * If this property is not present the client only supports
+             * the symbol kinds from `File` to `Array` as defined in
+             * the initial version of the protocol.
+             */
+            valueSet?: SymbolKind[];
+        };
     };
@@ -222,3 +238,26 @@ /**
             commitCharactersSupport?: boolean;
+            /**
+             * Client supports the follow content formats for the documentation
+             * property. The order describes the preferred format of the client.
+             */
+            documentationFormat?: MarkupKind[];
         };
+        completionItemKind?: {
+            /**
+             * The completion item kind values the client supports. When this
+             * property exists the client also guarantees that it will
+             * handle values outside its set gracefully and falls back
+             * to a default value when unknown.
+             *
+             * If this property is not present the client only supports
+             * the completion items kinds from `Text` to `Reference` as defined in
+             * the initial version of the protocol.
+             */
+            valueSet?: CompletionItemKind[];
+        };
+        /**
+         * The client supports to send additional context information for a
+         * `textDocument/completion` requestion.
+         */
+        contextSupport?: boolean;
     };
@@ -233,2 +272,7 @@ /**
         dynamicRegistration?: boolean;
+        /**
+         * Client supports the follow content formats for the content
+         * property. The order describes the preferred format of the client.
+         */
+        contentFormat?: MarkupKind[];
     };
@@ -243,2 +287,13 @@ /**
         dynamicRegistration?: boolean;
+        /**
+         * The client supports the following `SignatureInformation`
+         * specific properties.
+         */
+        signatureInformation?: {
+            /**
+             * Client supports the follow content formats for the documentation
+             * property. The order describes the preferred format of the client.
+             */
+            documentationFormat?: MarkupKind[];
+        };
     };
@@ -271,2 +326,18 @@ /**
         dynamicRegistration?: boolean;
+        /**
+         * Specific capabilities for the `SymbolKind`.
+         */
+        symbolKind?: {
+            /**
+             * The symbol kind values the client supports. When this
+             * property exists the client also guarantees that it will
+             * handle values outside its set gracefully and falls back
+             * to a default value when unknown.
+             *
+             * If this property is not present the client only supports
+             * the symbol kinds from `File` to `Array` as defined in
+             * the initial version of the protocol.
+             */
+            valueSet?: SymbolKind[];
+        };
     };
@@ -400,2 +471,13 @@ /**
     /**
+     * Most tools trigger completion request automatically without explicitly requesting
+     * it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user
+     * starts to type an identifier. For example if the user types `c` in a JavaScript file
+     * code complete will automatically pop up present `console` besides others as a
+     * completion item. Characters that make up identifiers don't need to be listed here.
+     *
+     * If code complete should automatically be trigger on characters not being valid inside
+     * an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
+     */
+    triggerCharacters?: string[];
+    /**
      * The server provides support to resolve additional
@@ -405,6 +487,2 @@ * information for a completion item.
     resolveProvider?: boolean;
-    /**
-     * The characters that trigger completion automatically.
-     */
-    triggerCharacters?: string[];
 }
@@ -776,3 +854,3 @@ /**
 export declare namespace ShowMessageRequest {
-    const type: RequestType<ShowMessageRequestParams, MessageActionItem, void, void>;
+    const type: RequestType<ShowMessageRequestParams, MessageActionItem | null, void, void>;
 }
@@ -937,3 +1015,3 @@ /**
 export declare namespace WillSaveTextDocumentWaitUntilRequest {
-    const type: RequestType<WillSaveTextDocumentParams, TextEdit[], void, TextDocumentRegistrationOptions>;
+    const type: RequestType<WillSaveTextDocumentParams, TextEdit[] | null, void, TextDocumentRegistrationOptions>;
 }
@@ -1048,2 +1126,42 @@ /**
 /**
+ * How a completion was triggered
+ */
+export declare namespace CompletionTriggerKind {
+    /**
+     * Completion was triggered by typing an identifier (24x7 code
+     * complete), manual invocation (e.g Ctrl+Space) or via API.
+     */
+    const Invoked: 1;
+    /**
+     * Completion was triggered by a trigger character specified by
+     * the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
+     */
+    const TriggerCharacter: 2;
+}
+export declare type CompletionTriggerKind = 1 | 2;
+/**
+ * Contains additional information about the context in which a completion request is triggered.
+ */
+export interface CompletionContext {
+    /**
+     * How the completion was triggered.
+     */
+    triggerKind: CompletionTriggerKind;
+    /**
+     * The trigger character (a single character) that has trigger code complete.
+     * Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
+     */
+    triggerCharacter?: string;
+}
+/**
+ * Completion parameters
+ */
+export interface CompletionParams extends TextDocumentPositionParams {
+    /**
+     * The completion context. This is only available it the client specifies
+     * to send this using `ClientCapabilities.textDocument.completion.contextSupport === true`
+     */
+    context?: CompletionContext;
+}
+/**
  * Request to request completion at a given text document position. The request's
@@ -1053,5 +1171,10 @@ * parameter is of type [TextDocumentPosition](#TextDocumentPosition) the response
  * or a Thenable that resolves to such.
+ *
+ * The request can delay the computation of the [`detail`](#CompletionItem.detail)
+ * and [`documentation`](#CompletionItem.documentation) properties to the `completionItem/resolve`
+ * request. However, properties that are needed for the inital sorting and filtering, like `sortText`,
+ * `filterText`, `insertText`, and `textEdit`, must not be changed during resolve.
  */
 export declare namespace CompletionRequest {
-    const type: RequestType<TextDocumentPositionParams, CompletionList | CompletionItem[], void, CompletionRegistrationOptions>;
+    const type: RequestType<CompletionParams, CompletionList | CompletionItem[] | null, void, CompletionRegistrationOptions>;
 }
@@ -1072,3 +1195,3 @@ /**
 export declare namespace HoverRequest {
-    const type: RequestType<TextDocumentPositionParams, Hover, void, TextDocumentRegistrationOptions>;
+    const type: RequestType<TextDocumentPositionParams, Hover | null, void, TextDocumentRegistrationOptions>;
 }
@@ -1081,3 +1204,3 @@ /**
 export declare namespace SignatureHelpRequest {
-    const type: RequestType<TextDocumentPositionParams, SignatureHelp, void, SignatureHelpRegistrationOptions>;
+    const type: RequestType<TextDocumentPositionParams, SignatureHelp | null, void, SignatureHelpRegistrationOptions>;
 }
@@ -1106,3 +1229,3 @@ /**
 export declare namespace ReferencesRequest {
-    const type: RequestType<ReferenceParams, Location[], void, TextDocumentRegistrationOptions>;
+    const type: RequestType<ReferenceParams, Location[] | null, void, TextDocumentRegistrationOptions>;
 }
@@ -1116,3 +1239,3 @@ /**
 export declare namespace DocumentHighlightRequest {
-    const type: RequestType<TextDocumentPositionParams, DocumentHighlight[], void, TextDocumentRegistrationOptions>;
+    const type: RequestType<TextDocumentPositionParams, DocumentHighlight[] | null, void, TextDocumentRegistrationOptions>;
 }
@@ -1126,3 +1249,3 @@ /**
 export declare namespace DocumentSymbolRequest {
-    const type: RequestType<DocumentSymbolParams, SymbolInformation[], void, TextDocumentRegistrationOptions>;
+    const type: RequestType<DocumentSymbolParams, SymbolInformation[] | null, void, TextDocumentRegistrationOptions>;
 }
@@ -1136,3 +1259,3 @@ /**
 export declare namespace WorkspaceSymbolRequest {
-    const type: RequestType<WorkspaceSymbolParams, SymbolInformation[], void, void>;
+    const type: RequestType<WorkspaceSymbolParams, SymbolInformation[] | null, void, void>;
 }
@@ -1160,3 +1283,3 @@ /**
 export declare namespace CodeActionRequest {
-    const type: RequestType<CodeActionParams, Command[], void, TextDocumentRegistrationOptions>;
+    const type: RequestType<CodeActionParams, Command[] | null, void, TextDocumentRegistrationOptions>;
 }
@@ -1181,3 +1304,3 @@ /**
 export declare namespace CodeLensRequest {
-    const type: RequestType<CodeLensParams, CodeLens[], void, CodeLensRegistrationOptions>;
+    const type: RequestType<CodeLensParams, CodeLens[] | null, void, CodeLensRegistrationOptions>;
 }
@@ -1204,3 +1327,3 @@ /**
 export declare namespace DocumentFormattingRequest {
-    const type: RequestType<DocumentFormattingParams, TextEdit[], void, TextDocumentRegistrationOptions>;
+    const type: RequestType<DocumentFormattingParams, TextEdit[] | null, void, TextDocumentRegistrationOptions>;
 }
@@ -1225,3 +1348,3 @@ export interface DocumentRangeFormattingParams {
 export declare namespace DocumentRangeFormattingRequest {
-    const type: RequestType<DocumentRangeFormattingParams, TextEdit[], void, TextDocumentRegistrationOptions>;
+    const type: RequestType<DocumentRangeFormattingParams, TextEdit[] | null, void, TextDocumentRegistrationOptions>;
 }
@@ -1255,3 +1378,3 @@ export interface DocumentOnTypeFormattingParams {
 export declare namespace DocumentOnTypeFormattingRequest {
-    const type: RequestType<DocumentOnTypeFormattingParams, TextEdit[], void, DocumentOnTypeFormattingRegistrationOptions>;
+    const type: RequestType<DocumentOnTypeFormattingParams, TextEdit[] | null, void, DocumentOnTypeFormattingRegistrationOptions>;
 }
@@ -1278,3 +1401,3 @@ export interface RenameParams {
 export declare namespace RenameRequest {
-    const type: RequestType<RenameParams, WorkspaceEdit, void, TextDocumentRegistrationOptions>;
+    const type: RequestType<RenameParams, WorkspaceEdit | null, void, TextDocumentRegistrationOptions>;
 }
@@ -1296,3 +1419,3 @@ export interface DocumentLinkParams {
 export declare namespace DocumentLinkRequest {
-    const type: RequestType<DocumentLinkParams, DocumentLink[], void, DocumentLinkRegistrationOptions>;
+    const type: RequestType<DocumentLinkParams, DocumentLink[] | null, void, DocumentLinkRegistrationOptions>;
 }
@@ -1334,2 +1457,8 @@ /**
     /**
+     * An optional label of the workspace edit. This label is
+     * presented in the user interface for example on an undo
+     * stack to undo the workspace edit.
+     */
+    label?: string;
+    /**
      * The edits to apply.
@@ -1336,0 +1465,0 @@ */

lib/protocol.js

@@ -288,2 +288,18 @@ /* --------------------------------------------------------------------------------------------
 /**
+ * How a completion was triggered
+ */
+var CompletionTriggerKind;
+(function (CompletionTriggerKind) {
+    /**
+     * Completion was triggered by typing an identifier (24x7 code
+     * complete), manual invocation (e.g Ctrl+Space) or via API.
+     */
+    CompletionTriggerKind.Invoked = 1;
+    /**
+     * Completion was triggered by a trigger character specified by
+     * the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
+     */
+    CompletionTriggerKind.TriggerCharacter = 2;
+})(CompletionTriggerKind = exports.CompletionTriggerKind || (exports.CompletionTriggerKind = {}));
+/**
  * Request to request completion at a given text document position. The request's
@@ -293,2 +309,7 @@ * parameter is of type [TextDocumentPosition](#TextDocumentPosition) the response
  * or a Thenable that resolves to such.
+ *
+ * The request can delay the computation of the [`detail`](#CompletionItem.detail)
+ * and [`documentation`](#CompletionItem.documentation) properties to the `completionItem/resolve`
+ * request. However, properties that are needed for the inital sorting and filtering, like `sortText`,
+ * `filterText`, `insertText`, and `textEdit`, must not be changed during resolve.
  */
@@ -295,0 +316,0 @@ var CompletionRequest;

lib/protocol.workspaceFolders.proposed.d.ts

@@ -12,3 +12,3 @@ import { RequestType0, RequestHandler0, NotificationType, NotificationHandler, HandlerResult, CancellationToken } from 'vscode-jsonrpc';
      */
-    workspace: {
+    workspace?: {
         /**
@@ -20,2 +20,25 @@ * The client has support for workspace folders
 }
+export interface WorkspaceFoldersServerCapabilities {
+    /**
+     * The workspace server capabilities
+     */
+    workspace?: {
+        workspaceFolders?: {
+            /**
+             * The Server has support for workspace folders
+             */
+            supported?: boolean;
+            /**
+             * Whether the server wants to receive workspace folder
+             * change notifications.
+             *
+             * If a strings is provided the string is treated as a ID
+             * under which the notification is registed on the client
+             * side. The ID can be used to unregister for these events
+             * using the `client/unregisterCapability` request.
+             */
+            changeNotifications?: string | boolean;
+        };
+    };
+}
 export interface WorkspaceFolder {
@@ -22,0 +45,0 @@ /**

package.json

 {
 	"name": "vscode-languageserver-protocol",
 	"description": "VSCode Language Server Protocol implementation",
-	"version": "3.5.0",
+	"version": "3.6.0-next.1",
 	"author": "Microsoft Corporation",
@@ -17,4 +17,4 @@ "license": "MIT",
 	"dependencies": {
-		"vscode-jsonrpc": "^3.5.0",
-		"vscode-languageserver-types": "^3.5.0"
+		"vscode-jsonrpc": "^3.6.0-next.1",
+		"vscode-languageserver-types": "^3.6.0-next.1"
 	},
@@ -21,0 +21,0 @@ "scripts": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

101241

increased by8.09%

Lines of code

2532

increased by7.42%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Number of package files

16

decreased by-5.88%

Number of low quality alerts

2

increased by100%

Dependency changes

• Updatedvscode-jsonrpc@^3.6.0-next.1

• Updatedvscode-languageserver-types@^3.6.0-next.1