vscode-languageserver-protocol 3.16.0-next.8 → 3.17.0-next.10
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 +80 -17
- package/lib/common/api.js +44 -8
- package/lib/common/connection.d.ts +36 -23
- package/lib/common/connection.js +1 -1
- package/lib/common/messages.d.ts +35 -6
- package/lib/common/messages.js +13 -7
- package/lib/common/proposed.diagnostic.d.ts +324 -0
- package/lib/common/proposed.diagnostic.js +72 -0
- package/lib/common/proposed.inlineValue.d.ts +86 -0
- package/lib/common/proposed.inlineValue.js +29 -0
- package/lib/common/proposed.typeHierarchy.d.ts +83 -0
- package/lib/common/proposed.typeHierarchy.js +40 -0
- package/lib/common/protocol.callHierarchy.js +1 -1
- package/lib/common/protocol.colorProvider.d.ts +1 -3
- package/lib/common/protocol.colorProvider.js +0 -3
- package/lib/common/protocol.configuration.d.ts +4 -3
- package/lib/common/protocol.d.ts +470 -77
- package/lib/common/protocol.declaration.d.ts +2 -4
- package/lib/common/protocol.declaration.js +0 -3
- package/lib/common/protocol.fileOperations.d.ts +293 -0
- package/lib/common/protocol.fileOperations.js +92 -0
- package/lib/common/protocol.foldingRange.d.ts +3 -32
- package/lib/common/protocol.foldingRange.js +0 -3
- package/lib/common/protocol.implementation.d.ts +2 -4
- package/lib/common/protocol.implementation.js +0 -3
- package/lib/common/protocol.js +65 -31
- package/lib/common/protocol.linkedEditingRange.d.ts +51 -0
- package/lib/common/protocol.linkedEditingRange.js +19 -0
- package/lib/common/{protocol.moniker.proposed.d.ts → protocol.moniker.d.ts} +11 -14
- package/lib/common/{protocol.moniker.proposed.js → protocol.moniker.js} +1 -1
- package/lib/common/protocol.progress.d.ts +6 -4
- package/lib/common/protocol.progress.js +4 -0
- package/lib/common/protocol.selectionRange.d.ts +1 -3
- package/lib/common/protocol.selectionRange.js +0 -3
- package/lib/common/protocol.semanticTokens.d.ts +75 -135
- package/lib/common/protocol.semanticTokens.js +10 -69
- package/lib/common/protocol.showDocument.d.ts +71 -0
- package/lib/common/protocol.showDocument.js +22 -0
- package/lib/common/protocol.typeDefinition.d.ts +2 -4
- package/lib/common/protocol.typeDefinition.js +0 -3
- package/lib/common/protocol.workspaceFolders.d.ts +1 -1
- package/lib/node/main.js +1 -1
- package/package.json +6 -5
package/lib/common/protocol.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { ProgressToken
|
|
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 } 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 } 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
6
|
import { WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams, WorkspaceFolder, WorkspaceFoldersChangeEvent, WorkspaceFoldersInitializeParams, WorkspaceFoldersClientCapabilities, WorkspaceFoldersServerCapabilities } from './protocol.workspaceFolders';
|
|
@@ -11,7 +11,13 @@ import { DeclarationClientCapabilities, DeclarationRequest, DeclarationOptions,
|
|
|
11
11
|
import { SelectionRangeClientCapabilities, SelectionRangeOptions, SelectionRangeRequest, SelectionRangeParams, SelectionRangeRegistrationOptions } from './protocol.selectionRange';
|
|
12
12
|
import { WorkDoneProgressClientCapabilities, 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
|
-
import {
|
|
14
|
+
import { SemanticTokensPartialResult, SemanticTokensDeltaPartialResult, TokenFormat, SemanticTokensClientCapabilities, SemanticTokensOptions, SemanticTokensRegistrationOptions, SemanticTokensParams, SemanticTokensRequest, SemanticTokensDeltaParams, SemanticTokensDeltaRequest, SemanticTokensRangeParams, SemanticTokensRangeRequest, SemanticTokensRefreshRequest, SemanticTokensWorkspaceClientCapabilities, SemanticTokensRegistrationType } from './protocol.semanticTokens';
|
|
15
|
+
import { ShowDocumentParams, ShowDocumentResult, ShowDocumentRequest, ShowDocumentClientCapabilities } from './protocol.showDocument';
|
|
16
|
+
import { LinkedEditingRangeClientCapabilities, LinkedEditingRanges, LinkedEditingRangeOptions, LinkedEditingRangeParams, LinkedEditingRangeRegistrationOptions, LinkedEditingRangeRequest } from './protocol.linkedEditingRange';
|
|
17
|
+
import { FileOperationOptions, FileOperationClientCapabilities, FileOperationRegistrationOptions, FileOperationPatternOptions, FileOperationPatternKind, DidCreateFilesNotification, CreateFilesParams, FileCreate, WillCreateFilesRequest, DidRenameFilesNotification, RenameFilesParams, FileRename, WillRenameFilesRequest, DidDeleteFilesNotification, DeleteFilesParams, FileDelete, WillDeleteFilesRequest } from './protocol.fileOperations';
|
|
18
|
+
import { UniquenessLevel, MonikerKind, Moniker, MonikerClientCapabilities, MonikerOptions, MonikerRegistrationOptions, MonikerParams, MonikerRequest } from './protocol.moniker';
|
|
19
|
+
import { TypeHierarchyClientCapabilities, TypeHierarchyOptions, TypeHierarchyRegistrationOptions } from './proposed.typeHierarchy';
|
|
20
|
+
import { InlineValuesClientCapabilities, InlineValuesOptions, InlineValuesRegistrationOptions, InlineValuesWorkspaceClientCapabilities } from './proposed.inlineValue';
|
|
15
21
|
/**
|
|
16
22
|
* A document filter denotes a document by different properties like
|
|
17
23
|
* the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
|
|
@@ -21,7 +27,7 @@ import { SemanticTokenTypes, SemanticTokenModifiers, SemanticTokensLegend, Seman
|
|
|
21
27
|
* - `*` to match one or more characters in a path segment
|
|
22
28
|
* - `?` to match on one character in a path segment
|
|
23
29
|
* - `**` to match any number of path segments, including none
|
|
24
|
-
* - `{}` to group
|
|
30
|
+
* - `{}` to group sub patterns into an OR expression. (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
|
|
25
31
|
* - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
|
|
26
32
|
* - `[!...]` 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`)
|
|
27
33
|
*
|
|
@@ -61,6 +67,8 @@ export declare namespace DocumentFilter {
|
|
|
61
67
|
* A document selector is the combination of one or many document filters.
|
|
62
68
|
*
|
|
63
69
|
* @sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;
|
|
70
|
+
*
|
|
71
|
+
* The use of a string as a document filter is deprecated @since 3.16.0.
|
|
64
72
|
*/
|
|
65
73
|
export declare type DocumentSelector = (string | DocumentFilter)[];
|
|
66
74
|
/**
|
|
@@ -86,7 +94,7 @@ export interface Registration {
|
|
|
86
94
|
/**
|
|
87
95
|
* Options necessary for the registration.
|
|
88
96
|
*/
|
|
89
|
-
registerOptions?:
|
|
97
|
+
registerOptions?: LSPAny;
|
|
90
98
|
}
|
|
91
99
|
export interface RegistrationParams {
|
|
92
100
|
registrations: Registration[];
|
|
@@ -182,7 +190,7 @@ export declare namespace FailureHandlingKind {
|
|
|
182
190
|
/**
|
|
183
191
|
* If the workspace edit contains only textual file changes they are executed transactional.
|
|
184
192
|
* If resource changes (create, rename or delete file) are part of the change the failure
|
|
185
|
-
* handling
|
|
193
|
+
* handling strategy is abort.
|
|
186
194
|
*/
|
|
187
195
|
const TextOnlyTransactional: FailureHandlingKind;
|
|
188
196
|
/**
|
|
@@ -222,12 +230,32 @@ export interface WorkspaceClientCapabilities {
|
|
|
222
230
|
*/
|
|
223
231
|
executeCommand?: ExecuteCommandClientCapabilities;
|
|
224
232
|
/**
|
|
225
|
-
* Capabilities specific to the semantic token
|
|
233
|
+
* Capabilities specific to the semantic token requests scoped to the
|
|
226
234
|
* workspace.
|
|
227
235
|
*
|
|
228
|
-
* @since 3.16.0
|
|
236
|
+
* @since 3.16.0.
|
|
229
237
|
*/
|
|
230
238
|
semanticTokens?: SemanticTokensWorkspaceClientCapabilities;
|
|
239
|
+
/**
|
|
240
|
+
* Capabilities specific to the code lens requests scoped to the
|
|
241
|
+
* workspace.
|
|
242
|
+
*
|
|
243
|
+
* @since 3.16.0.
|
|
244
|
+
*/
|
|
245
|
+
codeLens?: CodeLensWorkspaceClientCapabilities;
|
|
246
|
+
/**
|
|
247
|
+
* The client has support for file notifications/requests for user operations on files.
|
|
248
|
+
*
|
|
249
|
+
* Since 3.16.0
|
|
250
|
+
*/
|
|
251
|
+
fileOperations?: FileOperationClientCapabilities;
|
|
252
|
+
/**
|
|
253
|
+
* Capabilities specific to the inline values requests scoped to the
|
|
254
|
+
* workspace.
|
|
255
|
+
*
|
|
256
|
+
* @since 3.17.0.
|
|
257
|
+
*/
|
|
258
|
+
inlineValues?: InlineValuesWorkspaceClientCapabilities;
|
|
231
259
|
}
|
|
232
260
|
/**
|
|
233
261
|
* Text document specific client capabilities.
|
|
@@ -316,13 +344,13 @@ export interface TextDocumentClientCapabilities {
|
|
|
316
344
|
*/
|
|
317
345
|
rename?: RenameClientCapabilities;
|
|
318
346
|
/**
|
|
319
|
-
* Capabilities specific to `textDocument/foldingRange`
|
|
347
|
+
* Capabilities specific to `textDocument/foldingRange` request.
|
|
320
348
|
*
|
|
321
349
|
* @since 3.10.0
|
|
322
350
|
*/
|
|
323
351
|
foldingRange?: FoldingRangeClientCapabilities;
|
|
324
352
|
/**
|
|
325
|
-
* Capabilities specific to `textDocument/selectionRange`
|
|
353
|
+
* Capabilities specific to `textDocument/selectionRange` request.
|
|
326
354
|
*
|
|
327
355
|
* @since 3.15.0
|
|
328
356
|
*/
|
|
@@ -332,17 +360,139 @@ export interface TextDocumentClientCapabilities {
|
|
|
332
360
|
*/
|
|
333
361
|
publishDiagnostics?: PublishDiagnosticsClientCapabilities;
|
|
334
362
|
/**
|
|
335
|
-
* Capabilities specific to the various call hierarchy
|
|
363
|
+
* Capabilities specific to the various call hierarchy request.
|
|
336
364
|
*
|
|
337
365
|
* @since 3.16.0
|
|
338
366
|
*/
|
|
339
367
|
callHierarchy?: CallHierarchyClientCapabilities;
|
|
340
368
|
/**
|
|
341
|
-
* Capabilities specific to the various semantic token
|
|
369
|
+
* Capabilities specific to the various semantic token request.
|
|
342
370
|
*
|
|
343
|
-
* @since 3.16.0
|
|
371
|
+
* @since 3.16.0
|
|
344
372
|
*/
|
|
345
373
|
semanticTokens?: SemanticTokensClientCapabilities;
|
|
374
|
+
/**
|
|
375
|
+
* Capabilities specific to the linked editing range request.
|
|
376
|
+
*
|
|
377
|
+
* @since 3.16.0
|
|
378
|
+
*/
|
|
379
|
+
linkedEditingRange?: LinkedEditingRangeClientCapabilities;
|
|
380
|
+
/**
|
|
381
|
+
* Client capabilities specific to the moniker request.
|
|
382
|
+
*
|
|
383
|
+
* @since 3.16.0
|
|
384
|
+
*/
|
|
385
|
+
moniker?: MonikerClientCapabilities;
|
|
386
|
+
/**
|
|
387
|
+
* Capabilities specific to the various type hierarchy requests.
|
|
388
|
+
*
|
|
389
|
+
* @since 3.17.0 - proposed state
|
|
390
|
+
*/
|
|
391
|
+
typeHierarchy?: TypeHierarchyClientCapabilities;
|
|
392
|
+
/**
|
|
393
|
+
* Capabilities specific to the `textDocument/inlineValues` request.
|
|
394
|
+
*
|
|
395
|
+
* @since 3.17.0 - proposed state
|
|
396
|
+
*/
|
|
397
|
+
inlineValues?: InlineValuesClientCapabilities;
|
|
398
|
+
}
|
|
399
|
+
export interface WindowClientCapabilities {
|
|
400
|
+
/**
|
|
401
|
+
* Whether client supports handling progress notifications. If set
|
|
402
|
+
* servers are allowed to report in `workDoneProgress` property in the
|
|
403
|
+
* request specific server capabilities.
|
|
404
|
+
*
|
|
405
|
+
* @since 3.15.0
|
|
406
|
+
*/
|
|
407
|
+
workDoneProgress?: boolean;
|
|
408
|
+
/**
|
|
409
|
+
* Capabilities specific to the showMessage request.
|
|
410
|
+
*
|
|
411
|
+
* @since 3.16.0
|
|
412
|
+
*/
|
|
413
|
+
showMessage?: ShowMessageRequestClientCapabilities;
|
|
414
|
+
/**
|
|
415
|
+
* Capabilities specific to the showDocument request.
|
|
416
|
+
*
|
|
417
|
+
* @since 3.16.0
|
|
418
|
+
*/
|
|
419
|
+
showDocument?: ShowDocumentClientCapabilities;
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* Client capabilities specific to regular expressions.
|
|
423
|
+
*
|
|
424
|
+
* @since 3.16.0
|
|
425
|
+
*/
|
|
426
|
+
export interface RegularExpressionsClientCapabilities {
|
|
427
|
+
/**
|
|
428
|
+
* The engine's name.
|
|
429
|
+
*/
|
|
430
|
+
engine: string;
|
|
431
|
+
/**
|
|
432
|
+
* The engine's version.
|
|
433
|
+
*/
|
|
434
|
+
version?: string;
|
|
435
|
+
}
|
|
436
|
+
/**
|
|
437
|
+
* Client capabilities specific to the used markdown parser.
|
|
438
|
+
*
|
|
439
|
+
* @since 3.16.0
|
|
440
|
+
*/
|
|
441
|
+
export interface MarkdownClientCapabilities {
|
|
442
|
+
/**
|
|
443
|
+
* The name of the parser.
|
|
444
|
+
*/
|
|
445
|
+
parser: string;
|
|
446
|
+
/**
|
|
447
|
+
* The version of the parser.
|
|
448
|
+
*/
|
|
449
|
+
version?: string;
|
|
450
|
+
/**
|
|
451
|
+
* A list of HTML tags that the client allows / supports in
|
|
452
|
+
* Markdown.
|
|
453
|
+
*
|
|
454
|
+
* @since 3.17.0
|
|
455
|
+
*/
|
|
456
|
+
allowedTags?: string[];
|
|
457
|
+
}
|
|
458
|
+
/**
|
|
459
|
+
* General client capabilities.
|
|
460
|
+
*
|
|
461
|
+
* @since 3.16.0
|
|
462
|
+
*/
|
|
463
|
+
export interface GeneralClientCapabilities {
|
|
464
|
+
/**
|
|
465
|
+
* Client capability that signals how the client
|
|
466
|
+
* handles stale requests (e.g. a request
|
|
467
|
+
* for which the client will not process the response
|
|
468
|
+
* anymore since the information is outdated).
|
|
469
|
+
*
|
|
470
|
+
* @since 3.17.0
|
|
471
|
+
*/
|
|
472
|
+
staleRequestSupport?: {
|
|
473
|
+
/**
|
|
474
|
+
* The client will actively cancel the request.
|
|
475
|
+
*/
|
|
476
|
+
cancel: boolean;
|
|
477
|
+
/**
|
|
478
|
+
* The list of requests for which the client
|
|
479
|
+
* will retry the request if it receives a
|
|
480
|
+
* response with error code `ContentModified`
|
|
481
|
+
*/
|
|
482
|
+
retryOnContentModified: string[];
|
|
483
|
+
};
|
|
484
|
+
/**
|
|
485
|
+
* Client capabilities specific to regular expressions.
|
|
486
|
+
*
|
|
487
|
+
* @since 3.16.0
|
|
488
|
+
*/
|
|
489
|
+
regularExpressions?: RegularExpressionsClientCapabilities;
|
|
490
|
+
/**
|
|
491
|
+
* Client capabilities specific to the client's markdown parser.
|
|
492
|
+
*
|
|
493
|
+
* @since 3.16.0
|
|
494
|
+
*/
|
|
495
|
+
markdown?: MarkdownClientCapabilities;
|
|
346
496
|
}
|
|
347
497
|
/**
|
|
348
498
|
* Defines the capabilities provided by the client.
|
|
@@ -359,7 +509,13 @@ export interface _ClientCapabilities {
|
|
|
359
509
|
/**
|
|
360
510
|
* Window specific client capabilities.
|
|
361
511
|
*/
|
|
362
|
-
window?:
|
|
512
|
+
window?: WindowClientCapabilities;
|
|
513
|
+
/**
|
|
514
|
+
* General client capabilities.
|
|
515
|
+
*
|
|
516
|
+
* @since 3.16.0
|
|
517
|
+
*/
|
|
518
|
+
general?: GeneralClientCapabilities;
|
|
363
519
|
/**
|
|
364
520
|
* Experimental client capabilities.
|
|
365
521
|
*/
|
|
@@ -528,17 +684,52 @@ export interface _ServerCapabilities<T = any> {
|
|
|
528
684
|
*/
|
|
529
685
|
executeCommandProvider?: ExecuteCommandOptions;
|
|
530
686
|
/**
|
|
531
|
-
* The server provides
|
|
687
|
+
* The server provides call hierarchy support.
|
|
532
688
|
*
|
|
533
|
-
* @since 3.16.0
|
|
689
|
+
* @since 3.16.0
|
|
534
690
|
*/
|
|
535
691
|
callHierarchyProvider?: boolean | CallHierarchyOptions | CallHierarchyRegistrationOptions;
|
|
692
|
+
/**
|
|
693
|
+
* The server provides linked editing range support.
|
|
694
|
+
*
|
|
695
|
+
* @since 3.16.0
|
|
696
|
+
*/
|
|
697
|
+
linkedEditingRangeProvider?: boolean | LinkedEditingRangeOptions | LinkedEditingRangeRegistrationOptions;
|
|
536
698
|
/**
|
|
537
699
|
* The server provides semantic tokens support.
|
|
538
700
|
*
|
|
539
|
-
* @since 3.16.0
|
|
701
|
+
* @since 3.16.0
|
|
540
702
|
*/
|
|
541
703
|
semanticTokensProvider?: SemanticTokensOptions | SemanticTokensRegistrationOptions;
|
|
704
|
+
/**
|
|
705
|
+
* Window specific server capabilities.
|
|
706
|
+
*/
|
|
707
|
+
workspace?: {
|
|
708
|
+
/**
|
|
709
|
+
* The server is interested in notifications/requests for operations on files.
|
|
710
|
+
*
|
|
711
|
+
* @since 3.16.0
|
|
712
|
+
*/
|
|
713
|
+
fileOperations?: FileOperationOptions;
|
|
714
|
+
};
|
|
715
|
+
/**
|
|
716
|
+
* The server provides moniker support.
|
|
717
|
+
*
|
|
718
|
+
* @since 3.16.0
|
|
719
|
+
*/
|
|
720
|
+
monikerProvider?: boolean | MonikerOptions | MonikerRegistrationOptions;
|
|
721
|
+
/**
|
|
722
|
+
* The server provides type hierarchy support.
|
|
723
|
+
*
|
|
724
|
+
* @since 3.17.0 - proposed state
|
|
725
|
+
*/
|
|
726
|
+
typeHierarchyProvider?: boolean | TypeHierarchyOptions | TypeHierarchyRegistrationOptions;
|
|
727
|
+
/**
|
|
728
|
+
* The server provides inline values.
|
|
729
|
+
*
|
|
730
|
+
* @since 3.17.0 - proposed state
|
|
731
|
+
*/
|
|
732
|
+
inlineValuesProvider?: boolean | InlineValuesOptions | InlineValuesOptions | InlineValuesRegistrationOptions;
|
|
542
733
|
/**
|
|
543
734
|
* Experimental server capabilities.
|
|
544
735
|
*/
|
|
@@ -563,7 +754,7 @@ export interface _InitializeParams extends WorkDoneProgressParams {
|
|
|
563
754
|
* The process Id of the parent process that started
|
|
564
755
|
* the server.
|
|
565
756
|
*/
|
|
566
|
-
processId:
|
|
757
|
+
processId: integer | null;
|
|
567
758
|
/**
|
|
568
759
|
* Information about the client
|
|
569
760
|
*
|
|
@@ -579,6 +770,17 @@ export interface _InitializeParams extends WorkDoneProgressParams {
|
|
|
579
770
|
*/
|
|
580
771
|
version?: string;
|
|
581
772
|
};
|
|
773
|
+
/**
|
|
774
|
+
* The locale the client is currently showing the user interface
|
|
775
|
+
* in. This must not necessarily be the locale of the operating
|
|
776
|
+
* system.
|
|
777
|
+
*
|
|
778
|
+
* Uses IETF language tags as the value's syntax
|
|
779
|
+
* (See https://en.wikipedia.org/wiki/IETF_language_tag)
|
|
780
|
+
*
|
|
781
|
+
* @since 3.16.0
|
|
782
|
+
*/
|
|
783
|
+
locale?: string;
|
|
582
784
|
/**
|
|
583
785
|
* The rootPath of the workspace. Is null
|
|
584
786
|
* if no folder is open.
|
|
@@ -601,11 +803,11 @@ export interface _InitializeParams extends WorkDoneProgressParams {
|
|
|
601
803
|
/**
|
|
602
804
|
* User provided initialization options.
|
|
603
805
|
*/
|
|
604
|
-
initializationOptions?:
|
|
806
|
+
initializationOptions?: LSPAny;
|
|
605
807
|
/**
|
|
606
808
|
* The initial trace setting. If omitted trace is disabled ('off').
|
|
607
809
|
*/
|
|
608
|
-
trace?: 'off' | 'messages' | 'verbose';
|
|
810
|
+
trace?: 'off' | 'messages' | 'compact' | 'verbose';
|
|
609
811
|
}
|
|
610
812
|
export declare type InitializeParams = _InitializeParams & WorkspaceFoldersInitializeParams;
|
|
611
813
|
/**
|
|
@@ -627,14 +829,14 @@ export interface InitializeResult<T = any> {
|
|
|
627
829
|
*/
|
|
628
830
|
name: string;
|
|
629
831
|
/**
|
|
630
|
-
* The
|
|
832
|
+
* The server's version as defined by the server.
|
|
631
833
|
*/
|
|
632
834
|
version?: string;
|
|
633
835
|
};
|
|
634
836
|
/**
|
|
635
837
|
* Custom initialization results.
|
|
636
838
|
*/
|
|
637
|
-
[custom: string]:
|
|
839
|
+
[custom: string]: LSPAny | ServerCapabilities<T> | undefined; /** undefined is needed since serverInfo is optional */
|
|
638
840
|
}
|
|
639
841
|
/**
|
|
640
842
|
* Known error codes for an `InitializeError`;
|
|
@@ -645,7 +847,7 @@ export declare namespace InitializeError {
|
|
|
645
847
|
* @deprecated This initialize error got replaced by client capabilities. There is
|
|
646
848
|
* no version handshake in version 3.0x
|
|
647
849
|
*/
|
|
648
|
-
const unknownProtocolVersion:
|
|
850
|
+
const unknownProtocolVersion: 1;
|
|
649
851
|
}
|
|
650
852
|
/**
|
|
651
853
|
* The data type of the ResponseError if the
|
|
@@ -663,7 +865,7 @@ export interface InitializeError {
|
|
|
663
865
|
export interface InitializedParams {
|
|
664
866
|
}
|
|
665
867
|
/**
|
|
666
|
-
* The
|
|
868
|
+
* The initialized notification is sent from the client to the
|
|
667
869
|
* server after the client is fully initialized and the server
|
|
668
870
|
* is allowed to send requests from the server to the client.
|
|
669
871
|
*/
|
|
@@ -710,7 +912,7 @@ export interface DidChangeConfigurationParams {
|
|
|
710
912
|
/**
|
|
711
913
|
* The actual changed settings
|
|
712
914
|
*/
|
|
713
|
-
settings:
|
|
915
|
+
settings: LSPAny;
|
|
714
916
|
}
|
|
715
917
|
/**
|
|
716
918
|
* The message type
|
|
@@ -754,11 +956,33 @@ export interface ShowMessageParams {
|
|
|
754
956
|
export declare namespace ShowMessageNotification {
|
|
755
957
|
const type: ProtocolNotificationType<ShowMessageParams, void>;
|
|
756
958
|
}
|
|
959
|
+
/**
|
|
960
|
+
* Show message request client capabilities
|
|
961
|
+
*/
|
|
962
|
+
export interface ShowMessageRequestClientCapabilities {
|
|
963
|
+
/**
|
|
964
|
+
* Capabilities specific to the `MessageActionItem` type.
|
|
965
|
+
*/
|
|
966
|
+
messageActionItem?: {
|
|
967
|
+
/**
|
|
968
|
+
* Whether the client supports additional attributes which
|
|
969
|
+
* are preserved and send back to the server in the
|
|
970
|
+
* request's response.
|
|
971
|
+
*/
|
|
972
|
+
additionalPropertiesSupport?: boolean;
|
|
973
|
+
};
|
|
974
|
+
}
|
|
757
975
|
export interface MessageActionItem {
|
|
758
976
|
/**
|
|
759
977
|
* A short title like 'Retry', 'Open Log' etc.
|
|
760
978
|
*/
|
|
761
979
|
title: string;
|
|
980
|
+
/**
|
|
981
|
+
* Additional attributes that the client preserves and
|
|
982
|
+
* sends back to the server. This depends on the client
|
|
983
|
+
* capability window.messageActionItem.additionalPropertiesSupport
|
|
984
|
+
*/
|
|
985
|
+
[key: string]: string | boolean | integer | object;
|
|
762
986
|
}
|
|
763
987
|
export interface ShowMessageRequestParams {
|
|
764
988
|
/**
|
|
@@ -914,7 +1138,7 @@ export declare type TextDocumentContentChangeEvent = {
|
|
|
914
1138
|
*
|
|
915
1139
|
* @deprecated use range instead.
|
|
916
1140
|
*/
|
|
917
|
-
rangeLength?:
|
|
1141
|
+
rangeLength?: uinteger;
|
|
918
1142
|
/**
|
|
919
1143
|
* The new text for the provided range.
|
|
920
1144
|
*/
|
|
@@ -927,15 +1151,15 @@ export declare type TextDocumentContentChangeEvent = {
|
|
|
927
1151
|
};
|
|
928
1152
|
export declare namespace TextDocumentContentChangeEvent {
|
|
929
1153
|
/**
|
|
930
|
-
* Checks whether the information
|
|
1154
|
+
* Checks whether the information describes a delta event.
|
|
931
1155
|
*/
|
|
932
1156
|
function isIncremental(event: TextDocumentContentChangeEvent): event is {
|
|
933
1157
|
range: Range;
|
|
934
|
-
rangeLength?:
|
|
1158
|
+
rangeLength?: uinteger;
|
|
935
1159
|
text: string;
|
|
936
1160
|
};
|
|
937
1161
|
/**
|
|
938
|
-
* Checks whether the information
|
|
1162
|
+
* Checks whether the information describes a full replacement event.
|
|
939
1163
|
*/
|
|
940
1164
|
function isFull(event: TextDocumentContentChangeEvent): event is {
|
|
941
1165
|
text: string;
|
|
@@ -960,7 +1184,7 @@ export interface DidChangeTextDocumentParams {
|
|
|
960
1184
|
*
|
|
961
1185
|
* To mirror the content of a document using change events use the following approach:
|
|
962
1186
|
* - start with the same initial content
|
|
963
|
-
* - apply the 'textDocument/didChange' notifications in the order you
|
|
1187
|
+
* - apply the 'textDocument/didChange' notifications in the order you receive them.
|
|
964
1188
|
* - apply the `TextDocumentContentChangeEvent`s in a single notification in the order
|
|
965
1189
|
* you receive them.
|
|
966
1190
|
*/
|
|
@@ -1012,7 +1236,7 @@ export interface DidSaveTextDocumentParams {
|
|
|
1012
1236
|
/**
|
|
1013
1237
|
* The document that was closed.
|
|
1014
1238
|
*/
|
|
1015
|
-
textDocument:
|
|
1239
|
+
textDocument: TextDocumentIdentifier;
|
|
1016
1240
|
/**
|
|
1017
1241
|
* Optional the content when saved. Depends on the includeText value
|
|
1018
1242
|
* when the save notification was requested.
|
|
@@ -1164,7 +1388,7 @@ export interface FileSystemWatcher {
|
|
|
1164
1388
|
* to WatchKind.Create | WatchKind.Change | WatchKind.Delete
|
|
1165
1389
|
* which is 7.
|
|
1166
1390
|
*/
|
|
1167
|
-
kind?:
|
|
1391
|
+
kind?: uinteger;
|
|
1168
1392
|
}
|
|
1169
1393
|
export declare namespace WatchKind {
|
|
1170
1394
|
/**
|
|
@@ -1210,7 +1434,7 @@ export interface PublishDiagnosticsClientCapabilities {
|
|
|
1210
1434
|
/**
|
|
1211
1435
|
* Client supports a codeDescription property
|
|
1212
1436
|
*
|
|
1213
|
-
* @since 3.16.0
|
|
1437
|
+
* @since 3.16.0
|
|
1214
1438
|
*/
|
|
1215
1439
|
codeDescriptionSupport?: boolean;
|
|
1216
1440
|
/**
|
|
@@ -1218,7 +1442,7 @@ export interface PublishDiagnosticsClientCapabilities {
|
|
|
1218
1442
|
* preserved between a `textDocument/publishDiagnostics` and
|
|
1219
1443
|
* `textDocument/codeAction` request.
|
|
1220
1444
|
*
|
|
1221
|
-
* @since 3.16.0
|
|
1445
|
+
* @since 3.16.0
|
|
1222
1446
|
*/
|
|
1223
1447
|
dataSupport?: boolean;
|
|
1224
1448
|
}
|
|
@@ -1235,7 +1459,7 @@ export interface PublishDiagnosticsParams {
|
|
|
1235
1459
|
*
|
|
1236
1460
|
* @since 3.15.0
|
|
1237
1461
|
*/
|
|
1238
|
-
version?:
|
|
1462
|
+
version?: integer;
|
|
1239
1463
|
/**
|
|
1240
1464
|
* An array of diagnostic information items.
|
|
1241
1465
|
*/
|
|
@@ -1287,6 +1511,9 @@ export interface CompletionClientCapabilities {
|
|
|
1287
1511
|
* Client supports the preselect property on a completion item.
|
|
1288
1512
|
*/
|
|
1289
1513
|
preselectSupport?: boolean;
|
|
1514
|
+
/**
|
|
1515
|
+
* Client supports to kee
|
|
1516
|
+
*/
|
|
1290
1517
|
/**
|
|
1291
1518
|
* Client supports the tag property on a completion item. Clients supporting
|
|
1292
1519
|
* tags have to handle unknown tags gracefully. Clients especially need to
|
|
@@ -1305,7 +1532,7 @@ export interface CompletionClientCapabilities {
|
|
|
1305
1532
|
* Client support insert replace edit to control different behavior if a
|
|
1306
1533
|
* completion item is inserted in the text or should replace text.
|
|
1307
1534
|
*
|
|
1308
|
-
* @since 3.16.0
|
|
1535
|
+
* @since 3.16.0
|
|
1309
1536
|
*/
|
|
1310
1537
|
insertReplaceSupport?: boolean;
|
|
1311
1538
|
/**
|
|
@@ -1313,7 +1540,7 @@ export interface CompletionClientCapabilities {
|
|
|
1313
1540
|
* item. Before version 3.16.0 only the predefined properties `documentation`
|
|
1314
1541
|
* and `details` could be resolved lazily.
|
|
1315
1542
|
*
|
|
1316
|
-
* @since 3.16.0
|
|
1543
|
+
* @since 3.16.0
|
|
1317
1544
|
*/
|
|
1318
1545
|
resolveSupport?: {
|
|
1319
1546
|
/**
|
|
@@ -1321,6 +1548,23 @@ export interface CompletionClientCapabilities {
|
|
|
1321
1548
|
*/
|
|
1322
1549
|
properties: string[];
|
|
1323
1550
|
};
|
|
1551
|
+
/**
|
|
1552
|
+
* The client supports the `insertTextMode` property on
|
|
1553
|
+
* a completion item to override the whitespace handling mode
|
|
1554
|
+
* as defined by the client (see `insertTextMode`).
|
|
1555
|
+
*
|
|
1556
|
+
* @since 3.16.0
|
|
1557
|
+
*/
|
|
1558
|
+
insertTextModeSupport?: {
|
|
1559
|
+
valueSet: InsertTextMode[];
|
|
1560
|
+
};
|
|
1561
|
+
/**
|
|
1562
|
+
* The client has support for completion item label
|
|
1563
|
+
* details (see also `CompletionItemLabelDetails`).
|
|
1564
|
+
*
|
|
1565
|
+
* @since 3.17.0 - proposed state
|
|
1566
|
+
*/
|
|
1567
|
+
labelDetailsSupport?: boolean;
|
|
1324
1568
|
};
|
|
1325
1569
|
completionItemKind?: {
|
|
1326
1570
|
/**
|
|
@@ -1335,11 +1579,38 @@ export interface CompletionClientCapabilities {
|
|
|
1335
1579
|
*/
|
|
1336
1580
|
valueSet?: CompletionItemKind[];
|
|
1337
1581
|
};
|
|
1582
|
+
/**
|
|
1583
|
+
* Defines how the client handles whitespace and indentation
|
|
1584
|
+
* when accepting a completion item that uses multi line
|
|
1585
|
+
* text in either `insertText` or `textEdit`.
|
|
1586
|
+
*
|
|
1587
|
+
* @since 3.17.0 - proposed state
|
|
1588
|
+
*/
|
|
1589
|
+
insertTextMode?: InsertTextMode;
|
|
1338
1590
|
/**
|
|
1339
1591
|
* The client supports to send additional context information for a
|
|
1340
|
-
* `textDocument/completion`
|
|
1592
|
+
* `textDocument/completion` request.
|
|
1341
1593
|
*/
|
|
1342
1594
|
contextSupport?: boolean;
|
|
1595
|
+
/**
|
|
1596
|
+
* The client supports the following `CompletionList` specific
|
|
1597
|
+
* capabilities.
|
|
1598
|
+
*
|
|
1599
|
+
* @since 3.17.0 - proposed state
|
|
1600
|
+
*/
|
|
1601
|
+
completionList?: {
|
|
1602
|
+
/**
|
|
1603
|
+
* The client supports the the following itemDefaults on
|
|
1604
|
+
* a completion list.
|
|
1605
|
+
*
|
|
1606
|
+
* The value lists the supported property names of the
|
|
1607
|
+
* `CompletionList.itemDefaults` object. If omitted
|
|
1608
|
+
* no properties are supported.
|
|
1609
|
+
*
|
|
1610
|
+
* @since 3.17.0 - proposed state
|
|
1611
|
+
*/
|
|
1612
|
+
itemDefaults?: string[];
|
|
1613
|
+
};
|
|
1343
1614
|
}
|
|
1344
1615
|
/**
|
|
1345
1616
|
* How a completion was triggered
|
|
@@ -1402,7 +1673,7 @@ export interface CompletionOptions extends WorkDoneProgressOptions {
|
|
|
1402
1673
|
triggerCharacters?: string[];
|
|
1403
1674
|
/**
|
|
1404
1675
|
* The list of all possible characters that commit a completion. This field can be used
|
|
1405
|
-
* if clients don't support individual
|
|
1676
|
+
* if clients don't support individual commit characters per completion item. See
|
|
1406
1677
|
* `ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport`
|
|
1407
1678
|
*
|
|
1408
1679
|
* If a server provides both `allCommitCharacters` and commit characters on an individual
|
|
@@ -1416,6 +1687,22 @@ export interface CompletionOptions extends WorkDoneProgressOptions {
|
|
|
1416
1687
|
* information for a completion item.
|
|
1417
1688
|
*/
|
|
1418
1689
|
resolveProvider?: boolean;
|
|
1690
|
+
/**
|
|
1691
|
+
* The server supports the following `CompletionItem` specific
|
|
1692
|
+
* capabilities.
|
|
1693
|
+
*
|
|
1694
|
+
* @since 3.17.0 - proposed state
|
|
1695
|
+
*/
|
|
1696
|
+
completionItem?: {
|
|
1697
|
+
/**
|
|
1698
|
+
* The server has support for completion item label
|
|
1699
|
+
* details (see also `CompletionItemLabelDetails`) when
|
|
1700
|
+
* receiving a completion item in a resolve call.
|
|
1701
|
+
*
|
|
1702
|
+
* @since 3.17.0 - proposed state
|
|
1703
|
+
*/
|
|
1704
|
+
labelDetailsSupport?: boolean;
|
|
1705
|
+
};
|
|
1419
1706
|
}
|
|
1420
1707
|
/**
|
|
1421
1708
|
* Registration options for a [CompletionRequest](#CompletionRequest).
|
|
@@ -1436,8 +1723,6 @@ export interface CompletionRegistrationOptions extends TextDocumentRegistrationO
|
|
|
1436
1723
|
export declare namespace CompletionRequest {
|
|
1437
1724
|
const method: 'textDocument/completion';
|
|
1438
1725
|
const type: ProtocolRequestType<CompletionParams, CompletionList | CompletionItem[] | null, CompletionItem[], void, CompletionRegistrationOptions>;
|
|
1439
|
-
/** @deprecated Use CompletionRequest.type */
|
|
1440
|
-
const resultType: ProgressType<CompletionItem[]>;
|
|
1441
1726
|
}
|
|
1442
1727
|
/**
|
|
1443
1728
|
* Request to resolve additional information for a given completion item.The request's
|
|
@@ -1517,7 +1802,7 @@ export interface SignatureHelpClientCapabilities {
|
|
|
1517
1802
|
* The client support the `activeParameter` property on `SignatureInformation`
|
|
1518
1803
|
* literal.
|
|
1519
1804
|
*
|
|
1520
|
-
* @since 3.16.0
|
|
1805
|
+
* @since 3.16.0
|
|
1521
1806
|
*/
|
|
1522
1807
|
activeParameterSupport?: boolean;
|
|
1523
1808
|
};
|
|
@@ -1588,7 +1873,7 @@ export interface SignatureHelpContext {
|
|
|
1588
1873
|
/**
|
|
1589
1874
|
* `true` if signature help was already showing when it was triggered.
|
|
1590
1875
|
*
|
|
1591
|
-
*
|
|
1876
|
+
* Retrigger occurs when the signature help is already active and can be caused by actions such as
|
|
1592
1877
|
* typing a trigger character, a cursor move, or document content changes.
|
|
1593
1878
|
*/
|
|
1594
1879
|
isRetrigger: boolean;
|
|
@@ -1660,9 +1945,7 @@ export interface DefinitionRegistrationOptions extends TextDocumentRegistrationO
|
|
|
1660
1945
|
*/
|
|
1661
1946
|
export declare namespace DefinitionRequest {
|
|
1662
1947
|
const method: 'textDocument/definition';
|
|
1663
|
-
const type: ProtocolRequestType<DefinitionParams,
|
|
1664
|
-
/** @deprecated Use DefinitionRequest.type */
|
|
1665
|
-
const resultType: ProgressType<Location[] | LocationLink[]>;
|
|
1948
|
+
const type: ProtocolRequestType<DefinitionParams, Definition | LocationLink[] | null, Location[] | LocationLink[], void, DefinitionRegistrationOptions>;
|
|
1666
1949
|
}
|
|
1667
1950
|
/**
|
|
1668
1951
|
* Client Capabilities for a [ReferencesRequest](#ReferencesRequest).
|
|
@@ -1698,8 +1981,6 @@ export interface ReferenceRegistrationOptions extends TextDocumentRegistrationOp
|
|
|
1698
1981
|
export declare namespace ReferencesRequest {
|
|
1699
1982
|
const method: 'textDocument/references';
|
|
1700
1983
|
const type: ProtocolRequestType<ReferenceParams, Location[] | null, Location[], void, ReferenceRegistrationOptions>;
|
|
1701
|
-
/** @deprecated Use ReferencesRequest.type */
|
|
1702
|
-
const resultType: ProgressType<Location[]>;
|
|
1703
1984
|
}
|
|
1704
1985
|
/**
|
|
1705
1986
|
* Client Capabilities for a [DocumentHighlightRequest](#DocumentHighlightRequest).
|
|
@@ -1734,8 +2015,6 @@ export interface DocumentHighlightRegistrationOptions extends TextDocumentRegist
|
|
|
1734
2015
|
export declare namespace DocumentHighlightRequest {
|
|
1735
2016
|
const method: 'textDocument/documentHighlight';
|
|
1736
2017
|
const type: ProtocolRequestType<DocumentHighlightParams, DocumentHighlight[] | null, DocumentHighlight[], void, DocumentHighlightRegistrationOptions>;
|
|
1737
|
-
/** @deprecated Use DocumentHighlightRequest.type */
|
|
1738
|
-
const resultType: ProgressType<DocumentHighlight[]>;
|
|
1739
2018
|
}
|
|
1740
2019
|
/**
|
|
1741
2020
|
* Client Capabilities for a [DocumentSymbolRequest](#DocumentSymbolRequest).
|
|
@@ -1770,7 +2049,7 @@ export interface DocumentSymbolClientCapabilities {
|
|
|
1770
2049
|
* `DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true.
|
|
1771
2050
|
* Clients supporting tags have to handle unknown tags gracefully.
|
|
1772
2051
|
*
|
|
1773
|
-
* @since 3.16.0
|
|
2052
|
+
* @since 3.16.0
|
|
1774
2053
|
*/
|
|
1775
2054
|
tagSupport?: {
|
|
1776
2055
|
/**
|
|
@@ -1803,7 +2082,7 @@ export interface DocumentSymbolOptions extends WorkDoneProgressOptions {
|
|
|
1803
2082
|
* A human-readable string that is shown when multiple outlines trees
|
|
1804
2083
|
* are shown for the same document.
|
|
1805
2084
|
*
|
|
1806
|
-
* @since 3.16.0
|
|
2085
|
+
* @since 3.16.0
|
|
1807
2086
|
*/
|
|
1808
2087
|
label?: string;
|
|
1809
2088
|
}
|
|
@@ -1821,8 +2100,6 @@ export interface DocumentSymbolRegistrationOptions extends TextDocumentRegistrat
|
|
|
1821
2100
|
export declare namespace DocumentSymbolRequest {
|
|
1822
2101
|
const method: 'textDocument/documentSymbol';
|
|
1823
2102
|
const type: ProtocolRequestType<DocumentSymbolParams, DocumentSymbol[] | SymbolInformation[] | null, DocumentSymbol[] | SymbolInformation[], void, DocumentSymbolRegistrationOptions>;
|
|
1824
|
-
/** @deprecated Use DocumentSymbolRequest.type */
|
|
1825
|
-
const resultType: ProgressType<DocumentSymbol[] | SymbolInformation[]>;
|
|
1826
2103
|
}
|
|
1827
2104
|
/**
|
|
1828
2105
|
* The Client Capabilities of a [CodeActionRequest](#CodeActionRequest).
|
|
@@ -1863,7 +2140,7 @@ export interface CodeActionClientCapabilities {
|
|
|
1863
2140
|
/**
|
|
1864
2141
|
* Whether code action supports the `disabled` property.
|
|
1865
2142
|
*
|
|
1866
|
-
* @since 3.16.0
|
|
2143
|
+
* @since 3.16.0
|
|
1867
2144
|
*/
|
|
1868
2145
|
disabledSupport?: boolean;
|
|
1869
2146
|
/**
|
|
@@ -1871,14 +2148,14 @@ export interface CodeActionClientCapabilities {
|
|
|
1871
2148
|
* preserved between a `textDocument/codeAction` and a
|
|
1872
2149
|
* `codeAction/resolve` request.
|
|
1873
2150
|
*
|
|
1874
|
-
* @since 3.16.0
|
|
2151
|
+
* @since 3.16.0
|
|
1875
2152
|
*/
|
|
1876
2153
|
dataSupport?: boolean;
|
|
1877
2154
|
/**
|
|
1878
2155
|
* Whether the client support resolving additional code action
|
|
1879
2156
|
* properties via a separate `codeAction/resolve` request.
|
|
1880
2157
|
*
|
|
1881
|
-
* @since 3.16.0
|
|
2158
|
+
* @since 3.16.0
|
|
1882
2159
|
*/
|
|
1883
2160
|
resolveSupport?: {
|
|
1884
2161
|
/**
|
|
@@ -1886,6 +2163,16 @@ export interface CodeActionClientCapabilities {
|
|
|
1886
2163
|
*/
|
|
1887
2164
|
properties: string[];
|
|
1888
2165
|
};
|
|
2166
|
+
/**
|
|
2167
|
+
* Whether th client honors the change annotations in
|
|
2168
|
+
* text edits and resource operations returned via the
|
|
2169
|
+
* `CodeAction#edit` property by for example presenting
|
|
2170
|
+
* the workspace edit in the user interface and asking
|
|
2171
|
+
* for confirmation.
|
|
2172
|
+
*
|
|
2173
|
+
* @since 3.16.0
|
|
2174
|
+
*/
|
|
2175
|
+
honorsChangeAnnotations?: boolean;
|
|
1889
2176
|
}
|
|
1890
2177
|
/**
|
|
1891
2178
|
* The parameters of a [CodeActionRequest](#CodeActionRequest).
|
|
@@ -1934,8 +2221,6 @@ export interface CodeActionRegistrationOptions extends TextDocumentRegistrationO
|
|
|
1934
2221
|
export declare namespace CodeActionRequest {
|
|
1935
2222
|
const method: 'textDocument/codeAction';
|
|
1936
2223
|
const type: ProtocolRequestType<CodeActionParams, (Command | CodeAction)[] | null, (Command | CodeAction)[], void, CodeActionRegistrationOptions>;
|
|
1937
|
-
/** @deprecated Use CodeActionRequest.type */
|
|
1938
|
-
const resultType: ProgressType<(Command | CodeAction)[]>;
|
|
1939
2224
|
}
|
|
1940
2225
|
/**
|
|
1941
2226
|
* Request to resolve additional information for a given code action.The request's
|
|
@@ -1974,7 +2259,7 @@ export interface WorkspaceSymbolClientCapabilities {
|
|
|
1974
2259
|
* The client supports tags on `SymbolInformation`.
|
|
1975
2260
|
* Clients supporting tags have to handle unknown tags gracefully.
|
|
1976
2261
|
*
|
|
1977
|
-
* @since 3.16.0
|
|
2262
|
+
* @since 3.16.0
|
|
1978
2263
|
*/
|
|
1979
2264
|
tagSupport?: {
|
|
1980
2265
|
/**
|
|
@@ -1982,6 +2267,20 @@ export interface WorkspaceSymbolClientCapabilities {
|
|
|
1982
2267
|
*/
|
|
1983
2268
|
valueSet: SymbolTag[];
|
|
1984
2269
|
};
|
|
2270
|
+
/**
|
|
2271
|
+
* The client support partial workspace symbols. The client will send the
|
|
2272
|
+
* request `workspaceSymbol/resolve` to the server to resolve additional
|
|
2273
|
+
* properties.
|
|
2274
|
+
*
|
|
2275
|
+
* @since 3.17.0 - proposedState
|
|
2276
|
+
*/
|
|
2277
|
+
resolveSupport?: {
|
|
2278
|
+
/**
|
|
2279
|
+
* The properties that a client can resolve lazily. Usually
|
|
2280
|
+
* `location.range`
|
|
2281
|
+
*/
|
|
2282
|
+
properties: string[];
|
|
2283
|
+
};
|
|
1985
2284
|
}
|
|
1986
2285
|
/**
|
|
1987
2286
|
* The parameters of a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
|
|
@@ -1997,6 +2296,13 @@ export interface WorkspaceSymbolParams extends WorkDoneProgressParams, PartialRe
|
|
|
1997
2296
|
* Server capabilities for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
|
|
1998
2297
|
*/
|
|
1999
2298
|
export interface WorkspaceSymbolOptions extends WorkDoneProgressOptions {
|
|
2299
|
+
/**
|
|
2300
|
+
* The server provides support to resolve additional
|
|
2301
|
+
* information for a workspace symbol.
|
|
2302
|
+
*
|
|
2303
|
+
* @since 3.17.0 - proposed state
|
|
2304
|
+
*/
|
|
2305
|
+
resolveProvider?: boolean;
|
|
2000
2306
|
}
|
|
2001
2307
|
/**
|
|
2002
2308
|
* Registration options for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
|
|
@@ -2008,12 +2314,25 @@ export interface WorkspaceSymbolRegistrationOptions extends WorkspaceSymbolOptio
|
|
|
2008
2314
|
* by the [WorkspaceSymbolParams](#WorkspaceSymbolParams). The response is
|
|
2009
2315
|
* of type [SymbolInformation[]](#SymbolInformation) or a Thenable that
|
|
2010
2316
|
* resolves to such.
|
|
2317
|
+
*
|
|
2318
|
+
* @since 3.17.0 - support for WorkspaceSymbol in the returned data. Clients
|
|
2319
|
+
* need to advertise support for WorkspaceSymbols via the client capability
|
|
2320
|
+
* `workspace.symbol.resolveSupport`.
|
|
2321
|
+
*
|
|
2011
2322
|
*/
|
|
2012
2323
|
export declare namespace WorkspaceSymbolRequest {
|
|
2013
2324
|
const method: 'workspace/symbol';
|
|
2014
|
-
const type: ProtocolRequestType<WorkspaceSymbolParams, SymbolInformation[] | null, SymbolInformation[], void, WorkspaceSymbolRegistrationOptions>;
|
|
2015
|
-
|
|
2016
|
-
|
|
2325
|
+
const type: ProtocolRequestType<WorkspaceSymbolParams, SymbolInformation[] | WorkspaceSymbol[] | null, SymbolInformation[] | WorkspaceSymbol[], void, WorkspaceSymbolRegistrationOptions>;
|
|
2326
|
+
}
|
|
2327
|
+
/**
|
|
2328
|
+
* A request to resolve the range inside the workspace
|
|
2329
|
+
* symbol's location.
|
|
2330
|
+
*
|
|
2331
|
+
* @since 3.17.0 - proposed state
|
|
2332
|
+
*/
|
|
2333
|
+
export declare namespace WorkspaceSymbolResolveRequest {
|
|
2334
|
+
const method: 'workspaceSymbol/resolve';
|
|
2335
|
+
const type: ProtocolRequestType<WorkspaceSymbol, WorkspaceSymbol, never, void, void>;
|
|
2017
2336
|
}
|
|
2018
2337
|
/**
|
|
2019
2338
|
* The client capabilities of a [CodeLensRequest](#CodeLensRequest).
|
|
@@ -2024,6 +2343,21 @@ export interface CodeLensClientCapabilities {
|
|
|
2024
2343
|
*/
|
|
2025
2344
|
dynamicRegistration?: boolean;
|
|
2026
2345
|
}
|
|
2346
|
+
/**
|
|
2347
|
+
* @since 3.16.0
|
|
2348
|
+
*/
|
|
2349
|
+
export interface CodeLensWorkspaceClientCapabilities {
|
|
2350
|
+
/**
|
|
2351
|
+
* Whether the client implementation supports a refresh request sent from the
|
|
2352
|
+
* server to the client.
|
|
2353
|
+
*
|
|
2354
|
+
* Note that this event is global and will force the client to refresh all
|
|
2355
|
+
* code lenses currently shown. It should be used with absolute care and is
|
|
2356
|
+
* useful for situation where a server for example detect a project wide
|
|
2357
|
+
* change that requires such a calculation.
|
|
2358
|
+
*/
|
|
2359
|
+
refreshSupport?: boolean;
|
|
2360
|
+
}
|
|
2027
2361
|
/**
|
|
2028
2362
|
* The parameters of a [CodeLensRequest](#CodeLensRequest).
|
|
2029
2363
|
*/
|
|
@@ -2051,16 +2385,25 @@ export interface CodeLensRegistrationOptions extends TextDocumentRegistrationOpt
|
|
|
2051
2385
|
* A request to provide code lens for the given text document.
|
|
2052
2386
|
*/
|
|
2053
2387
|
export declare namespace CodeLensRequest {
|
|
2388
|
+
const method: 'textDocument/codeLens';
|
|
2054
2389
|
const type: ProtocolRequestType<CodeLensParams, CodeLens[] | null, CodeLens[], void, CodeLensRegistrationOptions>;
|
|
2055
|
-
/** @deprecated Use CodeLensRequest.type */
|
|
2056
|
-
const resultType: ProgressType<CodeLens[]>;
|
|
2057
2390
|
}
|
|
2058
2391
|
/**
|
|
2059
2392
|
* A request to resolve a command for a given code lens.
|
|
2060
2393
|
*/
|
|
2061
2394
|
export declare namespace CodeLensResolveRequest {
|
|
2395
|
+
const method: 'codeLens/resolve';
|
|
2062
2396
|
const type: ProtocolRequestType<CodeLens, CodeLens, never, void, void>;
|
|
2063
2397
|
}
|
|
2398
|
+
/**
|
|
2399
|
+
* A request to refresh all code actions
|
|
2400
|
+
*
|
|
2401
|
+
* @since 3.16.0
|
|
2402
|
+
*/
|
|
2403
|
+
export declare namespace CodeLensRefreshRequest {
|
|
2404
|
+
const method: `workspace/codeLens/refresh`;
|
|
2405
|
+
const type: ProtocolRequestType0<void, void, void, void>;
|
|
2406
|
+
}
|
|
2064
2407
|
/**
|
|
2065
2408
|
* The client capabilities of a [DocumentLinkRequest](#DocumentLinkRequest).
|
|
2066
2409
|
*/
|
|
@@ -2105,8 +2448,6 @@ export interface DocumentLinkRegistrationOptions extends TextDocumentRegistratio
|
|
|
2105
2448
|
export declare namespace DocumentLinkRequest {
|
|
2106
2449
|
const method: 'textDocument/documentLink';
|
|
2107
2450
|
const type: ProtocolRequestType<DocumentLinkParams, DocumentLink[] | null, DocumentLink[], void, DocumentLinkRegistrationOptions>;
|
|
2108
|
-
/** @deprecated Use DocumentLinkRequest.type */
|
|
2109
|
-
const resultType: ProgressType<DocumentLink[]>;
|
|
2110
2451
|
}
|
|
2111
2452
|
/**
|
|
2112
2453
|
* Request to resolve additional information for a given document link. The request's
|
|
@@ -2114,6 +2455,7 @@ export declare namespace DocumentLinkRequest {
|
|
|
2114
2455
|
* is of type [DocumentLink](#DocumentLink) or a Thenable that resolves to such.
|
|
2115
2456
|
*/
|
|
2116
2457
|
export declare namespace DocumentLinkResolveRequest {
|
|
2458
|
+
const method: 'documentLink/resolve';
|
|
2117
2459
|
const type: ProtocolRequestType<DocumentLink, DocumentLink, never, void, void>;
|
|
2118
2460
|
}
|
|
2119
2461
|
/**
|
|
@@ -2253,6 +2595,14 @@ export declare namespace DocumentOnTypeFormattingRequest {
|
|
|
2253
2595
|
const method: 'textDocument/onTypeFormatting';
|
|
2254
2596
|
const type: ProtocolRequestType<DocumentOnTypeFormattingParams, TextEdit[] | null, never, void, DocumentOnTypeFormattingRegistrationOptions>;
|
|
2255
2597
|
}
|
|
2598
|
+
export declare namespace PrepareSupportDefaultBehavior {
|
|
2599
|
+
/**
|
|
2600
|
+
* The client's default behavior is to select the identifier
|
|
2601
|
+
* according the to language's syntax rule.
|
|
2602
|
+
*/
|
|
2603
|
+
const Identifier: 1;
|
|
2604
|
+
}
|
|
2605
|
+
export declare type PrepareSupportDefaultBehavior = 1;
|
|
2256
2606
|
export interface RenameClientCapabilities {
|
|
2257
2607
|
/**
|
|
2258
2608
|
* Whether rename supports dynamic registration.
|
|
@@ -2262,15 +2612,28 @@ export interface RenameClientCapabilities {
|
|
|
2262
2612
|
* Client supports testing for validity of rename operations
|
|
2263
2613
|
* before execution.
|
|
2264
2614
|
*
|
|
2265
|
-
* @since
|
|
2615
|
+
* @since 3.12.0
|
|
2266
2616
|
*/
|
|
2267
2617
|
prepareSupport?: boolean;
|
|
2268
2618
|
/**
|
|
2269
2619
|
* Client supports the default behavior result.
|
|
2270
2620
|
*
|
|
2271
|
-
*
|
|
2621
|
+
* The value indicates the default behavior used by the
|
|
2622
|
+
* client.
|
|
2623
|
+
*
|
|
2624
|
+
* @since 3.16.0
|
|
2272
2625
|
*/
|
|
2273
|
-
prepareSupportDefaultBehavior?:
|
|
2626
|
+
prepareSupportDefaultBehavior?: PrepareSupportDefaultBehavior;
|
|
2627
|
+
/**
|
|
2628
|
+
* Whether th client honors the change annotations in
|
|
2629
|
+
* text edits and resource operations returned via the
|
|
2630
|
+
* rename request's workspace edit by for example presenting
|
|
2631
|
+
* the workspace edit in the user interface and asking
|
|
2632
|
+
* for confirmation.
|
|
2633
|
+
*
|
|
2634
|
+
* @since 3.16.0
|
|
2635
|
+
*/
|
|
2636
|
+
honorsChangeAnnotations?: boolean;
|
|
2274
2637
|
}
|
|
2275
2638
|
/**
|
|
2276
2639
|
* The parameters of a [RenameRequest](#RenameRequest).
|
|
@@ -2350,7 +2713,7 @@ export interface ExecuteCommandParams extends WorkDoneProgressParams {
|
|
|
2350
2713
|
/**
|
|
2351
2714
|
* Arguments that the command should be invoked with.
|
|
2352
2715
|
*/
|
|
2353
|
-
arguments?:
|
|
2716
|
+
arguments?: LSPAny[];
|
|
2354
2717
|
}
|
|
2355
2718
|
/**
|
|
2356
2719
|
* The server capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
|
|
@@ -2371,7 +2734,7 @@ export interface ExecuteCommandRegistrationOptions extends ExecuteCommandOptions
|
|
|
2371
2734
|
* a workspace edit which the client will apply to the workspace.
|
|
2372
2735
|
*/
|
|
2373
2736
|
export declare namespace ExecuteCommandRequest {
|
|
2374
|
-
const type: ProtocolRequestType<ExecuteCommandParams,
|
|
2737
|
+
const type: ProtocolRequestType<ExecuteCommandParams, LSPAny, never, void, ExecuteCommandRegistrationOptions>;
|
|
2375
2738
|
}
|
|
2376
2739
|
export interface WorkspaceEditClientCapabilities {
|
|
2377
2740
|
/**
|
|
@@ -2392,6 +2755,30 @@ export interface WorkspaceEditClientCapabilities {
|
|
|
2392
2755
|
* @since 3.13.0
|
|
2393
2756
|
*/
|
|
2394
2757
|
failureHandling?: FailureHandlingKind;
|
|
2758
|
+
/**
|
|
2759
|
+
* Whether the client normalizes line endings to the client specific
|
|
2760
|
+
* setting.
|
|
2761
|
+
* If set to `true` the client will normalize line ending characters
|
|
2762
|
+
* in a workspace edit containing to the client specific new line
|
|
2763
|
+
* character.
|
|
2764
|
+
*
|
|
2765
|
+
* @since 3.16.0
|
|
2766
|
+
*/
|
|
2767
|
+
normalizesLineEndings?: boolean;
|
|
2768
|
+
/**
|
|
2769
|
+
* Whether the client in general supports change annotations on text edits,
|
|
2770
|
+
* create file, rename file and delete file changes.
|
|
2771
|
+
*
|
|
2772
|
+
* @since 3.16.0
|
|
2773
|
+
*/
|
|
2774
|
+
changeAnnotationSupport?: {
|
|
2775
|
+
/**
|
|
2776
|
+
* Whether the client groups edits with equal labels into tree nodes,
|
|
2777
|
+
* for instance all edits labelled with "Changes in Strings" would
|
|
2778
|
+
* be a tree node.
|
|
2779
|
+
*/
|
|
2780
|
+
groupsOnLabel?: boolean;
|
|
2781
|
+
};
|
|
2395
2782
|
}
|
|
2396
2783
|
/**
|
|
2397
2784
|
* The parameters passed via a apply workspace edit request.
|
|
@@ -2409,9 +2796,11 @@ export interface ApplyWorkspaceEditParams {
|
|
|
2409
2796
|
edit: WorkspaceEdit;
|
|
2410
2797
|
}
|
|
2411
2798
|
/**
|
|
2412
|
-
*
|
|
2799
|
+
* The result returned from the apply workspace edit request.
|
|
2800
|
+
*
|
|
2801
|
+
* @since 3.17 renamed from ApplyWorkspaceEditResponse
|
|
2413
2802
|
*/
|
|
2414
|
-
export interface
|
|
2803
|
+
export interface ApplyWorkspaceEditResult {
|
|
2415
2804
|
/**
|
|
2416
2805
|
* Indicates whether the edit was applied or not.
|
|
2417
2806
|
*/
|
|
@@ -2427,13 +2816,17 @@ export interface ApplyWorkspaceEditResponse {
|
|
|
2427
2816
|
* contain the index of the change that failed. This property is only available
|
|
2428
2817
|
* if the client signals a `failureHandlingStrategy` in its client capabilities.
|
|
2429
2818
|
*/
|
|
2430
|
-
failedChange?:
|
|
2819
|
+
failedChange?: uinteger;
|
|
2431
2820
|
}
|
|
2821
|
+
/**
|
|
2822
|
+
* @deprecated Use ApplyWorkspaceEditResult instead.
|
|
2823
|
+
*/
|
|
2824
|
+
export declare type ApplyWorkspaceEditResponse = ApplyWorkspaceEditResult;
|
|
2432
2825
|
/**
|
|
2433
2826
|
* A request sent from the server to the client to modified certain resources.
|
|
2434
2827
|
*/
|
|
2435
2828
|
export declare namespace ApplyWorkspaceEditRequest {
|
|
2436
|
-
const type: ProtocolRequestType<ApplyWorkspaceEditParams,
|
|
2829
|
+
const type: ProtocolRequestType<ApplyWorkspaceEditParams, ApplyWorkspaceEditResult, never, void, void>;
|
|
2437
2830
|
}
|
|
2438
|
-
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,
|
|
2831
|
+
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, };
|
|
2439
2832
|
export { DocumentColorOptions as ColorProviderOptions, DocumentColorOptions as ColorOptions, FoldingRangeOptions as FoldingRangeProviderOptions, SelectionRangeOptions as SelectionRangeProviderOptions, DocumentColorRegistrationOptions as ColorRegistrationOptions };
|