vscode-languageserver-protocol 3.17.0-next.14 → 3.17.0-next.17

package/lib/common/protocol.d.ts

@@ -1,23 +1,24 @@
 import { ProgressToken } from 'vscode-jsonrpc';
 import { ProtocolRequestType, ProtocolRequestType0, ProtocolNotificationType, ProtocolNotificationType0 } from './messages';
-import { Position, Range, Location, LocationLink, Diagnostic, Command, TextEdit, WorkspaceEdit, DocumentUri, TextDocumentIdentifier, VersionedTextDocumentIdentifier, TextDocumentItem, CompletionItem, CompletionList, Hover, SignatureHelp, Definition, ReferenceContext, DocumentHighlight, SymbolInformation, CodeLens, CodeActionContext, FormattingOptions, DocumentLink, MarkupKind, SymbolKind, CompletionItemKind, CodeAction, CodeActionKind, DocumentSymbol, CompletionItemTag, DiagnosticTag, SymbolTag, uinteger, integer, InsertTextMode, LSPAny, WorkspaceSymbol } from 'vscode-languageserver-types';
+import { Position, Range, Location, LocationLink, Diagnostic, Command, TextEdit, WorkspaceEdit, DocumentUri, TextDocumentIdentifier, VersionedTextDocumentIdentifier, TextDocumentItem, CompletionItem, CompletionList, Hover, SignatureHelp, Definition, ReferenceContext, DocumentHighlight, SymbolInformation, CodeLens, CodeActionContext, FormattingOptions, DocumentLink, MarkupKind, SymbolKind, CompletionItemKind, CodeAction, CodeActionKind, DocumentSymbol, CompletionItemTag, DiagnosticTag, SymbolTag, uinteger, integer, InsertTextMode, LSPAny, WorkspaceSymbol, URI, WorkspaceFolder } from 'vscode-languageserver-types';
 import { ImplementationRequest, ImplementationClientCapabilities, ImplementationOptions, ImplementationRegistrationOptions, ImplementationParams } from './protocol.implementation';
 import { TypeDefinitionRequest, TypeDefinitionClientCapabilities, TypeDefinitionOptions, TypeDefinitionRegistrationOptions, TypeDefinitionParams } from './protocol.typeDefinition';
-import { WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams, WorkspaceFolder, WorkspaceFoldersChangeEvent, WorkspaceFoldersInitializeParams, WorkspaceFoldersClientCapabilities, WorkspaceFoldersServerCapabilities } from './protocol.workspaceFolders';
-import { ConfigurationRequest, ConfigurationParams, ConfigurationItem, ConfigurationClientCapabilities } from './protocol.configuration';
+import { WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams, WorkspaceFoldersChangeEvent, WorkspaceFoldersInitializeParams, WorkspaceFoldersServerCapabilities } from './protocol.workspaceFolder';
+import { ConfigurationRequest, ConfigurationParams, ConfigurationItem } from './protocol.configuration';
 import { DocumentColorRequest, ColorPresentationRequest, DocumentColorOptions, DocumentColorParams, ColorPresentationParams, DocumentColorClientCapabilities, DocumentColorRegistrationOptions } from './protocol.colorProvider';
 import { FoldingRangeClientCapabilities, FoldingRangeOptions, FoldingRangeRequest, FoldingRangeParams, FoldingRangeRegistrationOptions } from './protocol.foldingRange';
 import { DeclarationClientCapabilities, DeclarationRequest, DeclarationOptions, DeclarationRegistrationOptions, DeclarationParams } from './protocol.declaration';
 import { SelectionRangeClientCapabilities, SelectionRangeOptions, SelectionRangeRequest, SelectionRangeParams, SelectionRangeRegistrationOptions } from './protocol.selectionRange';
-import { WorkDoneProgressClientCapabilities, WorkDoneProgressBegin, WorkDoneProgressReport, WorkDoneProgressEnd, WorkDoneProgress, WorkDoneProgressCreateParams, WorkDoneProgressCreateRequest, WorkDoneProgressCancelParams, WorkDoneProgressCancelNotification } from './protocol.progress';
+import { WorkDoneProgressBegin, WorkDoneProgressReport, WorkDoneProgressEnd, WorkDoneProgress, WorkDoneProgressCreateParams, WorkDoneProgressCreateRequest, WorkDoneProgressCancelParams, WorkDoneProgressCancelNotification } from './protocol.progress';
 import { CallHierarchyClientCapabilities, CallHierarchyOptions, CallHierarchyRegistrationOptions, CallHierarchyIncomingCallsParams, CallHierarchyIncomingCallsRequest, CallHierarchyOutgoingCallsParams, CallHierarchyOutgoingCallsRequest, CallHierarchyPrepareParams, CallHierarchyPrepareRequest } from './protocol.callHierarchy';
 import { SemanticTokensPartialResult, SemanticTokensDeltaPartialResult, TokenFormat, SemanticTokensClientCapabilities, SemanticTokensOptions, SemanticTokensRegistrationOptions, SemanticTokensParams, SemanticTokensRequest, SemanticTokensDeltaParams, SemanticTokensDeltaRequest, SemanticTokensRangeParams, SemanticTokensRangeRequest, SemanticTokensRefreshRequest, SemanticTokensWorkspaceClientCapabilities, SemanticTokensRegistrationType } from './protocol.semanticTokens';
 import { ShowDocumentParams, ShowDocumentResult, ShowDocumentRequest, ShowDocumentClientCapabilities } from './protocol.showDocument';
 import { LinkedEditingRangeClientCapabilities, LinkedEditingRanges, LinkedEditingRangeOptions, LinkedEditingRangeParams, LinkedEditingRangeRegistrationOptions, LinkedEditingRangeRequest } from './protocol.linkedEditingRange';
 import { FileOperationOptions, FileOperationClientCapabilities, FileOperationRegistrationOptions, FileOperationPatternOptions, FileOperationPatternKind, DidCreateFilesNotification, CreateFilesParams, FileCreate, WillCreateFilesRequest, DidRenameFilesNotification, RenameFilesParams, FileRename, WillRenameFilesRequest, DidDeleteFilesNotification, DeleteFilesParams, FileDelete, WillDeleteFilesRequest } from './protocol.fileOperations';
 import { UniquenessLevel, MonikerKind, Moniker, MonikerClientCapabilities, MonikerOptions, MonikerRegistrationOptions, MonikerParams, MonikerRequest } from './protocol.moniker';
-import { TypeHierarchyClientCapabilities, TypeHierarchyOptions, TypeHierarchyRegistrationOptions } from './proposed.typeHierarchy';
-import { InlineValuesClientCapabilities, InlineValuesOptions, InlineValuesRegistrationOptions, InlineValuesWorkspaceClientCapabilities } from './proposed.inlineValue';
+import { TypeHierarchyClientCapabilities, TypeHierarchyOptions, TypeHierarchyRegistrationOptions, TypeHierarchyPrepareParams, TypeHierarchyPrepareRequest, TypeHierarchySubtypesParams, TypeHierarchySubtypesRequest, TypeHierarchySupertypesParams, TypeHierarchySupertypesRequest } from './protocol.typeHierarchy';
+import { InlineValueClientCapabilities, InlineValueOptions, InlineValueRegistrationOptions, InlineValueWorkspaceClientCapabilities, InlineValueParams, InlineValueRequest, InlineValueRefreshRequest } from './protocol.inlineValue';
+import { InlayHintClientCapabilities, InlayHintOptions, InlayHintRegistrationOptions, InlayHintWorkspaceClientCapabilities, InlayHintParams, InlayHintRequest, InlayHintResolveRequest, InlayHintRefreshRequest } from './protocol.inlayHint';
 /**
  * A document filter denotes a document by different properties like
  * the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
@@ -34,7 +35,8 @@ import { InlineValuesClientCapabilities, InlineValuesOptions, InlineValuesRegist
  * @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
  * @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
  *
- * @since 3.17.0 - proposed state.
+ * @since 3.17.0
+ * @proposed
  */
 export declare type TextDocumentFilter = {
     /** A language id, like `typescript`. */
@@ -62,50 +64,48 @@ export declare type TextDocumentFilter = {
  * The TextDocumentFilter namespace provides helper functions to work with
  * [TextDocumentFilter](#TextDocumentFilter) literals.
  *
- * @since 3.17.0 - proposed state.
+ * @since 3.17.0
+ * @proposed
  */
 export declare namespace TextDocumentFilter {
     function is(value: any): value is TextDocumentFilter;
 }
 /**
  * A notebook document filter denotes a notebook document by
- * different properties.
+ * different properties. The properties will be match
+ * against the notebook's URI (same as with documents)
  *
- * @since 3.17.0 - proposed state.
+ * @since 3.17.0
+ * @proposed
  */
 export declare type NotebookDocumentFilter = {
     /** The type of the enclosing notebook. */
     notebookType: string;
-    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
-     * Will be matched against the URI of the notebook. */
+    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
     scheme?: string;
-    /** A glob pattern, like `*.ipynb`.
-     * Will be matched against the notebooks` URI path section.*/
+    /** A glob pattern. */
     pattern?: string;
 } | {
     /** The type of the enclosing notebook. */
     notebookType?: string;
-    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
-     * Will be matched against the URI of the notebook. */
+    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`.*/
     scheme: string;
-    /** A glob pattern, like `*.ipynb`.
-     * Will be matched against the notebooks` URI path section.*/
+    /** A glob pattern. */
     pattern?: string;
 } | {
     /** The type of the enclosing notebook. */
     notebookType?: string;
-    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
-     * Will be matched against the URI of the notebook. */
+    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
     scheme?: string;
-    /** A glob pattern, like `*.ipynb`.
-     * Will be matched against the notebooks` URI path section.*/
+    /** A glob pattern. */
     pattern: string;
 };
 /**
  * The NotebookDocumentFilter namespace provides helper functions to work with
  * [NotebookDocumentFilter](#NotebookDocumentFilter) literals.
  *
- * @since 3.17.0 - proposed state.
+ * @since 3.17.0
+ * @proposed
  */
 export declare namespace NotebookDocumentFilter {
     function is(value: any): value is NotebookDocumentFilter;
@@ -114,40 +114,31 @@ export declare namespace NotebookDocumentFilter {
  * A notebook cell text document filter denotes a cell text
  * document by different properties.
  *
- * @since 3.17.0 - proposed state.
+ * @since 3.17.0
+ * @proposed
  */
 export declare type NotebookCellTextDocumentFilter = {
     /**
      * A filter that matches against the notebook
-     * containing the notebook cell.
-     */
-    notebookDocument: NotebookDocumentFilter;
-    /**
-     * A language id like `python`.
-     *
-     * Will be matched against the language id of the
-     * notebook cell document.
-     */
-    cellLanguage?: string;
-} | {
-    /**
-     * A filter that matches against the notebook
-     * containing the notebook cell.
+     * containing the notebook cell. If a string
+     * value is provided it matches against the
+     * notebook type. '*' matches every notebook.
      */
-    notebookDocument?: NotebookDocumentFilter;
+    notebook: string | NotebookDocumentFilter;
     /**
      * A language id like `python`.
      *
      * Will be matched against the language id of the
-     * notebook cell document.
+     * notebook cell document. '*' matches every language.
      */
-    cellLanguage: string;
+    language?: string;
 };
 /**
  * The NotebookCellTextDocumentFilter namespace provides helper functions to work with
  * [NotebookCellTextDocumentFilter](#NotebookCellTextDocumentFilter) literals.
  *
- * @since 3.17.0 - proposed state.
+ * @since 3.17.0
+ * @proposed
  */
 export declare namespace NotebookCellTextDocumentFilter {
     function is(value: any): value is NotebookCellTextDocumentFilter;
@@ -325,6 +316,18 @@ export interface WorkspaceClientCapabilities {
      * Capabilities specific to the `workspace/executeCommand` request.
      */
     executeCommand?: ExecuteCommandClientCapabilities;
+    /**
+     * The client has support for workspace folders
+     *
+     * @since 3.6.0
+     */
+    workspaceFolders?: boolean;
+    /**
+     * The client supports `workspace/configuration` requests.
+     *
+     * @since 3.6.0
+     */
+    configuration?: boolean;
     /**
      * Capabilities specific to the semantic token requests scoped to the
      * workspace.
@@ -351,7 +354,14 @@ export interface WorkspaceClientCapabilities {
      *
      * @since 3.17.0.
      */
-    inlineValues?: InlineValuesWorkspaceClientCapabilities;
+    inlineValue?: InlineValueWorkspaceClientCapabilities;
+    /**
+     * Capabilities specific to the inlay hints requests scoped to the
+     * workspace.
+     *
+     * @since 3.17.0.
+     */
+    inlayHint?: InlayHintWorkspaceClientCapabilities;
 }
 /**
  * Text document specific client capabilities.
@@ -482,21 +492,34 @@ export interface TextDocumentClientCapabilities {
     /**
      * Capabilities specific to the various type hierarchy requests.
      *
-     * @since 3.17.0 - proposed state
+     * @since 3.17.0
+     * @proposed
      */
     typeHierarchy?: TypeHierarchyClientCapabilities;
     /**
-     * Capabilities specific to the `textDocument/inlineValues` request.
+     * Capabilities specific to the `textDocument/inlineValue` request.
+     *
+     * @since 3.17.0
+     * @proposed
+     */
+    inlineValue?: InlineValueClientCapabilities;
+    /**
+     * Capabilities specific to the `textDocument/inlayHint` request.
      *
-     * @since 3.17.0 - proposed state
+     * @since 3.17.0
+     * @proposed
      */
-    inlineValues?: InlineValuesClientCapabilities;
+    inlayHint?: InlayHintClientCapabilities;
 }
 export interface WindowClientCapabilities {
     /**
-     * Whether client supports handling progress notifications. If set
-     * servers are allowed to report in `workDoneProgress` property in the
-     * request specific server capabilities.
+     * It indicates whether the client supports server initiated
+     * progress using the `window/workDoneProgress/create` request.
+     *
+     * The capability also controls Whether client supports handling
+     * of progress notifications. If set servers are allowed to report a
+     * `workDoneProgress` property in the request specific server
+     * capabilities.
      *
      * @since 3.15.0
      */
@@ -551,6 +574,41 @@ export interface MarkdownClientCapabilities {
      */
     allowedTags?: string[];
 }
+/**
+ * A set of predefined position encoding kinds.
+ *
+ * @since 3.17.0
+ * @proposed
+ */
+export declare namespace PositionEncodingKind {
+    /**
+     * Character offsets count UTF-8 code units.
+     */
+    const UTF8: PositionEncodingKind;
+    /**
+     * Character offsets count UTF-16 code units.
+     *
+     * This is the default and must always be supported
+     * by servers
+     */
+    const UTF16: PositionEncodingKind;
+    /**
+     * Character offsets count UTF-32 code units.
+     *
+     * Implementation note: these are the same as Unicode code points,
+     * so this `PositionEncodingKind` may also be used for an
+     * encoding-agnostic representation of character offsets.
+     */
+    const UTF32: PositionEncodingKind;
+}
+/**
+ * A type indicating how positions are encoded,
+ * specifically what column offsets mean.
+ *
+ * @since 3.17.0
+ * @proposed
+ */
+export declare type PositionEncodingKind = string;
 /**
  * General client capabilities.
  *
@@ -564,6 +622,7 @@ export interface GeneralClientCapabilities {
      * anymore since the information is outdated).
      *
      * @since 3.17.0
+     * @proposed
      */
     staleRequestSupport?: {
         /**
@@ -589,11 +648,33 @@ export interface GeneralClientCapabilities {
      * @since 3.16.0
      */
     markdown?: MarkdownClientCapabilities;
+    /**
+     * The position encodings supported by the client. Client and server
+     * have to agree on the same position encoding to ensure that offsets
+     * (e.g. character position in a line) are interpreted the same on both
+     * side.
+     *
+     * To keep the protocol backwards compatible the following applies: if
+     * the value 'utf-16' is missing from the array of position encodings
+     * servers can assume that the client supports UTF-16. UTF-16 is
+     * therefore a mandatory encoding.
+     *
+     * If omitted it defaults to ['utf-16'].
+     *
+     * Implementation considerations: since the conversion from one encoding
+     * into another requires the content of the file / line the conversion
+     * is best done where the file is read which is usually on the server
+     * side.
+     *
+     * @since 3.17.0
+     * @proposed
+     */
+    positionEncodings?: PositionEncodingKind[];
 }
 /**
  * Defines the capabilities provided by the client.
  */
-export interface _ClientCapabilities {
+export interface ClientCapabilities {
     /**
      * Workspace specific client capabilities.
      */
@@ -617,7 +698,6 @@ export interface _ClientCapabilities {
      */
     experimental?: object;
 }
-export declare type ClientCapabilities = _ClientCapabilities & WorkspaceFoldersClientCapabilities & ConfigurationClientCapabilities & WorkDoneProgressClientCapabilities;
 /**
  * Static registration options to be returned in the initialize
  * request.
@@ -681,7 +761,22 @@ export declare namespace WorkDoneProgressOptions {
  * Defines the capabilities provided by a language
  * server.
  */
-export interface _ServerCapabilities<T = any> {
+export interface ServerCapabilities<T = any> {
+    /**
+     * The position encoding the server picked from the encodings offered
+     * by the client via the client capability `general.positionEncodings`.
+     *
+     * If the client didn't provide any position encodings the only valid
+     * value that a server can return is 'utf-16'.
+     *
+     * If omitted it defaults to 'utf-16'.
+     *
+     * If for some reason
+     *
+     * @since 3.17.0
+     * @proposed
+     */
+    positionEncoding?: PositionEncodingKind;
     /**
      * Defines how text documents are synced. Is either a detailed structure defining each notification or
      * for backwards compatibility the TextDocumentSyncKind number.
@@ -797,17 +892,6 @@ export interface _ServerCapabilities<T = any> {
      * @since 3.16.0
      */
     semanticTokensProvider?: SemanticTokensOptions | SemanticTokensRegistrationOptions;
-    /**
-     * Window specific server capabilities.
-     */
-    workspace?: {
-        /**
-        * The server is interested in notifications/requests for operations on files.
-        *
-        * @since 3.16.0
-        */
-        fileOperations?: FileOperationOptions;
-    };
     /**
      * The server provides moniker support.
      *
@@ -817,21 +901,46 @@ export interface _ServerCapabilities<T = any> {
     /**
      * The server provides type hierarchy support.
      *
-     * @since 3.17.0 - proposed state
+     * @since 3.17.0
+     * @proposed
      */
     typeHierarchyProvider?: boolean | TypeHierarchyOptions | TypeHierarchyRegistrationOptions;
     /**
      * The server provides inline values.
      *
-     * @since 3.17.0 - proposed state
+     * @since 3.17.0
+     * @proposed
+     */
+    inlineValueProvider?: boolean | InlineValueOptions | InlineValueRegistrationOptions;
+    /**
+     * The server provides inlay hints.
+     *
+     * @since 3.17.0
+     * @proposed
+     */
+    inlayHintProvider?: boolean | InlayHintOptions | InlayHintRegistrationOptions;
+    /**
+     * Workspace specific server capabilities.
      */
-    inlineValuesProvider?: boolean | InlineValuesOptions | InlineValuesRegistrationOptions;
+    workspace?: {
+        /**
+         * The server supports workspace folder.
+         *
+         * @since 3.6.0
+         */
+        workspaceFolders?: WorkspaceFoldersServerCapabilities;
+        /**
+        * The server is interested in notifications/requests for operations on files.
+        *
+        * @since 3.16.0
+        */
+        fileOperations?: FileOperationOptions;
+    };
     /**
      * Experimental server capabilities.
      */
     experimental?: T;
 }
-export declare type ServerCapabilities<T = any> = _ServerCapabilities<T> & WorkspaceFoldersServerCapabilities;
 /**
  * The initialize request is sent from the client to the server.
  * It is sent once as the request after starting up the server.
@@ -840,7 +949,7 @@ export declare type ServerCapabilities<T = any> = _ServerCapabilities<T> & Works
  * resolves to such.
  */
 export declare namespace InitializeRequest {
-    const type: ProtocolRequestType<_InitializeParams & WorkspaceFoldersInitializeParams & WorkDoneProgressParams, InitializeResult<any>, never, InitializeError, void>;
+    const type: ProtocolRequestType<InitializeParams, InitializeResult<any>, never, InitializeError, void>;
 }
 /**
  * The initialize parameters
@@ -935,16 +1044,18 @@ export interface InitializeResult<T = any> {
     [custom: string]: LSPAny | ServerCapabilities<T> | undefined; /** undefined is needed since serverInfo is optional */
 }
 /**
- * Known error codes for an `InitializeError`;
+ * Known error codes for an `InitializeErrorCodes`;
  */
-export declare namespace InitializeError {
+export declare namespace InitializeErrorCodes {
     /**
      * If the protocol version provided by the client can't be handled by the server.
+     *
      * @deprecated This initialize error got replaced by client capabilities. There is
      * no version handshake in version 3.0x
      */
     const unknownProtocolVersion: 1;
 }
+export declare type InitializeErrorCodes = 1;
 /**
  * The data type of the ResponseError if the
  * initialize request fails.
@@ -1126,7 +1237,7 @@ export interface LogMessageParams {
  * the client to log telemetry data.
  */
 export declare namespace TelemetryEventNotification {
-    const type: ProtocolNotificationType<any, void>;
+    const type: ProtocolNotificationType<LSPAny, void>;
 }
 export interface TextDocumentSyncClientCapabilities {
     /**
@@ -1411,6 +1522,13 @@ export interface DidChangeWatchedFilesClientCapabilities {
      * from the server side.
      */
     dynamicRegistration?: boolean;
+    /**
+     * Whether the client has support for {@link  RelativePattern relative pattern}
+     * or not.
+     *
+     * @since 3.17.0
+     */
+    relativePatternSupport?: boolean;
 }
 /**
  * The watched files notification is sent from the client to the server when
@@ -1468,17 +1586,52 @@ export interface DidChangeWatchedFilesRegistrationOptions {
      */
     watchers: FileSystemWatcher[];
 }
+/**
+ * The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
+ * - `*` to match one or more characters in a path segment
+ * - `?` to match on one character in a path segment
+ * - `**` to match any number of path segments, including none
+ * - `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+ * - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+ * - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+ *
+ * @since 3.17.0
+ */
+export declare type Pattern = string;
+/**
+ * A relative pattern is a helper to construct glob patterns that are matched
+ * relatively to a base URI. The common value for a `baseUri` is a workspace
+ * folder root, but it can be another absolute URI as well.
+ *
+ * @since 3.17.0
+ */
+export interface RelativePattern {
+    /**
+     * A workspace folder or a base URI to which this pattern will be matched
+     * against relatively.
+     */
+    baseUri: WorkspaceFolder | URI;
+    /**
+     * The actual glob pattern;
+     */
+    pattern: Pattern;
+}
+export declare namespace RelativePattern {
+    function is(value: any): value is RelativePattern;
+}
+/**
+ * The glob pattern. Either a string pattern or a relative pattern.
+ *
+ * @since 3.17.0
+ */
+export declare type GlobPattern = Pattern | RelativePattern;
 export interface FileSystemWatcher {
     /**
-     * The  glob pattern to watch. Glob patterns can have the following syntax:
-     * - `*` to match one or more characters in a path segment
-     * - `?` to match on one character in a path segment
-     * - `**` to match any number of path segments, including none
-     * - `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
-     * - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
-     * - `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+     * The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.
+     *
+     * @since 3.17.0 support for relative patterns.
      */
-    globPattern: string;
+    globPattern: GlobPattern;
     /**
      * The kind of events of interest. If omitted it defaults
      * to WatchKind.Create | WatchKind.Change | WatchKind.Delete
@@ -1607,9 +1760,6 @@ export interface CompletionClientCapabilities {
          * Client supports the preselect property on a completion item.
          */
         preselectSupport?: boolean;
-        /**
-         * Client supports to kee
-         */
         /**
          * Client supports the tag property on a completion item. Clients supporting
          * tags have to handle unknown tags gracefully. Clients especially need to
@@ -1658,7 +1808,8 @@ export interface CompletionClientCapabilities {
          * The client has support for completion item label
          * details (see also `CompletionItemLabelDetails`).
          *
-         * @since 3.17.0 - proposed state
+         * @since 3.17.0
+         * @proposed
          */
         labelDetailsSupport?: boolean;
     };
@@ -1680,7 +1831,8 @@ export interface CompletionClientCapabilities {
      * when accepting a completion item that uses multi line
      * text in either `insertText` or `textEdit`.
      *
-     * @since 3.17.0 - proposed state
+     * @since 3.17.0
+     * @proposed
      */
     insertTextMode?: InsertTextMode;
     /**
@@ -1692,7 +1844,8 @@ export interface CompletionClientCapabilities {
      * The client supports the following `CompletionList` specific
      * capabilities.
      *
-     * @since 3.17.0 - proposed state
+     * @since 3.17.0
+     * @proposed
      */
     completionList?: {
         /**
@@ -1703,7 +1856,8 @@ export interface CompletionClientCapabilities {
          * `CompletionList.itemDefaults` object. If omitted
          * no properties are supported.
          *
-         * @since 3.17.0 - proposed state
+         * @since 3.17.0
+         * @proposed
          */
         itemDefaults?: string[];
     };
@@ -1787,7 +1941,8 @@ export interface CompletionOptions extends WorkDoneProgressOptions {
      * The server supports the following `CompletionItem` specific
      * capabilities.
      *
-     * @since 3.17.0 - proposed state
+     * @since 3.17.0
+     * @proposed
      */
     completionItem?: {
         /**
@@ -1795,7 +1950,8 @@ export interface CompletionOptions extends WorkDoneProgressOptions {
          * details (see also `CompletionItemLabelDetails`) when
          * receiving a completion item in a resolve call.
          *
-         * @since 3.17.0 - proposed state
+         * @since 3.17.0
+         * @proposed
          */
         labelDetailsSupport?: boolean;
     };
@@ -2396,7 +2552,8 @@ export interface WorkspaceSymbolOptions extends WorkDoneProgressOptions {
      * The server provides support to resolve additional
      * information for a workspace symbol.
      *
-     * @since 3.17.0 - proposed state
+     * @since 3.17.0
+     * @proposed
      */
     resolveProvider?: boolean;
 }
@@ -2424,7 +2581,8 @@ export declare namespace WorkspaceSymbolRequest {
  * A request to resolve the range inside the workspace
  * symbol's location.
  *
- * @since 3.17.0 - proposed state
+ * @since 3.17.0
+ * @proposed
  */
 export declare namespace WorkspaceSymbolResolveRequest {
     const method: 'workspaceSymbol/resolve';
@@ -2654,11 +2812,16 @@ export interface DocumentOnTypeFormattingParams {
      */
     textDocument: TextDocumentIdentifier;
     /**
-     * The position at which this request was send.
+     * The position around which the on type formatting should happen.
+     * This is not necessarily the exact position where the character denoted
+     * by the property `ch` got typed.
      */
     position: Position;
     /**
-     * The character that has been typed.
+     * The character that has been typed that triggered the formatting
+     * on type request. That is not necessarily the last character that
+     * got inserted into the document since the client could auto insert
+     * characters as well (e.g. like automatic brace completion).
      */
     ch: string;
     /**
@@ -2671,7 +2834,7 @@ export interface DocumentOnTypeFormattingParams {
  */
 export interface DocumentOnTypeFormattingOptions {
     /**
-     * A character on which formatting should be triggered, like `}`.
+     * A character on which formatting should be triggered, like `{}`.
      */
     firstTriggerCharacter: string;
     /**
@@ -2775,6 +2938,12 @@ export declare namespace RenameRequest {
 }
 export interface PrepareRenameParams extends TextDocumentPositionParams, WorkDoneProgressParams {
 }
+export declare type PrepareRenameResult = Range | {
+    range: Range;
+    placeholder: string;
+} | {
+    defaultBehavior: boolean;
+};
 /**
  * A request to test and perform the setup necessary for a rename.
  *
@@ -2782,12 +2951,7 @@ export interface PrepareRenameParams extends TextDocumentPositionParams, WorkDon
  */
 export declare namespace PrepareRenameRequest {
     const method: 'textDocument/prepareRename';
-    const type: ProtocolRequestType<PrepareRenameParams, Range | {
-        range: Range;
-        placeholder: string;
-    } | {
-        defaultBehavior: boolean;
-    } | null, never, void, void>;
+    const type: ProtocolRequestType<PrepareRenameParams, PrepareRenameResult | null, never, void, void>;
 }
 /**
  * The client capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
@@ -2830,7 +2994,7 @@ export interface ExecuteCommandRegistrationOptions extends ExecuteCommandOptions
  * a workspace edit which the client will apply to the workspace.
  */
 export declare namespace ExecuteCommandRequest {
-    const type: ProtocolRequestType<ExecuteCommandParams, void | LSPAny, never, void, ExecuteCommandRegistrationOptions>;
+    const type: ProtocolRequestType<ExecuteCommandParams, LSPAny, never, void, ExecuteCommandRegistrationOptions>;
 }
 export interface WorkspaceEditClientCapabilities {
     /**
@@ -2924,5 +3088,5 @@ export declare type ApplyWorkspaceEditResponse = ApplyWorkspaceEditResult;
 export declare namespace ApplyWorkspaceEditRequest {
     const type: ProtocolRequestType<ApplyWorkspaceEditParams, ApplyWorkspaceEditResult, never, void, void>;
 }
-export { ImplementationRequest, ImplementationParams, ImplementationRegistrationOptions, ImplementationOptions, TypeDefinitionRequest, TypeDefinitionParams, TypeDefinitionRegistrationOptions, TypeDefinitionOptions, WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams, WorkspaceFolder, WorkspaceFoldersChangeEvent, ConfigurationRequest, ConfigurationParams, ConfigurationItem, DocumentColorRequest, ColorPresentationRequest, DocumentColorOptions, DocumentColorParams, ColorPresentationParams, DocumentColorRegistrationOptions, FoldingRangeClientCapabilities, FoldingRangeOptions, FoldingRangeRequest, FoldingRangeParams, FoldingRangeRegistrationOptions, DeclarationClientCapabilities, DeclarationRequest, DeclarationParams, DeclarationRegistrationOptions, DeclarationOptions, SelectionRangeClientCapabilities, SelectionRangeOptions, SelectionRangeParams, SelectionRangeRequest, SelectionRangeRegistrationOptions, WorkDoneProgressBegin, WorkDoneProgressReport, WorkDoneProgressEnd, WorkDoneProgress, WorkDoneProgressCreateParams, WorkDoneProgressCreateRequest, WorkDoneProgressCancelParams, WorkDoneProgressCancelNotification, CallHierarchyClientCapabilities, CallHierarchyOptions, CallHierarchyRegistrationOptions, CallHierarchyIncomingCallsParams, CallHierarchyIncomingCallsRequest, CallHierarchyOutgoingCallsParams, CallHierarchyOutgoingCallsRequest, CallHierarchyPrepareParams, CallHierarchyPrepareRequest, SemanticTokensPartialResult, SemanticTokensDeltaPartialResult, TokenFormat, SemanticTokensClientCapabilities, SemanticTokensOptions, SemanticTokensRegistrationOptions, SemanticTokensParams, SemanticTokensRequest, SemanticTokensDeltaParams, SemanticTokensDeltaRequest, SemanticTokensRangeParams, SemanticTokensRangeRequest, SemanticTokensRefreshRequest, SemanticTokensRegistrationType, ShowDocumentParams, ShowDocumentRequest, ShowDocumentResult, ShowDocumentClientCapabilities, LinkedEditingRangeClientCapabilities, LinkedEditingRanges, LinkedEditingRangeOptions, LinkedEditingRangeParams, LinkedEditingRangeRegistrationOptions, LinkedEditingRangeRequest, FileOperationOptions, FileOperationClientCapabilities, FileOperationRegistrationOptions, FileOperationPatternOptions, FileOperationPatternKind, DidCreateFilesNotification, CreateFilesParams, FileCreate, WillCreateFilesRequest, DidRenameFilesNotification, RenameFilesParams, FileRename, WillRenameFilesRequest, DidDeleteFilesNotification, DeleteFilesParams, FileDelete, WillDeleteFilesRequest, UniquenessLevel, MonikerKind, Moniker, MonikerClientCapabilities, MonikerOptions, MonikerRegistrationOptions, MonikerParams, MonikerRequest, };
+export { ImplementationRequest, ImplementationParams, ImplementationRegistrationOptions, ImplementationOptions, TypeDefinitionRequest, TypeDefinitionParams, TypeDefinitionRegistrationOptions, TypeDefinitionOptions, WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams, WorkspaceFoldersChangeEvent, ConfigurationRequest, ConfigurationParams, ConfigurationItem, DocumentColorRequest, ColorPresentationRequest, DocumentColorOptions, DocumentColorParams, ColorPresentationParams, DocumentColorRegistrationOptions, FoldingRangeClientCapabilities, FoldingRangeOptions, FoldingRangeRequest, FoldingRangeParams, FoldingRangeRegistrationOptions, DeclarationClientCapabilities, DeclarationRequest, DeclarationParams, DeclarationRegistrationOptions, DeclarationOptions, SelectionRangeClientCapabilities, SelectionRangeOptions, SelectionRangeParams, SelectionRangeRequest, SelectionRangeRegistrationOptions, WorkDoneProgressBegin, WorkDoneProgressReport, WorkDoneProgressEnd, WorkDoneProgress, WorkDoneProgressCreateParams, WorkDoneProgressCreateRequest, WorkDoneProgressCancelParams, WorkDoneProgressCancelNotification, CallHierarchyClientCapabilities, CallHierarchyOptions, CallHierarchyRegistrationOptions, CallHierarchyIncomingCallsParams, CallHierarchyIncomingCallsRequest, CallHierarchyOutgoingCallsParams, CallHierarchyOutgoingCallsRequest, CallHierarchyPrepareParams, CallHierarchyPrepareRequest, SemanticTokensPartialResult, SemanticTokensDeltaPartialResult, TokenFormat, SemanticTokensClientCapabilities, SemanticTokensOptions, SemanticTokensRegistrationOptions, SemanticTokensParams, SemanticTokensRequest, SemanticTokensDeltaParams, SemanticTokensDeltaRequest, SemanticTokensRangeParams, SemanticTokensRangeRequest, SemanticTokensRefreshRequest, SemanticTokensRegistrationType, ShowDocumentParams, ShowDocumentRequest, ShowDocumentResult, ShowDocumentClientCapabilities, LinkedEditingRangeClientCapabilities, LinkedEditingRanges, LinkedEditingRangeOptions, LinkedEditingRangeParams, LinkedEditingRangeRegistrationOptions, LinkedEditingRangeRequest, FileOperationOptions, FileOperationClientCapabilities, FileOperationRegistrationOptions, FileOperationPatternOptions, FileOperationPatternKind, DidCreateFilesNotification, CreateFilesParams, FileCreate, WillCreateFilesRequest, DidRenameFilesNotification, RenameFilesParams, FileRename, WillRenameFilesRequest, DidDeleteFilesNotification, DeleteFilesParams, FileDelete, WillDeleteFilesRequest, UniquenessLevel, MonikerKind, Moniker, MonikerClientCapabilities, MonikerOptions, MonikerRegistrationOptions, MonikerParams, MonikerRequest, TypeHierarchyClientCapabilities, TypeHierarchyOptions, TypeHierarchyRegistrationOptions, TypeHierarchyPrepareParams, TypeHierarchyPrepareRequest, TypeHierarchySubtypesParams, TypeHierarchySubtypesRequest, TypeHierarchySupertypesParams, TypeHierarchySupertypesRequest, InlineValueClientCapabilities, InlineValueOptions, InlineValueRegistrationOptions, InlineValueWorkspaceClientCapabilities, InlineValueParams, InlineValueRequest, InlineValueRefreshRequest, InlayHintClientCapabilities, InlayHintOptions, InlayHintRegistrationOptions, InlayHintWorkspaceClientCapabilities, InlayHintParams, InlayHintRequest, InlayHintResolveRequest, InlayHintRefreshRequest, };
 export { DocumentColorOptions as ColorProviderOptions, DocumentColorOptions as ColorOptions, FoldingRangeOptions as FoldingRangeProviderOptions, SelectionRangeOptions as SelectionRangeProviderOptions, DocumentColorRegistrationOptions as ColorRegistrationOptions };