vscode-languageserver-protocol 3.17.0-next.2 → 3.17.0-next.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/browser/main.js +1 -1
- package/lib/common/api.d.ts +31 -10
- package/lib/common/api.js +32 -7
- package/lib/common/connection.d.ts +45 -21
- package/lib/common/connection.js +1 -1
- package/lib/common/messages.js +0 -3
- package/lib/common/protocol.$.d.ts +8 -0
- package/lib/common/protocol.$.js +19 -0
- package/lib/common/protocol.callHierarchy.d.ts +1 -1
- package/lib/common/protocol.callHierarchy.js +1 -1
- package/lib/common/protocol.colorProvider.d.ts +1 -1
- package/lib/common/protocol.configuration.d.ts +5 -17
- package/lib/common/protocol.configuration.js +1 -0
- package/lib/common/protocol.d.ts +488 -70
- package/lib/common/protocol.declaration.d.ts +3 -3
- package/lib/common/protocol.declaration.js +2 -2
- package/lib/common/protocol.diagnostic.d.ts +364 -0
- package/lib/common/protocol.diagnostic.js +77 -0
- package/lib/common/protocol.fileOperations.d.ts +1 -1
- package/lib/common/protocol.foldingRange.d.ts +43 -27
- package/lib/common/protocol.foldingRange.js +1 -19
- package/lib/common/protocol.implementation.d.ts +3 -3
- package/lib/common/protocol.implementation.js +2 -2
- package/lib/common/protocol.inlayHint.d.ts +115 -0
- package/lib/common/protocol.inlayHint.js +44 -0
- package/lib/common/protocol.inlineValue.d.ts +91 -0
- package/lib/common/protocol.inlineValue.js +31 -0
- package/lib/common/protocol.js +137 -18
- package/lib/common/protocol.linkedEditingRange.d.ts +2 -2
- package/lib/common/protocol.moniker.d.ts +13 -11
- package/lib/common/protocol.moniker.js +8 -8
- package/lib/common/protocol.notebook.d.ts +402 -0
- package/lib/common/protocol.notebook.js +210 -0
- package/lib/common/protocol.progress.d.ts +2 -14
- package/lib/common/protocol.progress.js +4 -2
- package/lib/common/protocol.selectionRange.d.ts +2 -2
- package/lib/common/protocol.semanticTokens.d.ts +27 -2
- package/lib/common/protocol.typeDefinition.d.ts +2 -2
- package/lib/common/protocol.typeHierarchy.d.ts +89 -0
- package/lib/common/protocol.typeHierarchy.js +43 -0
- package/lib/common/{protocol.workspaceFolders.d.ts → protocol.workspaceFolder.d.ts} +11 -41
- package/lib/common/{protocol.workspaceFolders.js → protocol.workspaceFolder.js} +1 -1
- package/lib/node/main.js +1 -1
- package/metaModel.schema.json +705 -0
- package/package.json +4 -4
- package/lib/common/proposed.diagnostic.d.ts +0 -46
- package/lib/common/proposed.diagnostic.js +0 -23
package/lib/common/protocol.d.ts
CHANGED
|
@@ -1,21 +1,26 @@
|
|
|
1
1
|
import { ProgressToken } from 'vscode-jsonrpc';
|
|
2
2
|
import { ProtocolRequestType, ProtocolRequestType0, ProtocolNotificationType, ProtocolNotificationType0 } from './messages';
|
|
3
|
-
import { Position, Range, Location, LocationLink, Diagnostic, Command, TextEdit, WorkspaceEdit, DocumentUri, TextDocumentIdentifier, VersionedTextDocumentIdentifier, TextDocumentItem, CompletionItem, CompletionList, Hover, SignatureHelp, ReferenceContext, DocumentHighlight, SymbolInformation, CodeLens, CodeActionContext, FormattingOptions, DocumentLink, MarkupKind, SymbolKind, CompletionItemKind, CodeAction, CodeActionKind, DocumentSymbol, CompletionItemTag, DiagnosticTag, SymbolTag, uinteger, integer, InsertTextMode } from 'vscode-languageserver-types';
|
|
3
|
+
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';
|
|
4
4
|
import { ImplementationRequest, ImplementationClientCapabilities, ImplementationOptions, ImplementationRegistrationOptions, ImplementationParams } from './protocol.implementation';
|
|
5
5
|
import { TypeDefinitionRequest, TypeDefinitionClientCapabilities, TypeDefinitionOptions, TypeDefinitionRegistrationOptions, TypeDefinitionParams } from './protocol.typeDefinition';
|
|
6
|
-
import { WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams,
|
|
7
|
-
import { ConfigurationRequest, ConfigurationParams, ConfigurationItem
|
|
6
|
+
import { WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams, WorkspaceFoldersChangeEvent, WorkspaceFoldersInitializeParams, WorkspaceFoldersServerCapabilities } from './protocol.workspaceFolder';
|
|
7
|
+
import { ConfigurationRequest, ConfigurationParams, ConfigurationItem } from './protocol.configuration';
|
|
8
8
|
import { DocumentColorRequest, ColorPresentationRequest, DocumentColorOptions, DocumentColorParams, ColorPresentationParams, DocumentColorClientCapabilities, DocumentColorRegistrationOptions } from './protocol.colorProvider';
|
|
9
9
|
import { FoldingRangeClientCapabilities, FoldingRangeOptions, FoldingRangeRequest, FoldingRangeParams, FoldingRangeRegistrationOptions } from './protocol.foldingRange';
|
|
10
10
|
import { DeclarationClientCapabilities, DeclarationRequest, DeclarationOptions, DeclarationRegistrationOptions, DeclarationParams } from './protocol.declaration';
|
|
11
11
|
import { SelectionRangeClientCapabilities, SelectionRangeOptions, SelectionRangeRequest, SelectionRangeParams, SelectionRangeRegistrationOptions } from './protocol.selectionRange';
|
|
12
|
-
import {
|
|
12
|
+
import { WorkDoneProgressBegin, WorkDoneProgressReport, WorkDoneProgressEnd, WorkDoneProgress, WorkDoneProgressCreateParams, WorkDoneProgressCreateRequest, WorkDoneProgressCancelParams, WorkDoneProgressCancelNotification } from './protocol.progress';
|
|
13
13
|
import { CallHierarchyClientCapabilities, CallHierarchyOptions, CallHierarchyRegistrationOptions, CallHierarchyIncomingCallsParams, CallHierarchyIncomingCallsRequest, CallHierarchyOutgoingCallsParams, CallHierarchyOutgoingCallsRequest, CallHierarchyPrepareParams, CallHierarchyPrepareRequest } from './protocol.callHierarchy';
|
|
14
14
|
import { SemanticTokensPartialResult, SemanticTokensDeltaPartialResult, TokenFormat, SemanticTokensClientCapabilities, SemanticTokensOptions, SemanticTokensRegistrationOptions, SemanticTokensParams, SemanticTokensRequest, SemanticTokensDeltaParams, SemanticTokensDeltaRequest, SemanticTokensRangeParams, SemanticTokensRangeRequest, SemanticTokensRefreshRequest, SemanticTokensWorkspaceClientCapabilities, SemanticTokensRegistrationType } from './protocol.semanticTokens';
|
|
15
15
|
import { ShowDocumentParams, ShowDocumentResult, ShowDocumentRequest, ShowDocumentClientCapabilities } from './protocol.showDocument';
|
|
16
16
|
import { LinkedEditingRangeClientCapabilities, LinkedEditingRanges, LinkedEditingRangeOptions, LinkedEditingRangeParams, LinkedEditingRangeRegistrationOptions, LinkedEditingRangeRequest } from './protocol.linkedEditingRange';
|
|
17
17
|
import { FileOperationOptions, FileOperationClientCapabilities, FileOperationRegistrationOptions, FileOperationPatternOptions, FileOperationPatternKind, DidCreateFilesNotification, CreateFilesParams, FileCreate, WillCreateFilesRequest, DidRenameFilesNotification, RenameFilesParams, FileRename, WillRenameFilesRequest, DidDeleteFilesNotification, DeleteFilesParams, FileDelete, WillDeleteFilesRequest } from './protocol.fileOperations';
|
|
18
18
|
import { UniquenessLevel, MonikerKind, Moniker, MonikerClientCapabilities, MonikerOptions, MonikerRegistrationOptions, MonikerParams, MonikerRequest } from './protocol.moniker';
|
|
19
|
+
import { TypeHierarchyClientCapabilities, TypeHierarchyOptions, TypeHierarchyRegistrationOptions, TypeHierarchyPrepareParams, TypeHierarchyPrepareRequest, TypeHierarchySubtypesParams, TypeHierarchySubtypesRequest, TypeHierarchySupertypesParams, TypeHierarchySupertypesRequest } from './protocol.typeHierarchy';
|
|
20
|
+
import { InlineValueClientCapabilities, InlineValueOptions, InlineValueRegistrationOptions, InlineValueWorkspaceClientCapabilities, InlineValueParams, InlineValueRequest, InlineValueRefreshRequest } from './protocol.inlineValue';
|
|
21
|
+
import { InlayHintClientCapabilities, InlayHintOptions, InlayHintRegistrationOptions, InlayHintWorkspaceClientCapabilities, InlayHintParams, InlayHintRequest, InlayHintResolveRequest, InlayHintRefreshRequest } from './protocol.inlayHint';
|
|
22
|
+
import { DiagnosticClientCapabilities, DiagnosticOptions, DiagnosticRegistrationOptions, DiagnosticServerCancellationData, DocumentDiagnosticParams, DocumentDiagnosticReportKind, FullDocumentDiagnosticReport, RelatedFullDocumentDiagnosticReport, UnchangedDocumentDiagnosticReport, RelatedUnchangedDocumentDiagnosticReport, DocumentDiagnosticReport, DocumentDiagnosticReportPartialResult, DocumentDiagnosticRequest, PreviousResultId, WorkspaceDiagnosticParams, WorkspaceFullDocumentDiagnosticReport, WorkspaceUnchangedDocumentDiagnosticReport, WorkspaceDocumentDiagnosticReport, WorkspaceDiagnosticReport, WorkspaceDiagnosticReportPartialResult, WorkspaceDiagnosticRequest, DiagnosticRefreshRequest, DiagnosticWorkspaceClientCapabilities } from './protocol.diagnostic';
|
|
23
|
+
import { NotebookDocumentSyncClientCapabilities, NotebookCellKind, ExecutionSummary, NotebookCell, NotebookDocument, NotebookDocumentIdentifier, VersionedNotebookDocumentIdentifier, NotebookDocumentSyncOptions, NotebookDocumentSyncRegistrationOptions, NotebookDocumentSyncRegistrationType, DidOpenNotebookDocumentParams, DidOpenNotebookDocumentNotification, NotebookCellArrayChange, NotebookDocumentChangeEvent, DidChangeNotebookDocumentParams, DidChangeNotebookDocumentNotification, DidSaveNotebookDocumentParams, DidSaveNotebookDocumentNotification, DidCloseNotebookDocumentParams, DidCloseNotebookDocumentNotification } from './protocol.notebook';
|
|
19
24
|
/**
|
|
20
25
|
* A document filter denotes a document by different properties like
|
|
21
26
|
* the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
|
|
@@ -25,14 +30,17 @@ import { UniquenessLevel, MonikerKind, Moniker, MonikerClientCapabilities, Monik
|
|
|
25
30
|
* - `*` to match one or more characters in a path segment
|
|
26
31
|
* - `?` to match on one character in a path segment
|
|
27
32
|
* - `**` to match any number of path segments, including none
|
|
28
|
-
* - `{}` to group
|
|
33
|
+
* - `{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
|
|
29
34
|
* - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
|
|
30
35
|
* - `[!...]` 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`)
|
|
31
36
|
*
|
|
32
37
|
* @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
|
|
33
38
|
* @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
|
|
39
|
+
*
|
|
40
|
+
* @since 3.17.0
|
|
41
|
+
* @proposed
|
|
34
42
|
*/
|
|
35
|
-
export declare type
|
|
43
|
+
export declare type TextDocumentFilter = {
|
|
36
44
|
/** A language id, like `typescript`. */
|
|
37
45
|
language: string;
|
|
38
46
|
/** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
|
|
@@ -55,12 +63,95 @@ export declare type DocumentFilter = {
|
|
|
55
63
|
pattern: string;
|
|
56
64
|
};
|
|
57
65
|
/**
|
|
58
|
-
* The
|
|
59
|
-
* [
|
|
66
|
+
* The TextDocumentFilter namespace provides helper functions to work with
|
|
67
|
+
* [TextDocumentFilter](#TextDocumentFilter) literals.
|
|
68
|
+
*
|
|
69
|
+
* @since 3.17.0
|
|
70
|
+
* @proposed
|
|
60
71
|
*/
|
|
61
|
-
export declare namespace
|
|
62
|
-
function is(value: any): value is
|
|
72
|
+
export declare namespace TextDocumentFilter {
|
|
73
|
+
function is(value: any): value is TextDocumentFilter;
|
|
63
74
|
}
|
|
75
|
+
/**
|
|
76
|
+
* A notebook document filter denotes a notebook document by
|
|
77
|
+
* different properties. The properties will be match
|
|
78
|
+
* against the notebook's URI (same as with documents)
|
|
79
|
+
*
|
|
80
|
+
* @since 3.17.0
|
|
81
|
+
* @proposed
|
|
82
|
+
*/
|
|
83
|
+
export declare type NotebookDocumentFilter = {
|
|
84
|
+
/** The type of the enclosing notebook. */
|
|
85
|
+
notebookType: string;
|
|
86
|
+
/** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
|
|
87
|
+
scheme?: string;
|
|
88
|
+
/** A glob pattern. */
|
|
89
|
+
pattern?: string;
|
|
90
|
+
} | {
|
|
91
|
+
/** The type of the enclosing notebook. */
|
|
92
|
+
notebookType?: string;
|
|
93
|
+
/** A Uri [scheme](#Uri.scheme), like `file` or `untitled`.*/
|
|
94
|
+
scheme: string;
|
|
95
|
+
/** A glob pattern. */
|
|
96
|
+
pattern?: string;
|
|
97
|
+
} | {
|
|
98
|
+
/** The type of the enclosing notebook. */
|
|
99
|
+
notebookType?: string;
|
|
100
|
+
/** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
|
|
101
|
+
scheme?: string;
|
|
102
|
+
/** A glob pattern. */
|
|
103
|
+
pattern: string;
|
|
104
|
+
};
|
|
105
|
+
/**
|
|
106
|
+
* The NotebookDocumentFilter namespace provides helper functions to work with
|
|
107
|
+
* [NotebookDocumentFilter](#NotebookDocumentFilter) literals.
|
|
108
|
+
*
|
|
109
|
+
* @since 3.17.0
|
|
110
|
+
* @proposed
|
|
111
|
+
*/
|
|
112
|
+
export declare namespace NotebookDocumentFilter {
|
|
113
|
+
function is(value: any): value is NotebookDocumentFilter;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* A notebook cell text document filter denotes a cell text
|
|
117
|
+
* document by different properties.
|
|
118
|
+
*
|
|
119
|
+
* @since 3.17.0
|
|
120
|
+
* @proposed
|
|
121
|
+
*/
|
|
122
|
+
export declare type NotebookCellTextDocumentFilter = {
|
|
123
|
+
/**
|
|
124
|
+
* A filter that matches against the notebook
|
|
125
|
+
* containing the notebook cell. If a string
|
|
126
|
+
* value is provided it matches against the
|
|
127
|
+
* notebook type. '*' matches every notebook.
|
|
128
|
+
*/
|
|
129
|
+
notebook: string | NotebookDocumentFilter;
|
|
130
|
+
/**
|
|
131
|
+
* A language id like `python`.
|
|
132
|
+
*
|
|
133
|
+
* Will be matched against the language id of the
|
|
134
|
+
* notebook cell document. '*' matches every language.
|
|
135
|
+
*/
|
|
136
|
+
language?: string;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* The NotebookCellTextDocumentFilter namespace provides helper functions to work with
|
|
140
|
+
* [NotebookCellTextDocumentFilter](#NotebookCellTextDocumentFilter) literals.
|
|
141
|
+
*
|
|
142
|
+
* @since 3.17.0
|
|
143
|
+
* @proposed
|
|
144
|
+
*/
|
|
145
|
+
export declare namespace NotebookCellTextDocumentFilter {
|
|
146
|
+
function is(value: any): value is NotebookCellTextDocumentFilter;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* A document filter describes a top level text document or
|
|
150
|
+
* a notebook cell document.
|
|
151
|
+
*
|
|
152
|
+
* @since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
|
|
153
|
+
*/
|
|
154
|
+
export declare type DocumentFilter = TextDocumentFilter | NotebookCellTextDocumentFilter;
|
|
64
155
|
/**
|
|
65
156
|
* A document selector is the combination of one or many document filters.
|
|
66
157
|
*
|
|
@@ -92,7 +183,7 @@ export interface Registration {
|
|
|
92
183
|
/**
|
|
93
184
|
* Options necessary for the registration.
|
|
94
185
|
*/
|
|
95
|
-
registerOptions?:
|
|
186
|
+
registerOptions?: LSPAny;
|
|
96
187
|
}
|
|
97
188
|
export interface RegistrationParams {
|
|
98
189
|
registrations: Registration[];
|
|
@@ -227,6 +318,18 @@ export interface WorkspaceClientCapabilities {
|
|
|
227
318
|
* Capabilities specific to the `workspace/executeCommand` request.
|
|
228
319
|
*/
|
|
229
320
|
executeCommand?: ExecuteCommandClientCapabilities;
|
|
321
|
+
/**
|
|
322
|
+
* The client has support for workspace folders
|
|
323
|
+
*
|
|
324
|
+
* @since 3.6.0
|
|
325
|
+
*/
|
|
326
|
+
workspaceFolders?: boolean;
|
|
327
|
+
/**
|
|
328
|
+
* The client supports `workspace/configuration` requests.
|
|
329
|
+
*
|
|
330
|
+
* @since 3.6.0
|
|
331
|
+
*/
|
|
332
|
+
configuration?: boolean;
|
|
230
333
|
/**
|
|
231
334
|
* Capabilities specific to the semantic token requests scoped to the
|
|
232
335
|
* workspace.
|
|
@@ -247,6 +350,30 @@ export interface WorkspaceClientCapabilities {
|
|
|
247
350
|
* Since 3.16.0
|
|
248
351
|
*/
|
|
249
352
|
fileOperations?: FileOperationClientCapabilities;
|
|
353
|
+
/**
|
|
354
|
+
* Capabilities specific to the inline values requests scoped to the
|
|
355
|
+
* workspace.
|
|
356
|
+
*
|
|
357
|
+
* @since 3.17.0.
|
|
358
|
+
* @proposed
|
|
359
|
+
*/
|
|
360
|
+
inlineValue?: InlineValueWorkspaceClientCapabilities;
|
|
361
|
+
/**
|
|
362
|
+
* Capabilities specific to the inlay hints requests scoped to the
|
|
363
|
+
* workspace.
|
|
364
|
+
*
|
|
365
|
+
* @since 3.17.0.
|
|
366
|
+
* @proposed
|
|
367
|
+
*/
|
|
368
|
+
inlayHint?: InlayHintWorkspaceClientCapabilities;
|
|
369
|
+
/**
|
|
370
|
+
* Capabilities specific to the diagnostic requests scoped to the
|
|
371
|
+
* workspace.
|
|
372
|
+
*
|
|
373
|
+
* @since 3.17.0.
|
|
374
|
+
* @proposed
|
|
375
|
+
*/
|
|
376
|
+
diagnostics?: DiagnosticWorkspaceClientCapabilities;
|
|
250
377
|
}
|
|
251
378
|
/**
|
|
252
379
|
* Text document specific client capabilities.
|
|
@@ -374,12 +501,44 @@ export interface TextDocumentClientCapabilities {
|
|
|
374
501
|
* @since 3.16.0
|
|
375
502
|
*/
|
|
376
503
|
moniker?: MonikerClientCapabilities;
|
|
504
|
+
/**
|
|
505
|
+
* Capabilities specific to the various type hierarchy requests.
|
|
506
|
+
*
|
|
507
|
+
* @since 3.17.0
|
|
508
|
+
* @proposed
|
|
509
|
+
*/
|
|
510
|
+
typeHierarchy?: TypeHierarchyClientCapabilities;
|
|
511
|
+
/**
|
|
512
|
+
* Capabilities specific to the `textDocument/inlineValue` request.
|
|
513
|
+
*
|
|
514
|
+
* @since 3.17.0
|
|
515
|
+
* @proposed
|
|
516
|
+
*/
|
|
517
|
+
inlineValue?: InlineValueClientCapabilities;
|
|
518
|
+
/**
|
|
519
|
+
* Capabilities specific to the `textDocument/inlayHint` request.
|
|
520
|
+
*
|
|
521
|
+
* @since 3.17.0
|
|
522
|
+
* @proposed
|
|
523
|
+
*/
|
|
524
|
+
inlayHint?: InlayHintClientCapabilities;
|
|
525
|
+
/**
|
|
526
|
+
* Capabilities specific to the diagnostic pull model.
|
|
527
|
+
*
|
|
528
|
+
* @since 3.17.0
|
|
529
|
+
* @proposed
|
|
530
|
+
*/
|
|
531
|
+
diagnostic?: DiagnosticClientCapabilities;
|
|
377
532
|
}
|
|
378
533
|
export interface WindowClientCapabilities {
|
|
379
534
|
/**
|
|
380
|
-
*
|
|
381
|
-
*
|
|
382
|
-
*
|
|
535
|
+
* It indicates whether the client supports server initiated
|
|
536
|
+
* progress using the `window/workDoneProgress/create` request.
|
|
537
|
+
*
|
|
538
|
+
* The capability also controls Whether client supports handling
|
|
539
|
+
* of progress notifications. If set servers are allowed to report a
|
|
540
|
+
* `workDoneProgress` property in the request specific server
|
|
541
|
+
* capabilities.
|
|
383
542
|
*
|
|
384
543
|
* @since 3.15.0
|
|
385
544
|
*/
|
|
@@ -426,7 +585,49 @@ export interface MarkdownClientCapabilities {
|
|
|
426
585
|
* The version of the parser.
|
|
427
586
|
*/
|
|
428
587
|
version?: string;
|
|
588
|
+
/**
|
|
589
|
+
* A list of HTML tags that the client allows / supports in
|
|
590
|
+
* Markdown.
|
|
591
|
+
*
|
|
592
|
+
* @since 3.17.0
|
|
593
|
+
*/
|
|
594
|
+
allowedTags?: string[];
|
|
595
|
+
}
|
|
596
|
+
/**
|
|
597
|
+
* A set of predefined position encoding kinds.
|
|
598
|
+
*
|
|
599
|
+
* @since 3.17.0
|
|
600
|
+
* @proposed
|
|
601
|
+
*/
|
|
602
|
+
export declare namespace PositionEncodingKind {
|
|
603
|
+
/**
|
|
604
|
+
* Character offsets count UTF-8 code units.
|
|
605
|
+
*/
|
|
606
|
+
const UTF8: PositionEncodingKind;
|
|
607
|
+
/**
|
|
608
|
+
* Character offsets count UTF-16 code units.
|
|
609
|
+
*
|
|
610
|
+
* This is the default and must always be supported
|
|
611
|
+
* by servers
|
|
612
|
+
*/
|
|
613
|
+
const UTF16: PositionEncodingKind;
|
|
614
|
+
/**
|
|
615
|
+
* Character offsets count UTF-32 code units.
|
|
616
|
+
*
|
|
617
|
+
* Implementation note: these are the same as Unicode code points,
|
|
618
|
+
* so this `PositionEncodingKind` may also be used for an
|
|
619
|
+
* encoding-agnostic representation of character offsets.
|
|
620
|
+
*/
|
|
621
|
+
const UTF32: PositionEncodingKind;
|
|
429
622
|
}
|
|
623
|
+
/**
|
|
624
|
+
* A type indicating how positions are encoded,
|
|
625
|
+
* specifically what column offsets mean.
|
|
626
|
+
*
|
|
627
|
+
* @since 3.17.0
|
|
628
|
+
* @proposed
|
|
629
|
+
*/
|
|
630
|
+
export declare type PositionEncodingKind = string;
|
|
430
631
|
/**
|
|
431
632
|
* General client capabilities.
|
|
432
633
|
*
|
|
@@ -440,6 +641,7 @@ export interface GeneralClientCapabilities {
|
|
|
440
641
|
* anymore since the information is outdated).
|
|
441
642
|
*
|
|
442
643
|
* @since 3.17.0
|
|
644
|
+
* @proposed
|
|
443
645
|
*/
|
|
444
646
|
staleRequestSupport?: {
|
|
445
647
|
/**
|
|
@@ -449,7 +651,7 @@ export interface GeneralClientCapabilities {
|
|
|
449
651
|
/**
|
|
450
652
|
* The list of requests for which the client
|
|
451
653
|
* will retry the request if it receives a
|
|
452
|
-
* response with error code `ContentModified
|
|
654
|
+
* response with error code `ContentModified`
|
|
453
655
|
*/
|
|
454
656
|
retryOnContentModified: string[];
|
|
455
657
|
};
|
|
@@ -465,11 +667,48 @@ export interface GeneralClientCapabilities {
|
|
|
465
667
|
* @since 3.16.0
|
|
466
668
|
*/
|
|
467
669
|
markdown?: MarkdownClientCapabilities;
|
|
670
|
+
/**
|
|
671
|
+
* The position encodings supported by the client. Client and server
|
|
672
|
+
* have to agree on the same position encoding to ensure that offsets
|
|
673
|
+
* (e.g. character position in a line) are interpreted the same on both
|
|
674
|
+
* side.
|
|
675
|
+
*
|
|
676
|
+
* To keep the protocol backwards compatible the following applies: if
|
|
677
|
+
* the value 'utf-16' is missing from the array of position encodings
|
|
678
|
+
* servers can assume that the client supports UTF-16. UTF-16 is
|
|
679
|
+
* therefore a mandatory encoding.
|
|
680
|
+
*
|
|
681
|
+
* If omitted it defaults to ['utf-16'].
|
|
682
|
+
*
|
|
683
|
+
* Implementation considerations: since the conversion from one encoding
|
|
684
|
+
* into another requires the content of the file / line the conversion
|
|
685
|
+
* is best done where the file is read which is usually on the server
|
|
686
|
+
* side.
|
|
687
|
+
*
|
|
688
|
+
* @since 3.17.0
|
|
689
|
+
* @proposed
|
|
690
|
+
*/
|
|
691
|
+
positionEncodings?: PositionEncodingKind[];
|
|
692
|
+
}
|
|
693
|
+
/**
|
|
694
|
+
* Capabilities specific to the notebook document support.
|
|
695
|
+
*
|
|
696
|
+
* @since 3.17.0
|
|
697
|
+
* @proposed
|
|
698
|
+
*/
|
|
699
|
+
export interface NotebookDocumentClientCapabilities {
|
|
700
|
+
/**
|
|
701
|
+
* Capabilities specific to notebook document synchronization
|
|
702
|
+
*
|
|
703
|
+
* @since 3.17.0
|
|
704
|
+
* @proposed
|
|
705
|
+
*/
|
|
706
|
+
synchronization: NotebookDocumentSyncClientCapabilities;
|
|
468
707
|
}
|
|
469
708
|
/**
|
|
470
709
|
* Defines the capabilities provided by the client.
|
|
471
710
|
*/
|
|
472
|
-
export interface
|
|
711
|
+
export interface ClientCapabilities {
|
|
473
712
|
/**
|
|
474
713
|
* Workspace specific client capabilities.
|
|
475
714
|
*/
|
|
@@ -478,6 +717,13 @@ export interface _ClientCapabilities {
|
|
|
478
717
|
* Text document specific client capabilities.
|
|
479
718
|
*/
|
|
480
719
|
textDocument?: TextDocumentClientCapabilities;
|
|
720
|
+
/**
|
|
721
|
+
* Capabilities specific to the notebook document support.
|
|
722
|
+
*
|
|
723
|
+
* @since 3.17.0
|
|
724
|
+
* @proposed
|
|
725
|
+
*/
|
|
726
|
+
notebookDocument?: NotebookDocumentClientCapabilities;
|
|
481
727
|
/**
|
|
482
728
|
* Window specific client capabilities.
|
|
483
729
|
*/
|
|
@@ -493,7 +739,6 @@ export interface _ClientCapabilities {
|
|
|
493
739
|
*/
|
|
494
740
|
experimental?: object;
|
|
495
741
|
}
|
|
496
|
-
export declare type ClientCapabilities = _ClientCapabilities & WorkspaceFoldersClientCapabilities & ConfigurationClientCapabilities & WorkDoneProgressClientCapabilities;
|
|
497
742
|
/**
|
|
498
743
|
* Static registration options to be returned in the initialize
|
|
499
744
|
* request.
|
|
@@ -557,12 +802,35 @@ export declare namespace WorkDoneProgressOptions {
|
|
|
557
802
|
* Defines the capabilities provided by a language
|
|
558
803
|
* server.
|
|
559
804
|
*/
|
|
560
|
-
export interface
|
|
805
|
+
export interface ServerCapabilities<T = any> {
|
|
806
|
+
/**
|
|
807
|
+
* The position encoding the server picked from the encodings offered
|
|
808
|
+
* by the client via the client capability `general.positionEncodings`.
|
|
809
|
+
*
|
|
810
|
+
* If the client didn't provide any position encodings the only valid
|
|
811
|
+
* value that a server can return is 'utf-16'.
|
|
812
|
+
*
|
|
813
|
+
* If omitted it defaults to 'utf-16'.
|
|
814
|
+
*
|
|
815
|
+
* If for some reason
|
|
816
|
+
*
|
|
817
|
+
* @since 3.17.0
|
|
818
|
+
* @proposed
|
|
819
|
+
*/
|
|
820
|
+
positionEncoding?: PositionEncodingKind;
|
|
561
821
|
/**
|
|
562
|
-
* Defines how text documents are synced. Is either a detailed structure
|
|
563
|
-
* for backwards compatibility the
|
|
822
|
+
* Defines how text documents are synced. Is either a detailed structure
|
|
823
|
+
* defining each notification or for backwards compatibility the
|
|
824
|
+
* TextDocumentSyncKind number.
|
|
564
825
|
*/
|
|
565
826
|
textDocumentSync?: TextDocumentSyncOptions | TextDocumentSyncKind;
|
|
827
|
+
/**
|
|
828
|
+
* Defines how notebook documents are synced.
|
|
829
|
+
*
|
|
830
|
+
* @since 3.17.0
|
|
831
|
+
* @proposed
|
|
832
|
+
*/
|
|
833
|
+
notebookDocumentSync?: NotebookDocumentSyncOptions | NotebookDocumentSyncRegistrationOptions;
|
|
566
834
|
/**
|
|
567
835
|
* The server provides completion support.
|
|
568
836
|
*/
|
|
@@ -674,9 +942,49 @@ export interface _ServerCapabilities<T = any> {
|
|
|
674
942
|
*/
|
|
675
943
|
semanticTokensProvider?: SemanticTokensOptions | SemanticTokensRegistrationOptions;
|
|
676
944
|
/**
|
|
677
|
-
*
|
|
945
|
+
* The server provides moniker support.
|
|
946
|
+
*
|
|
947
|
+
* @since 3.16.0
|
|
948
|
+
*/
|
|
949
|
+
monikerProvider?: boolean | MonikerOptions | MonikerRegistrationOptions;
|
|
950
|
+
/**
|
|
951
|
+
* The server provides type hierarchy support.
|
|
952
|
+
*
|
|
953
|
+
* @since 3.17.0
|
|
954
|
+
* @proposed
|
|
955
|
+
*/
|
|
956
|
+
typeHierarchyProvider?: boolean | TypeHierarchyOptions | TypeHierarchyRegistrationOptions;
|
|
957
|
+
/**
|
|
958
|
+
* The server provides inline values.
|
|
959
|
+
*
|
|
960
|
+
* @since 3.17.0
|
|
961
|
+
* @proposed
|
|
962
|
+
*/
|
|
963
|
+
inlineValueProvider?: boolean | InlineValueOptions | InlineValueRegistrationOptions;
|
|
964
|
+
/**
|
|
965
|
+
* The server provides inlay hints.
|
|
966
|
+
*
|
|
967
|
+
* @since 3.17.0
|
|
968
|
+
* @proposed
|
|
969
|
+
*/
|
|
970
|
+
inlayHintProvider?: boolean | InlayHintOptions | InlayHintRegistrationOptions;
|
|
971
|
+
/**
|
|
972
|
+
* The server has support for pull model diagnostics.
|
|
973
|
+
*
|
|
974
|
+
* @since 3.17.0
|
|
975
|
+
* @proposed
|
|
976
|
+
*/
|
|
977
|
+
diagnosticProvider?: DiagnosticOptions | DiagnosticRegistrationOptions;
|
|
978
|
+
/**
|
|
979
|
+
* Workspace specific server capabilities.
|
|
678
980
|
*/
|
|
679
981
|
workspace?: {
|
|
982
|
+
/**
|
|
983
|
+
* The server supports workspace folder.
|
|
984
|
+
*
|
|
985
|
+
* @since 3.6.0
|
|
986
|
+
*/
|
|
987
|
+
workspaceFolders?: WorkspaceFoldersServerCapabilities;
|
|
680
988
|
/**
|
|
681
989
|
* The server is interested in notifications/requests for operations on files.
|
|
682
990
|
*
|
|
@@ -684,18 +992,11 @@ export interface _ServerCapabilities<T = any> {
|
|
|
684
992
|
*/
|
|
685
993
|
fileOperations?: FileOperationOptions;
|
|
686
994
|
};
|
|
687
|
-
/**
|
|
688
|
-
* The server provides moniker support.
|
|
689
|
-
*
|
|
690
|
-
* @since 3.16.0
|
|
691
|
-
*/
|
|
692
|
-
monikerProvider?: boolean | MonikerOptions | MonikerRegistrationOptions;
|
|
693
995
|
/**
|
|
694
996
|
* Experimental server capabilities.
|
|
695
997
|
*/
|
|
696
998
|
experimental?: T;
|
|
697
999
|
}
|
|
698
|
-
export declare type ServerCapabilities<T = any> = _ServerCapabilities<T> & WorkspaceFoldersServerCapabilities;
|
|
699
1000
|
/**
|
|
700
1001
|
* The initialize request is sent from the client to the server.
|
|
701
1002
|
* It is sent once as the request after starting up the server.
|
|
@@ -704,7 +1005,7 @@ export declare type ServerCapabilities<T = any> = _ServerCapabilities<T> & Works
|
|
|
704
1005
|
* resolves to such.
|
|
705
1006
|
*/
|
|
706
1007
|
export declare namespace InitializeRequest {
|
|
707
|
-
const type: ProtocolRequestType<
|
|
1008
|
+
const type: ProtocolRequestType<InitializeParams, InitializeResult<any>, never, InitializeError, void>;
|
|
708
1009
|
}
|
|
709
1010
|
/**
|
|
710
1011
|
* The initialize parameters
|
|
@@ -763,11 +1064,11 @@ export interface _InitializeParams extends WorkDoneProgressParams {
|
|
|
763
1064
|
/**
|
|
764
1065
|
* User provided initialization options.
|
|
765
1066
|
*/
|
|
766
|
-
initializationOptions?:
|
|
1067
|
+
initializationOptions?: LSPAny;
|
|
767
1068
|
/**
|
|
768
1069
|
* The initial trace setting. If omitted trace is disabled ('off').
|
|
769
1070
|
*/
|
|
770
|
-
trace?: 'off' | 'messages' | 'verbose';
|
|
1071
|
+
trace?: 'off' | 'messages' | 'compact' | 'verbose';
|
|
771
1072
|
}
|
|
772
1073
|
export declare type InitializeParams = _InitializeParams & WorkspaceFoldersInitializeParams;
|
|
773
1074
|
/**
|
|
@@ -796,19 +1097,21 @@ export interface InitializeResult<T = any> {
|
|
|
796
1097
|
/**
|
|
797
1098
|
* Custom initialization results.
|
|
798
1099
|
*/
|
|
799
|
-
[custom: string]:
|
|
1100
|
+
[custom: string]: LSPAny | ServerCapabilities<T> | undefined; /** undefined is needed since serverInfo is optional */
|
|
800
1101
|
}
|
|
801
1102
|
/**
|
|
802
|
-
* Known error codes for an `
|
|
1103
|
+
* Known error codes for an `InitializeErrorCodes`;
|
|
803
1104
|
*/
|
|
804
|
-
export declare namespace
|
|
1105
|
+
export declare namespace InitializeErrorCodes {
|
|
805
1106
|
/**
|
|
806
1107
|
* If the protocol version provided by the client can't be handled by the server.
|
|
1108
|
+
*
|
|
807
1109
|
* @deprecated This initialize error got replaced by client capabilities. There is
|
|
808
1110
|
* no version handshake in version 3.0x
|
|
809
1111
|
*/
|
|
810
1112
|
const unknownProtocolVersion: 1;
|
|
811
1113
|
}
|
|
1114
|
+
export declare type InitializeErrorCodes = 1;
|
|
812
1115
|
/**
|
|
813
1116
|
* The data type of the ResponseError if the
|
|
814
1117
|
* initialize request fails.
|
|
@@ -872,7 +1175,7 @@ export interface DidChangeConfigurationParams {
|
|
|
872
1175
|
/**
|
|
873
1176
|
* The actual changed settings
|
|
874
1177
|
*/
|
|
875
|
-
settings:
|
|
1178
|
+
settings: LSPAny;
|
|
876
1179
|
}
|
|
877
1180
|
/**
|
|
878
1181
|
* The message type
|
|
@@ -990,7 +1293,7 @@ export interface LogMessageParams {
|
|
|
990
1293
|
* the client to log telemetry data.
|
|
991
1294
|
*/
|
|
992
1295
|
export declare namespace TelemetryEventNotification {
|
|
993
|
-
const type: ProtocolNotificationType<
|
|
1296
|
+
const type: ProtocolNotificationType<LSPAny, void>;
|
|
994
1297
|
}
|
|
995
1298
|
export interface TextDocumentSyncClientCapabilities {
|
|
996
1299
|
/**
|
|
@@ -1085,8 +1388,8 @@ export declare namespace DidOpenTextDocumentNotification {
|
|
|
1085
1388
|
const type: ProtocolNotificationType<DidOpenTextDocumentParams, TextDocumentRegistrationOptions>;
|
|
1086
1389
|
}
|
|
1087
1390
|
/**
|
|
1088
|
-
* An event describing a change to a text document. If
|
|
1089
|
-
*
|
|
1391
|
+
* An event describing a change to a text document. If only a text is provided
|
|
1392
|
+
* it is considered to be the full content of the document.
|
|
1090
1393
|
*/
|
|
1091
1394
|
export declare type TextDocumentContentChangeEvent = {
|
|
1092
1395
|
/**
|
|
@@ -1275,6 +1578,13 @@ export interface DidChangeWatchedFilesClientCapabilities {
|
|
|
1275
1578
|
* from the server side.
|
|
1276
1579
|
*/
|
|
1277
1580
|
dynamicRegistration?: boolean;
|
|
1581
|
+
/**
|
|
1582
|
+
* Whether the client has support for {@link RelativePattern relative pattern}
|
|
1583
|
+
* or not.
|
|
1584
|
+
*
|
|
1585
|
+
* @since 3.17.0
|
|
1586
|
+
*/
|
|
1587
|
+
relativePatternSupport?: boolean;
|
|
1278
1588
|
}
|
|
1279
1589
|
/**
|
|
1280
1590
|
* The watched files notification is sent from the client to the server when
|
|
@@ -1332,17 +1642,52 @@ export interface DidChangeWatchedFilesRegistrationOptions {
|
|
|
1332
1642
|
*/
|
|
1333
1643
|
watchers: FileSystemWatcher[];
|
|
1334
1644
|
}
|
|
1645
|
+
/**
|
|
1646
|
+
* The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
|
|
1647
|
+
* - `*` to match one or more characters in a path segment
|
|
1648
|
+
* - `?` to match on one character in a path segment
|
|
1649
|
+
* - `**` to match any number of path segments, including none
|
|
1650
|
+
* - `{}` to group conditions (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
|
|
1651
|
+
* - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
|
|
1652
|
+
* - `[!...]` 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`)
|
|
1653
|
+
*
|
|
1654
|
+
* @since 3.17.0
|
|
1655
|
+
*/
|
|
1656
|
+
export declare type Pattern = string;
|
|
1657
|
+
/**
|
|
1658
|
+
* A relative pattern is a helper to construct glob patterns that are matched
|
|
1659
|
+
* relatively to a base URI. The common value for a `baseUri` is a workspace
|
|
1660
|
+
* folder root, but it can be another absolute URI as well.
|
|
1661
|
+
*
|
|
1662
|
+
* @since 3.17.0
|
|
1663
|
+
*/
|
|
1664
|
+
export interface RelativePattern {
|
|
1665
|
+
/**
|
|
1666
|
+
* A workspace folder or a base URI to which this pattern will be matched
|
|
1667
|
+
* against relatively.
|
|
1668
|
+
*/
|
|
1669
|
+
baseUri: WorkspaceFolder | URI;
|
|
1670
|
+
/**
|
|
1671
|
+
* The actual glob pattern;
|
|
1672
|
+
*/
|
|
1673
|
+
pattern: Pattern;
|
|
1674
|
+
}
|
|
1675
|
+
export declare namespace RelativePattern {
|
|
1676
|
+
function is(value: any): value is RelativePattern;
|
|
1677
|
+
}
|
|
1678
|
+
/**
|
|
1679
|
+
* The glob pattern. Either a string pattern or a relative pattern.
|
|
1680
|
+
*
|
|
1681
|
+
* @since 3.17.0
|
|
1682
|
+
*/
|
|
1683
|
+
export declare type GlobPattern = Pattern | RelativePattern;
|
|
1335
1684
|
export interface FileSystemWatcher {
|
|
1336
1685
|
/**
|
|
1337
|
-
* The
|
|
1338
|
-
*
|
|
1339
|
-
*
|
|
1340
|
-
* - `**` to match any number of path segments, including none
|
|
1341
|
-
* - `{}` to group conditions (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
|
|
1342
|
-
* - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
|
|
1343
|
-
* - `[!...]` 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`)
|
|
1686
|
+
* The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.
|
|
1687
|
+
*
|
|
1688
|
+
* @since 3.17.0 support for relative patterns.
|
|
1344
1689
|
*/
|
|
1345
|
-
globPattern:
|
|
1690
|
+
globPattern: GlobPattern;
|
|
1346
1691
|
/**
|
|
1347
1692
|
* The kind of events of interest. If omitted it defaults
|
|
1348
1693
|
* to WatchKind.Create | WatchKind.Change | WatchKind.Delete
|
|
@@ -1471,9 +1816,6 @@ export interface CompletionClientCapabilities {
|
|
|
1471
1816
|
* Client supports the preselect property on a completion item.
|
|
1472
1817
|
*/
|
|
1473
1818
|
preselectSupport?: boolean;
|
|
1474
|
-
/**
|
|
1475
|
-
* Client supports to kee
|
|
1476
|
-
*/
|
|
1477
1819
|
/**
|
|
1478
1820
|
* Client supports the tag property on a completion item. Clients supporting
|
|
1479
1821
|
* tags have to handle unknown tags gracefully. Clients especially need to
|
|
@@ -1522,7 +1864,8 @@ export interface CompletionClientCapabilities {
|
|
|
1522
1864
|
* The client has support for completion item label
|
|
1523
1865
|
* details (see also `CompletionItemLabelDetails`).
|
|
1524
1866
|
*
|
|
1525
|
-
* @since 3.17.0
|
|
1867
|
+
* @since 3.17.0
|
|
1868
|
+
* @proposed
|
|
1526
1869
|
*/
|
|
1527
1870
|
labelDetailsSupport?: boolean;
|
|
1528
1871
|
};
|
|
@@ -1544,7 +1887,8 @@ export interface CompletionClientCapabilities {
|
|
|
1544
1887
|
* when accepting a completion item that uses multi line
|
|
1545
1888
|
* text in either `insertText` or `textEdit`.
|
|
1546
1889
|
*
|
|
1547
|
-
* @since 3.
|
|
1890
|
+
* @since 3.17.0
|
|
1891
|
+
* @proposed
|
|
1548
1892
|
*/
|
|
1549
1893
|
insertTextMode?: InsertTextMode;
|
|
1550
1894
|
/**
|
|
@@ -1552,6 +1896,27 @@ export interface CompletionClientCapabilities {
|
|
|
1552
1896
|
* `textDocument/completion` request.
|
|
1553
1897
|
*/
|
|
1554
1898
|
contextSupport?: boolean;
|
|
1899
|
+
/**
|
|
1900
|
+
* The client supports the following `CompletionList` specific
|
|
1901
|
+
* capabilities.
|
|
1902
|
+
*
|
|
1903
|
+
* @since 3.17.0
|
|
1904
|
+
* @proposed
|
|
1905
|
+
*/
|
|
1906
|
+
completionList?: {
|
|
1907
|
+
/**
|
|
1908
|
+
* The client supports the the following itemDefaults on
|
|
1909
|
+
* a completion list.
|
|
1910
|
+
*
|
|
1911
|
+
* The value lists the supported property names of the
|
|
1912
|
+
* `CompletionList.itemDefaults` object. If omitted
|
|
1913
|
+
* no properties are supported.
|
|
1914
|
+
*
|
|
1915
|
+
* @since 3.17.0
|
|
1916
|
+
* @proposed
|
|
1917
|
+
*/
|
|
1918
|
+
itemDefaults?: string[];
|
|
1919
|
+
};
|
|
1555
1920
|
}
|
|
1556
1921
|
/**
|
|
1557
1922
|
* How a completion was triggered
|
|
@@ -1632,7 +1997,8 @@ export interface CompletionOptions extends WorkDoneProgressOptions {
|
|
|
1632
1997
|
* The server supports the following `CompletionItem` specific
|
|
1633
1998
|
* capabilities.
|
|
1634
1999
|
*
|
|
1635
|
-
* @since 3.17.0
|
|
2000
|
+
* @since 3.17.0
|
|
2001
|
+
* @proposed
|
|
1636
2002
|
*/
|
|
1637
2003
|
completionItem?: {
|
|
1638
2004
|
/**
|
|
@@ -1640,7 +2006,8 @@ export interface CompletionOptions extends WorkDoneProgressOptions {
|
|
|
1640
2006
|
* details (see also `CompletionItemLabelDetails`) when
|
|
1641
2007
|
* receiving a completion item in a resolve call.
|
|
1642
2008
|
*
|
|
1643
|
-
* @since 3.17.0
|
|
2009
|
+
* @since 3.17.0
|
|
2010
|
+
* @proposed
|
|
1644
2011
|
*/
|
|
1645
2012
|
labelDetailsSupport?: boolean;
|
|
1646
2013
|
};
|
|
@@ -1886,7 +2253,7 @@ export interface DefinitionRegistrationOptions extends TextDocumentRegistrationO
|
|
|
1886
2253
|
*/
|
|
1887
2254
|
export declare namespace DefinitionRequest {
|
|
1888
2255
|
const method: 'textDocument/definition';
|
|
1889
|
-
const type: ProtocolRequestType<DefinitionParams,
|
|
2256
|
+
const type: ProtocolRequestType<DefinitionParams, Definition | LocationLink[] | null, Location[] | LocationLink[], void, DefinitionRegistrationOptions>;
|
|
1890
2257
|
}
|
|
1891
2258
|
/**
|
|
1892
2259
|
* Client Capabilities for a [ReferencesRequest](#ReferencesRequest).
|
|
@@ -2208,6 +2575,21 @@ export interface WorkspaceSymbolClientCapabilities {
|
|
|
2208
2575
|
*/
|
|
2209
2576
|
valueSet: SymbolTag[];
|
|
2210
2577
|
};
|
|
2578
|
+
/**
|
|
2579
|
+
* The client support partial workspace symbols. The client will send the
|
|
2580
|
+
* request `workspaceSymbol/resolve` to the server to resolve additional
|
|
2581
|
+
* properties.
|
|
2582
|
+
*
|
|
2583
|
+
* @since 3.17.0
|
|
2584
|
+
* @proposed
|
|
2585
|
+
*/
|
|
2586
|
+
resolveSupport?: {
|
|
2587
|
+
/**
|
|
2588
|
+
* The properties that a client can resolve lazily. Usually
|
|
2589
|
+
* `location.range`
|
|
2590
|
+
*/
|
|
2591
|
+
properties: string[];
|
|
2592
|
+
};
|
|
2211
2593
|
}
|
|
2212
2594
|
/**
|
|
2213
2595
|
* The parameters of a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
|
|
@@ -2223,6 +2605,14 @@ export interface WorkspaceSymbolParams extends WorkDoneProgressParams, PartialRe
|
|
|
2223
2605
|
* Server capabilities for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
|
|
2224
2606
|
*/
|
|
2225
2607
|
export interface WorkspaceSymbolOptions extends WorkDoneProgressOptions {
|
|
2608
|
+
/**
|
|
2609
|
+
* The server provides support to resolve additional
|
|
2610
|
+
* information for a workspace symbol.
|
|
2611
|
+
*
|
|
2612
|
+
* @since 3.17.0
|
|
2613
|
+
* @proposed
|
|
2614
|
+
*/
|
|
2615
|
+
resolveProvider?: boolean;
|
|
2226
2616
|
}
|
|
2227
2617
|
/**
|
|
2228
2618
|
* Registration options for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
|
|
@@ -2234,10 +2624,26 @@ export interface WorkspaceSymbolRegistrationOptions extends WorkspaceSymbolOptio
|
|
|
2234
2624
|
* by the [WorkspaceSymbolParams](#WorkspaceSymbolParams). The response is
|
|
2235
2625
|
* of type [SymbolInformation[]](#SymbolInformation) or a Thenable that
|
|
2236
2626
|
* resolves to such.
|
|
2627
|
+
*
|
|
2628
|
+
* @since 3.17.0 - support for WorkspaceSymbol in the returned data. Clients
|
|
2629
|
+
* need to advertise support for WorkspaceSymbols via the client capability
|
|
2630
|
+
* `workspace.symbol.resolveSupport`.
|
|
2631
|
+
*
|
|
2237
2632
|
*/
|
|
2238
2633
|
export declare namespace WorkspaceSymbolRequest {
|
|
2239
2634
|
const method: 'workspace/symbol';
|
|
2240
|
-
const type: ProtocolRequestType<WorkspaceSymbolParams, SymbolInformation[] | null, SymbolInformation[], void, WorkspaceSymbolRegistrationOptions>;
|
|
2635
|
+
const type: ProtocolRequestType<WorkspaceSymbolParams, SymbolInformation[] | WorkspaceSymbol[] | null, SymbolInformation[] | WorkspaceSymbol[], void, WorkspaceSymbolRegistrationOptions>;
|
|
2636
|
+
}
|
|
2637
|
+
/**
|
|
2638
|
+
* A request to resolve the range inside the workspace
|
|
2639
|
+
* symbol's location.
|
|
2640
|
+
*
|
|
2641
|
+
* @since 3.17.0
|
|
2642
|
+
* @proposed
|
|
2643
|
+
*/
|
|
2644
|
+
export declare namespace WorkspaceSymbolResolveRequest {
|
|
2645
|
+
const method: 'workspaceSymbol/resolve';
|
|
2646
|
+
const type: ProtocolRequestType<WorkspaceSymbol, WorkspaceSymbol, never, void, void>;
|
|
2241
2647
|
}
|
|
2242
2648
|
/**
|
|
2243
2649
|
* The client capabilities of a [CodeLensRequest](#CodeLensRequest).
|
|
@@ -2463,11 +2869,16 @@ export interface DocumentOnTypeFormattingParams {
|
|
|
2463
2869
|
*/
|
|
2464
2870
|
textDocument: TextDocumentIdentifier;
|
|
2465
2871
|
/**
|
|
2466
|
-
* The position
|
|
2872
|
+
* The position around which the on type formatting should happen.
|
|
2873
|
+
* This is not necessarily the exact position where the character denoted
|
|
2874
|
+
* by the property `ch` got typed.
|
|
2467
2875
|
*/
|
|
2468
2876
|
position: Position;
|
|
2469
2877
|
/**
|
|
2470
|
-
* The character that has been typed
|
|
2878
|
+
* The character that has been typed that triggered the formatting
|
|
2879
|
+
* on type request. That is not necessarily the last character that
|
|
2880
|
+
* got inserted into the document since the client could auto insert
|
|
2881
|
+
* characters as well (e.g. like automatic brace completion).
|
|
2471
2882
|
*/
|
|
2472
2883
|
ch: string;
|
|
2473
2884
|
/**
|
|
@@ -2480,7 +2891,7 @@ export interface DocumentOnTypeFormattingParams {
|
|
|
2480
2891
|
*/
|
|
2481
2892
|
export interface DocumentOnTypeFormattingOptions {
|
|
2482
2893
|
/**
|
|
2483
|
-
* A character on which formatting should be triggered, like `}`.
|
|
2894
|
+
* A character on which formatting should be triggered, like `{}`.
|
|
2484
2895
|
*/
|
|
2485
2896
|
firstTriggerCharacter: string;
|
|
2486
2897
|
/**
|
|
@@ -2584,6 +2995,12 @@ export declare namespace RenameRequest {
|
|
|
2584
2995
|
}
|
|
2585
2996
|
export interface PrepareRenameParams extends TextDocumentPositionParams, WorkDoneProgressParams {
|
|
2586
2997
|
}
|
|
2998
|
+
export declare type PrepareRenameResult = Range | {
|
|
2999
|
+
range: Range;
|
|
3000
|
+
placeholder: string;
|
|
3001
|
+
} | {
|
|
3002
|
+
defaultBehavior: boolean;
|
|
3003
|
+
};
|
|
2587
3004
|
/**
|
|
2588
3005
|
* A request to test and perform the setup necessary for a rename.
|
|
2589
3006
|
*
|
|
@@ -2591,12 +3008,7 @@ export interface PrepareRenameParams extends TextDocumentPositionParams, WorkDon
|
|
|
2591
3008
|
*/
|
|
2592
3009
|
export declare namespace PrepareRenameRequest {
|
|
2593
3010
|
const method: 'textDocument/prepareRename';
|
|
2594
|
-
const type: ProtocolRequestType<PrepareRenameParams,
|
|
2595
|
-
range: Range;
|
|
2596
|
-
placeholder: string;
|
|
2597
|
-
} | {
|
|
2598
|
-
defaultBehavior: boolean;
|
|
2599
|
-
} | null, never, void, void>;
|
|
3011
|
+
const type: ProtocolRequestType<PrepareRenameParams, PrepareRenameResult | null, never, void, void>;
|
|
2600
3012
|
}
|
|
2601
3013
|
/**
|
|
2602
3014
|
* The client capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
|
|
@@ -2618,7 +3030,7 @@ export interface ExecuteCommandParams extends WorkDoneProgressParams {
|
|
|
2618
3030
|
/**
|
|
2619
3031
|
* Arguments that the command should be invoked with.
|
|
2620
3032
|
*/
|
|
2621
|
-
arguments?:
|
|
3033
|
+
arguments?: LSPAny[];
|
|
2622
3034
|
}
|
|
2623
3035
|
/**
|
|
2624
3036
|
* The server capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
|
|
@@ -2639,7 +3051,7 @@ export interface ExecuteCommandRegistrationOptions extends ExecuteCommandOptions
|
|
|
2639
3051
|
* a workspace edit which the client will apply to the workspace.
|
|
2640
3052
|
*/
|
|
2641
3053
|
export declare namespace ExecuteCommandRequest {
|
|
2642
|
-
const type: ProtocolRequestType<ExecuteCommandParams,
|
|
3054
|
+
const type: ProtocolRequestType<ExecuteCommandParams, LSPAny, never, void, ExecuteCommandRegistrationOptions>;
|
|
2643
3055
|
}
|
|
2644
3056
|
export interface WorkspaceEditClientCapabilities {
|
|
2645
3057
|
/**
|
|
@@ -2701,9 +3113,11 @@ export interface ApplyWorkspaceEditParams {
|
|
|
2701
3113
|
edit: WorkspaceEdit;
|
|
2702
3114
|
}
|
|
2703
3115
|
/**
|
|
2704
|
-
*
|
|
3116
|
+
* The result returned from the apply workspace edit request.
|
|
3117
|
+
*
|
|
3118
|
+
* @since 3.17 renamed from ApplyWorkspaceEditResponse
|
|
2705
3119
|
*/
|
|
2706
|
-
export interface
|
|
3120
|
+
export interface ApplyWorkspaceEditResult {
|
|
2707
3121
|
/**
|
|
2708
3122
|
* Indicates whether the edit was applied or not.
|
|
2709
3123
|
*/
|
|
@@ -2721,11 +3135,15 @@ export interface ApplyWorkspaceEditResponse {
|
|
|
2721
3135
|
*/
|
|
2722
3136
|
failedChange?: uinteger;
|
|
2723
3137
|
}
|
|
3138
|
+
/**
|
|
3139
|
+
* @deprecated Use ApplyWorkspaceEditResult instead.
|
|
3140
|
+
*/
|
|
3141
|
+
export declare type ApplyWorkspaceEditResponse = ApplyWorkspaceEditResult;
|
|
2724
3142
|
/**
|
|
2725
3143
|
* A request sent from the server to the client to modified certain resources.
|
|
2726
3144
|
*/
|
|
2727
3145
|
export declare namespace ApplyWorkspaceEditRequest {
|
|
2728
|
-
const type: ProtocolRequestType<ApplyWorkspaceEditParams,
|
|
3146
|
+
const type: ProtocolRequestType<ApplyWorkspaceEditParams, ApplyWorkspaceEditResult, never, void, void>;
|
|
2729
3147
|
}
|
|
2730
|
-
export { ImplementationRequest, ImplementationParams, ImplementationRegistrationOptions, ImplementationOptions, TypeDefinitionRequest, TypeDefinitionParams, TypeDefinitionRegistrationOptions, TypeDefinitionOptions, WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams,
|
|
3148
|
+
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, DiagnosticClientCapabilities, DiagnosticOptions, DiagnosticRegistrationOptions, DiagnosticServerCancellationData, DocumentDiagnosticParams, DocumentDiagnosticReportKind, FullDocumentDiagnosticReport, RelatedFullDocumentDiagnosticReport, UnchangedDocumentDiagnosticReport, RelatedUnchangedDocumentDiagnosticReport, DocumentDiagnosticReport, DocumentDiagnosticReportPartialResult, DocumentDiagnosticRequest, PreviousResultId, WorkspaceDiagnosticParams, WorkspaceFullDocumentDiagnosticReport, WorkspaceUnchangedDocumentDiagnosticReport, WorkspaceDocumentDiagnosticReport, WorkspaceDiagnosticReport, WorkspaceDiagnosticReportPartialResult, WorkspaceDiagnosticRequest, DiagnosticRefreshRequest, NotebookDocumentSyncClientCapabilities, NotebookCellKind, ExecutionSummary, NotebookCell, NotebookDocument, NotebookDocumentIdentifier, VersionedNotebookDocumentIdentifier, NotebookDocumentSyncOptions, NotebookDocumentSyncRegistrationOptions, NotebookDocumentSyncRegistrationType, DidOpenNotebookDocumentParams, DidOpenNotebookDocumentNotification, NotebookCellArrayChange, NotebookDocumentChangeEvent, DidChangeNotebookDocumentParams, DidChangeNotebookDocumentNotification, DidSaveNotebookDocumentParams, DidSaveNotebookDocumentNotification, DidCloseNotebookDocumentParams, DidCloseNotebookDocumentNotification };
|
|
2731
3149
|
export { DocumentColorOptions as ColorProviderOptions, DocumentColorOptions as ColorOptions, FoldingRangeOptions as FoldingRangeProviderOptions, SelectionRangeOptions as SelectionRangeProviderOptions, DocumentColorRegistrationOptions as ColorRegistrationOptions };
|