vscode-languageserver-protocol 3.17.0-next.7 → 3.17.0
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 +6 -2
- package/lib/common/api.d.ts +10 -27
- package/lib/common/api.js +15 -11
- package/lib/common/connection.d.ts +41 -17
- package/lib/common/connection.js +1 -1
- package/lib/common/messages.js +0 -3
- package/lib/common/protocol.$.d.ts +1 -0
- package/lib/common/protocol.$.js +36 -0
- package/lib/common/protocol.callHierarchy.d.ts +1 -1
- package/lib/common/protocol.colorProvider.d.ts +1 -1
- package/lib/common/protocol.configuration.d.ts +4 -16
- package/lib/common/protocol.configuration.js +1 -0
- package/lib/common/protocol.d.ts +453 -69
- package/lib/common/protocol.declaration.d.ts +2 -2
- package/lib/common/protocol.declaration.js +2 -2
- package/lib/common/{proposed.diagnostic.d.ts → protocol.diagnostic.d.ts} +85 -71
- package/lib/common/{proposed.diagnostic.js → protocol.diagnostic.js} +8 -8
- package/lib/common/protocol.foldingRange.d.ts +40 -27
- package/lib/common/protocol.foldingRange.js +1 -19
- package/lib/common/protocol.implementation.d.ts +2 -2
- package/lib/common/protocol.implementation.js +2 -2
- package/lib/common/protocol.inlayHint.d.ts +107 -0
- package/lib/common/protocol.inlayHint.js +41 -0
- package/lib/common/protocol.inlineValue.d.ts +84 -0
- package/lib/common/protocol.inlineValue.js +29 -0
- package/lib/common/protocol.js +131 -17
- 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 +391 -0
- package/lib/common/protocol.notebook.js +206 -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 +23 -1
- package/lib/common/protocol.typeDefinition.d.ts +1 -1
- package/lib/common/protocol.typeHierarchy.d.ts +80 -0
- package/lib/common/protocol.typeHierarchy.js +40 -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 +6 -2
- package/metaModel.schema.json +705 -0
- package/package.json +4 -4
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, Definition, 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
|
|
@@ -31,8 +36,10 @@ import { UniquenessLevel, MonikerKind, Moniker, MonikerClientCapabilities, Monik
|
|
|
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
|
|
34
41
|
*/
|
|
35
|
-
export declare type
|
|
42
|
+
export declare type TextDocumentFilter = {
|
|
36
43
|
/** A language id, like `typescript`. */
|
|
37
44
|
language: string;
|
|
38
45
|
/** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
|
|
@@ -55,12 +62,90 @@ export declare type DocumentFilter = {
|
|
|
55
62
|
pattern: string;
|
|
56
63
|
};
|
|
57
64
|
/**
|
|
58
|
-
* The
|
|
59
|
-
* [
|
|
65
|
+
* The TextDocumentFilter namespace provides helper functions to work with
|
|
66
|
+
* [TextDocumentFilter](#TextDocumentFilter) literals.
|
|
67
|
+
*
|
|
68
|
+
* @since 3.17.0
|
|
69
|
+
*/
|
|
70
|
+
export declare namespace TextDocumentFilter {
|
|
71
|
+
function is(value: any): value is TextDocumentFilter;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* A notebook document filter denotes a notebook document by
|
|
75
|
+
* different properties. The properties will be match
|
|
76
|
+
* against the notebook's URI (same as with documents)
|
|
77
|
+
*
|
|
78
|
+
* @since 3.17.0
|
|
79
|
+
*/
|
|
80
|
+
export declare type NotebookDocumentFilter = {
|
|
81
|
+
/** The type of the enclosing notebook. */
|
|
82
|
+
notebookType: string;
|
|
83
|
+
/** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
|
|
84
|
+
scheme?: string;
|
|
85
|
+
/** A glob pattern. */
|
|
86
|
+
pattern?: string;
|
|
87
|
+
} | {
|
|
88
|
+
/** The type of the enclosing notebook. */
|
|
89
|
+
notebookType?: string;
|
|
90
|
+
/** A Uri [scheme](#Uri.scheme), like `file` or `untitled`.*/
|
|
91
|
+
scheme: string;
|
|
92
|
+
/** A glob pattern. */
|
|
93
|
+
pattern?: string;
|
|
94
|
+
} | {
|
|
95
|
+
/** The type of the enclosing notebook. */
|
|
96
|
+
notebookType?: string;
|
|
97
|
+
/** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
|
|
98
|
+
scheme?: string;
|
|
99
|
+
/** A glob pattern. */
|
|
100
|
+
pattern: string;
|
|
101
|
+
};
|
|
102
|
+
/**
|
|
103
|
+
* The NotebookDocumentFilter namespace provides helper functions to work with
|
|
104
|
+
* [NotebookDocumentFilter](#NotebookDocumentFilter) literals.
|
|
105
|
+
*
|
|
106
|
+
* @since 3.17.0
|
|
107
|
+
*/
|
|
108
|
+
export declare namespace NotebookDocumentFilter {
|
|
109
|
+
function is(value: any): value is NotebookDocumentFilter;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* A notebook cell text document filter denotes a cell text
|
|
113
|
+
* document by different properties.
|
|
114
|
+
*
|
|
115
|
+
* @since 3.17.0
|
|
116
|
+
*/
|
|
117
|
+
export declare type NotebookCellTextDocumentFilter = {
|
|
118
|
+
/**
|
|
119
|
+
* A filter that matches against the notebook
|
|
120
|
+
* containing the notebook cell. If a string
|
|
121
|
+
* value is provided it matches against the
|
|
122
|
+
* notebook type. '*' matches every notebook.
|
|
123
|
+
*/
|
|
124
|
+
notebook: string | NotebookDocumentFilter;
|
|
125
|
+
/**
|
|
126
|
+
* A language id like `python`.
|
|
127
|
+
*
|
|
128
|
+
* Will be matched against the language id of the
|
|
129
|
+
* notebook cell document. '*' matches every language.
|
|
130
|
+
*/
|
|
131
|
+
language?: string;
|
|
132
|
+
};
|
|
133
|
+
/**
|
|
134
|
+
* The NotebookCellTextDocumentFilter namespace provides helper functions to work with
|
|
135
|
+
* [NotebookCellTextDocumentFilter](#NotebookCellTextDocumentFilter) literals.
|
|
136
|
+
*
|
|
137
|
+
* @since 3.17.0
|
|
60
138
|
*/
|
|
61
|
-
export declare namespace
|
|
62
|
-
function is(value: any): value is
|
|
139
|
+
export declare namespace NotebookCellTextDocumentFilter {
|
|
140
|
+
function is(value: any): value is NotebookCellTextDocumentFilter;
|
|
63
141
|
}
|
|
142
|
+
/**
|
|
143
|
+
* A document filter describes a top level text document or
|
|
144
|
+
* a notebook cell document.
|
|
145
|
+
*
|
|
146
|
+
* @since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
|
|
147
|
+
*/
|
|
148
|
+
export declare type DocumentFilter = TextDocumentFilter | NotebookCellTextDocumentFilter;
|
|
64
149
|
/**
|
|
65
150
|
* A document selector is the combination of one or many document filters.
|
|
66
151
|
*
|
|
@@ -92,7 +177,7 @@ export interface Registration {
|
|
|
92
177
|
/**
|
|
93
178
|
* Options necessary for the registration.
|
|
94
179
|
*/
|
|
95
|
-
registerOptions?:
|
|
180
|
+
registerOptions?: LSPAny;
|
|
96
181
|
}
|
|
97
182
|
export interface RegistrationParams {
|
|
98
183
|
registrations: Registration[];
|
|
@@ -227,6 +312,18 @@ export interface WorkspaceClientCapabilities {
|
|
|
227
312
|
* Capabilities specific to the `workspace/executeCommand` request.
|
|
228
313
|
*/
|
|
229
314
|
executeCommand?: ExecuteCommandClientCapabilities;
|
|
315
|
+
/**
|
|
316
|
+
* The client has support for workspace folders
|
|
317
|
+
*
|
|
318
|
+
* @since 3.6.0
|
|
319
|
+
*/
|
|
320
|
+
workspaceFolders?: boolean;
|
|
321
|
+
/**
|
|
322
|
+
* The client supports `workspace/configuration` requests.
|
|
323
|
+
*
|
|
324
|
+
* @since 3.6.0
|
|
325
|
+
*/
|
|
326
|
+
configuration?: boolean;
|
|
230
327
|
/**
|
|
231
328
|
* Capabilities specific to the semantic token requests scoped to the
|
|
232
329
|
* workspace.
|
|
@@ -247,6 +344,27 @@ export interface WorkspaceClientCapabilities {
|
|
|
247
344
|
* Since 3.16.0
|
|
248
345
|
*/
|
|
249
346
|
fileOperations?: FileOperationClientCapabilities;
|
|
347
|
+
/**
|
|
348
|
+
* Capabilities specific to the inline values requests scoped to the
|
|
349
|
+
* workspace.
|
|
350
|
+
*
|
|
351
|
+
* @since 3.17.0.
|
|
352
|
+
*/
|
|
353
|
+
inlineValue?: InlineValueWorkspaceClientCapabilities;
|
|
354
|
+
/**
|
|
355
|
+
* Capabilities specific to the inlay hints requests scoped to the
|
|
356
|
+
* workspace.
|
|
357
|
+
*
|
|
358
|
+
* @since 3.17.0.
|
|
359
|
+
*/
|
|
360
|
+
inlayHint?: InlayHintWorkspaceClientCapabilities;
|
|
361
|
+
/**
|
|
362
|
+
* Capabilities specific to the diagnostic requests scoped to the
|
|
363
|
+
* workspace.
|
|
364
|
+
*
|
|
365
|
+
* @since 3.17.0.
|
|
366
|
+
*/
|
|
367
|
+
diagnostics?: DiagnosticWorkspaceClientCapabilities;
|
|
250
368
|
}
|
|
251
369
|
/**
|
|
252
370
|
* Text document specific client capabilities.
|
|
@@ -374,12 +492,40 @@ export interface TextDocumentClientCapabilities {
|
|
|
374
492
|
* @since 3.16.0
|
|
375
493
|
*/
|
|
376
494
|
moniker?: MonikerClientCapabilities;
|
|
495
|
+
/**
|
|
496
|
+
* Capabilities specific to the various type hierarchy requests.
|
|
497
|
+
*
|
|
498
|
+
* @since 3.17.0
|
|
499
|
+
*/
|
|
500
|
+
typeHierarchy?: TypeHierarchyClientCapabilities;
|
|
501
|
+
/**
|
|
502
|
+
* Capabilities specific to the `textDocument/inlineValue` request.
|
|
503
|
+
*
|
|
504
|
+
* @since 3.17.0
|
|
505
|
+
*/
|
|
506
|
+
inlineValue?: InlineValueClientCapabilities;
|
|
507
|
+
/**
|
|
508
|
+
* Capabilities specific to the `textDocument/inlayHint` request.
|
|
509
|
+
*
|
|
510
|
+
* @since 3.17.0
|
|
511
|
+
*/
|
|
512
|
+
inlayHint?: InlayHintClientCapabilities;
|
|
513
|
+
/**
|
|
514
|
+
* Capabilities specific to the diagnostic pull model.
|
|
515
|
+
*
|
|
516
|
+
* @since 3.17.0
|
|
517
|
+
*/
|
|
518
|
+
diagnostic?: DiagnosticClientCapabilities;
|
|
377
519
|
}
|
|
378
520
|
export interface WindowClientCapabilities {
|
|
379
521
|
/**
|
|
380
|
-
*
|
|
381
|
-
*
|
|
382
|
-
*
|
|
522
|
+
* It indicates whether the client supports server initiated
|
|
523
|
+
* progress using the `window/workDoneProgress/create` request.
|
|
524
|
+
*
|
|
525
|
+
* The capability also controls Whether client supports handling
|
|
526
|
+
* of progress notifications. If set servers are allowed to report a
|
|
527
|
+
* `workDoneProgress` property in the request specific server
|
|
528
|
+
* capabilities.
|
|
383
529
|
*
|
|
384
530
|
* @since 3.15.0
|
|
385
531
|
*/
|
|
@@ -426,7 +572,47 @@ export interface MarkdownClientCapabilities {
|
|
|
426
572
|
* The version of the parser.
|
|
427
573
|
*/
|
|
428
574
|
version?: string;
|
|
575
|
+
/**
|
|
576
|
+
* A list of HTML tags that the client allows / supports in
|
|
577
|
+
* Markdown.
|
|
578
|
+
*
|
|
579
|
+
* @since 3.17.0
|
|
580
|
+
*/
|
|
581
|
+
allowedTags?: string[];
|
|
429
582
|
}
|
|
583
|
+
/**
|
|
584
|
+
* A set of predefined position encoding kinds.
|
|
585
|
+
*
|
|
586
|
+
* @since 3.17.0
|
|
587
|
+
*/
|
|
588
|
+
export declare namespace PositionEncodingKind {
|
|
589
|
+
/**
|
|
590
|
+
* Character offsets count UTF-8 code units.
|
|
591
|
+
*/
|
|
592
|
+
const UTF8: PositionEncodingKind;
|
|
593
|
+
/**
|
|
594
|
+
* Character offsets count UTF-16 code units.
|
|
595
|
+
*
|
|
596
|
+
* This is the default and must always be supported
|
|
597
|
+
* by servers
|
|
598
|
+
*/
|
|
599
|
+
const UTF16: PositionEncodingKind;
|
|
600
|
+
/**
|
|
601
|
+
* Character offsets count UTF-32 code units.
|
|
602
|
+
*
|
|
603
|
+
* Implementation note: these are the same as Unicode code points,
|
|
604
|
+
* so this `PositionEncodingKind` may also be used for an
|
|
605
|
+
* encoding-agnostic representation of character offsets.
|
|
606
|
+
*/
|
|
607
|
+
const UTF32: PositionEncodingKind;
|
|
608
|
+
}
|
|
609
|
+
/**
|
|
610
|
+
* A type indicating how positions are encoded,
|
|
611
|
+
* specifically what column offsets mean.
|
|
612
|
+
*
|
|
613
|
+
* @since 3.17.0
|
|
614
|
+
*/
|
|
615
|
+
export declare type PositionEncodingKind = string;
|
|
430
616
|
/**
|
|
431
617
|
* General client capabilities.
|
|
432
618
|
*
|
|
@@ -449,7 +635,7 @@ export interface GeneralClientCapabilities {
|
|
|
449
635
|
/**
|
|
450
636
|
* The list of requests for which the client
|
|
451
637
|
* will retry the request if it receives a
|
|
452
|
-
* response with error code `ContentModified
|
|
638
|
+
* response with error code `ContentModified`
|
|
453
639
|
*/
|
|
454
640
|
retryOnContentModified: string[];
|
|
455
641
|
};
|
|
@@ -465,11 +651,45 @@ export interface GeneralClientCapabilities {
|
|
|
465
651
|
* @since 3.16.0
|
|
466
652
|
*/
|
|
467
653
|
markdown?: MarkdownClientCapabilities;
|
|
654
|
+
/**
|
|
655
|
+
* The position encodings supported by the client. Client and server
|
|
656
|
+
* have to agree on the same position encoding to ensure that offsets
|
|
657
|
+
* (e.g. character position in a line) are interpreted the same on both
|
|
658
|
+
* side.
|
|
659
|
+
*
|
|
660
|
+
* To keep the protocol backwards compatible the following applies: if
|
|
661
|
+
* the value 'utf-16' is missing from the array of position encodings
|
|
662
|
+
* servers can assume that the client supports UTF-16. UTF-16 is
|
|
663
|
+
* therefore a mandatory encoding.
|
|
664
|
+
*
|
|
665
|
+
* If omitted it defaults to ['utf-16'].
|
|
666
|
+
*
|
|
667
|
+
* Implementation considerations: since the conversion from one encoding
|
|
668
|
+
* into another requires the content of the file / line the conversion
|
|
669
|
+
* is best done where the file is read which is usually on the server
|
|
670
|
+
* side.
|
|
671
|
+
*
|
|
672
|
+
* @since 3.17.0
|
|
673
|
+
*/
|
|
674
|
+
positionEncodings?: PositionEncodingKind[];
|
|
675
|
+
}
|
|
676
|
+
/**
|
|
677
|
+
* Capabilities specific to the notebook document support.
|
|
678
|
+
*
|
|
679
|
+
* @since 3.17.0
|
|
680
|
+
*/
|
|
681
|
+
export interface NotebookDocumentClientCapabilities {
|
|
682
|
+
/**
|
|
683
|
+
* Capabilities specific to notebook document synchronization
|
|
684
|
+
*
|
|
685
|
+
* @since 3.17.0
|
|
686
|
+
*/
|
|
687
|
+
synchronization: NotebookDocumentSyncClientCapabilities;
|
|
468
688
|
}
|
|
469
689
|
/**
|
|
470
690
|
* Defines the capabilities provided by the client.
|
|
471
691
|
*/
|
|
472
|
-
export interface
|
|
692
|
+
export interface ClientCapabilities {
|
|
473
693
|
/**
|
|
474
694
|
* Workspace specific client capabilities.
|
|
475
695
|
*/
|
|
@@ -478,6 +698,12 @@ export interface _ClientCapabilities {
|
|
|
478
698
|
* Text document specific client capabilities.
|
|
479
699
|
*/
|
|
480
700
|
textDocument?: TextDocumentClientCapabilities;
|
|
701
|
+
/**
|
|
702
|
+
* Capabilities specific to the notebook document support.
|
|
703
|
+
*
|
|
704
|
+
* @since 3.17.0
|
|
705
|
+
*/
|
|
706
|
+
notebookDocument?: NotebookDocumentClientCapabilities;
|
|
481
707
|
/**
|
|
482
708
|
* Window specific client capabilities.
|
|
483
709
|
*/
|
|
@@ -493,7 +719,6 @@ export interface _ClientCapabilities {
|
|
|
493
719
|
*/
|
|
494
720
|
experimental?: object;
|
|
495
721
|
}
|
|
496
|
-
export declare type ClientCapabilities = _ClientCapabilities & WorkspaceFoldersClientCapabilities & ConfigurationClientCapabilities & WorkDoneProgressClientCapabilities;
|
|
497
722
|
/**
|
|
498
723
|
* Static registration options to be returned in the initialize
|
|
499
724
|
* request.
|
|
@@ -557,12 +782,33 @@ export declare namespace WorkDoneProgressOptions {
|
|
|
557
782
|
* Defines the capabilities provided by a language
|
|
558
783
|
* server.
|
|
559
784
|
*/
|
|
560
|
-
export interface
|
|
785
|
+
export interface ServerCapabilities<T = any> {
|
|
786
|
+
/**
|
|
787
|
+
* The position encoding the server picked from the encodings offered
|
|
788
|
+
* by the client via the client capability `general.positionEncodings`.
|
|
789
|
+
*
|
|
790
|
+
* If the client didn't provide any position encodings the only valid
|
|
791
|
+
* value that a server can return is 'utf-16'.
|
|
792
|
+
*
|
|
793
|
+
* If omitted it defaults to 'utf-16'.
|
|
794
|
+
*
|
|
795
|
+
* If for some reason
|
|
796
|
+
*
|
|
797
|
+
* @since 3.17.0
|
|
798
|
+
*/
|
|
799
|
+
positionEncoding?: PositionEncodingKind;
|
|
561
800
|
/**
|
|
562
|
-
* Defines how text documents are synced. Is either a detailed structure
|
|
563
|
-
* for backwards compatibility the
|
|
801
|
+
* Defines how text documents are synced. Is either a detailed structure
|
|
802
|
+
* defining each notification or for backwards compatibility the
|
|
803
|
+
* TextDocumentSyncKind number.
|
|
564
804
|
*/
|
|
565
805
|
textDocumentSync?: TextDocumentSyncOptions | TextDocumentSyncKind;
|
|
806
|
+
/**
|
|
807
|
+
* Defines how notebook documents are synced.
|
|
808
|
+
*
|
|
809
|
+
* @since 3.17.0
|
|
810
|
+
*/
|
|
811
|
+
notebookDocumentSync?: NotebookDocumentSyncOptions | NotebookDocumentSyncRegistrationOptions;
|
|
566
812
|
/**
|
|
567
813
|
* The server provides completion support.
|
|
568
814
|
*/
|
|
@@ -674,9 +920,45 @@ export interface _ServerCapabilities<T = any> {
|
|
|
674
920
|
*/
|
|
675
921
|
semanticTokensProvider?: SemanticTokensOptions | SemanticTokensRegistrationOptions;
|
|
676
922
|
/**
|
|
677
|
-
*
|
|
923
|
+
* The server provides moniker support.
|
|
924
|
+
*
|
|
925
|
+
* @since 3.16.0
|
|
926
|
+
*/
|
|
927
|
+
monikerProvider?: boolean | MonikerOptions | MonikerRegistrationOptions;
|
|
928
|
+
/**
|
|
929
|
+
* The server provides type hierarchy support.
|
|
930
|
+
*
|
|
931
|
+
* @since 3.17.0
|
|
932
|
+
*/
|
|
933
|
+
typeHierarchyProvider?: boolean | TypeHierarchyOptions | TypeHierarchyRegistrationOptions;
|
|
934
|
+
/**
|
|
935
|
+
* The server provides inline values.
|
|
936
|
+
*
|
|
937
|
+
* @since 3.17.0
|
|
938
|
+
*/
|
|
939
|
+
inlineValueProvider?: boolean | InlineValueOptions | InlineValueRegistrationOptions;
|
|
940
|
+
/**
|
|
941
|
+
* The server provides inlay hints.
|
|
942
|
+
*
|
|
943
|
+
* @since 3.17.0
|
|
944
|
+
*/
|
|
945
|
+
inlayHintProvider?: boolean | InlayHintOptions | InlayHintRegistrationOptions;
|
|
946
|
+
/**
|
|
947
|
+
* The server has support for pull model diagnostics.
|
|
948
|
+
*
|
|
949
|
+
* @since 3.17.0
|
|
950
|
+
*/
|
|
951
|
+
diagnosticProvider?: DiagnosticOptions | DiagnosticRegistrationOptions;
|
|
952
|
+
/**
|
|
953
|
+
* Workspace specific server capabilities.
|
|
678
954
|
*/
|
|
679
955
|
workspace?: {
|
|
956
|
+
/**
|
|
957
|
+
* The server supports workspace folder.
|
|
958
|
+
*
|
|
959
|
+
* @since 3.6.0
|
|
960
|
+
*/
|
|
961
|
+
workspaceFolders?: WorkspaceFoldersServerCapabilities;
|
|
680
962
|
/**
|
|
681
963
|
* The server is interested in notifications/requests for operations on files.
|
|
682
964
|
*
|
|
@@ -684,18 +966,11 @@ export interface _ServerCapabilities<T = any> {
|
|
|
684
966
|
*/
|
|
685
967
|
fileOperations?: FileOperationOptions;
|
|
686
968
|
};
|
|
687
|
-
/**
|
|
688
|
-
* The server provides moniker support.
|
|
689
|
-
*
|
|
690
|
-
* @since 3.16.0
|
|
691
|
-
*/
|
|
692
|
-
monikerProvider?: boolean | MonikerOptions | MonikerRegistrationOptions;
|
|
693
969
|
/**
|
|
694
970
|
* Experimental server capabilities.
|
|
695
971
|
*/
|
|
696
972
|
experimental?: T;
|
|
697
973
|
}
|
|
698
|
-
export declare type ServerCapabilities<T = any> = _ServerCapabilities<T> & WorkspaceFoldersServerCapabilities;
|
|
699
974
|
/**
|
|
700
975
|
* The initialize request is sent from the client to the server.
|
|
701
976
|
* It is sent once as the request after starting up the server.
|
|
@@ -704,7 +979,7 @@ export declare type ServerCapabilities<T = any> = _ServerCapabilities<T> & Works
|
|
|
704
979
|
* resolves to such.
|
|
705
980
|
*/
|
|
706
981
|
export declare namespace InitializeRequest {
|
|
707
|
-
const type: ProtocolRequestType<
|
|
982
|
+
const type: ProtocolRequestType<InitializeParams, InitializeResult<any>, never, InitializeError, void>;
|
|
708
983
|
}
|
|
709
984
|
/**
|
|
710
985
|
* The initialize parameters
|
|
@@ -763,11 +1038,11 @@ export interface _InitializeParams extends WorkDoneProgressParams {
|
|
|
763
1038
|
/**
|
|
764
1039
|
* User provided initialization options.
|
|
765
1040
|
*/
|
|
766
|
-
initializationOptions?:
|
|
1041
|
+
initializationOptions?: LSPAny;
|
|
767
1042
|
/**
|
|
768
1043
|
* The initial trace setting. If omitted trace is disabled ('off').
|
|
769
1044
|
*/
|
|
770
|
-
trace?: 'off' | 'messages' | 'verbose';
|
|
1045
|
+
trace?: 'off' | 'messages' | 'compact' | 'verbose';
|
|
771
1046
|
}
|
|
772
1047
|
export declare type InitializeParams = _InitializeParams & WorkspaceFoldersInitializeParams;
|
|
773
1048
|
/**
|
|
@@ -796,19 +1071,21 @@ export interface InitializeResult<T = any> {
|
|
|
796
1071
|
/**
|
|
797
1072
|
* Custom initialization results.
|
|
798
1073
|
*/
|
|
799
|
-
[custom: string]:
|
|
1074
|
+
[custom: string]: LSPAny | ServerCapabilities<T> | undefined; /** undefined is needed since serverInfo is optional */
|
|
800
1075
|
}
|
|
801
1076
|
/**
|
|
802
|
-
* Known error codes for an `
|
|
1077
|
+
* Known error codes for an `InitializeErrorCodes`;
|
|
803
1078
|
*/
|
|
804
|
-
export declare namespace
|
|
1079
|
+
export declare namespace InitializeErrorCodes {
|
|
805
1080
|
/**
|
|
806
1081
|
* If the protocol version provided by the client can't be handled by the server.
|
|
1082
|
+
*
|
|
807
1083
|
* @deprecated This initialize error got replaced by client capabilities. There is
|
|
808
1084
|
* no version handshake in version 3.0x
|
|
809
1085
|
*/
|
|
810
1086
|
const unknownProtocolVersion: 1;
|
|
811
1087
|
}
|
|
1088
|
+
export declare type InitializeErrorCodes = 1;
|
|
812
1089
|
/**
|
|
813
1090
|
* The data type of the ResponseError if the
|
|
814
1091
|
* initialize request fails.
|
|
@@ -872,7 +1149,7 @@ export interface DidChangeConfigurationParams {
|
|
|
872
1149
|
/**
|
|
873
1150
|
* The actual changed settings
|
|
874
1151
|
*/
|
|
875
|
-
settings:
|
|
1152
|
+
settings: LSPAny;
|
|
876
1153
|
}
|
|
877
1154
|
/**
|
|
878
1155
|
* The message type
|
|
@@ -1085,8 +1362,8 @@ export declare namespace DidOpenTextDocumentNotification {
|
|
|
1085
1362
|
const type: ProtocolNotificationType<DidOpenTextDocumentParams, TextDocumentRegistrationOptions>;
|
|
1086
1363
|
}
|
|
1087
1364
|
/**
|
|
1088
|
-
* An event describing a change to a text document. If
|
|
1089
|
-
*
|
|
1365
|
+
* An event describing a change to a text document. If only a text is provided
|
|
1366
|
+
* it is considered to be the full content of the document.
|
|
1090
1367
|
*/
|
|
1091
1368
|
export declare type TextDocumentContentChangeEvent = {
|
|
1092
1369
|
/**
|
|
@@ -1275,6 +1552,13 @@ export interface DidChangeWatchedFilesClientCapabilities {
|
|
|
1275
1552
|
* from the server side.
|
|
1276
1553
|
*/
|
|
1277
1554
|
dynamicRegistration?: boolean;
|
|
1555
|
+
/**
|
|
1556
|
+
* Whether the client has support for {@link RelativePattern relative pattern}
|
|
1557
|
+
* or not.
|
|
1558
|
+
*
|
|
1559
|
+
* @since 3.17.0
|
|
1560
|
+
*/
|
|
1561
|
+
relativePatternSupport?: boolean;
|
|
1278
1562
|
}
|
|
1279
1563
|
/**
|
|
1280
1564
|
* The watched files notification is sent from the client to the server when
|
|
@@ -1332,38 +1616,74 @@ export interface DidChangeWatchedFilesRegistrationOptions {
|
|
|
1332
1616
|
*/
|
|
1333
1617
|
watchers: FileSystemWatcher[];
|
|
1334
1618
|
}
|
|
1619
|
+
/**
|
|
1620
|
+
* The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
|
|
1621
|
+
* - `*` to match one or more characters in a path segment
|
|
1622
|
+
* - `?` to match on one character in a path segment
|
|
1623
|
+
* - `**` to match any number of path segments, including none
|
|
1624
|
+
* - `{}` to group conditions (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
|
|
1625
|
+
* - `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
|
|
1626
|
+
* - `[!...]` 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`)
|
|
1627
|
+
*
|
|
1628
|
+
* @since 3.17.0
|
|
1629
|
+
*/
|
|
1630
|
+
export declare type Pattern = string;
|
|
1631
|
+
/**
|
|
1632
|
+
* A relative pattern is a helper to construct glob patterns that are matched
|
|
1633
|
+
* relatively to a base URI. The common value for a `baseUri` is a workspace
|
|
1634
|
+
* folder root, but it can be another absolute URI as well.
|
|
1635
|
+
*
|
|
1636
|
+
* @since 3.17.0
|
|
1637
|
+
*/
|
|
1638
|
+
export interface RelativePattern {
|
|
1639
|
+
/**
|
|
1640
|
+
* A workspace folder or a base URI to which this pattern will be matched
|
|
1641
|
+
* against relatively.
|
|
1642
|
+
*/
|
|
1643
|
+
baseUri: WorkspaceFolder | URI;
|
|
1644
|
+
/**
|
|
1645
|
+
* The actual glob pattern;
|
|
1646
|
+
*/
|
|
1647
|
+
pattern: Pattern;
|
|
1648
|
+
}
|
|
1649
|
+
export declare namespace RelativePattern {
|
|
1650
|
+
function is(value: any): value is RelativePattern;
|
|
1651
|
+
}
|
|
1652
|
+
/**
|
|
1653
|
+
* The glob pattern. Either a string pattern or a relative pattern.
|
|
1654
|
+
*
|
|
1655
|
+
* @since 3.17.0
|
|
1656
|
+
*/
|
|
1657
|
+
export declare type GlobPattern = Pattern | RelativePattern;
|
|
1335
1658
|
export interface FileSystemWatcher {
|
|
1336
1659
|
/**
|
|
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`)
|
|
1660
|
+
* The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.
|
|
1661
|
+
*
|
|
1662
|
+
* @since 3.17.0 support for relative patterns.
|
|
1344
1663
|
*/
|
|
1345
|
-
globPattern:
|
|
1664
|
+
globPattern: GlobPattern;
|
|
1346
1665
|
/**
|
|
1347
1666
|
* The kind of events of interest. If omitted it defaults
|
|
1348
1667
|
* to WatchKind.Create | WatchKind.Change | WatchKind.Delete
|
|
1349
1668
|
* which is 7.
|
|
1350
1669
|
*/
|
|
1351
|
-
kind?:
|
|
1670
|
+
kind?: WatchKind;
|
|
1352
1671
|
}
|
|
1353
1672
|
export declare namespace WatchKind {
|
|
1354
1673
|
/**
|
|
1355
1674
|
* Interested in create events.
|
|
1356
1675
|
*/
|
|
1357
|
-
const Create
|
|
1676
|
+
const Create: 1;
|
|
1358
1677
|
/**
|
|
1359
1678
|
* Interested in change events
|
|
1360
1679
|
*/
|
|
1361
|
-
const Change
|
|
1680
|
+
const Change: 2;
|
|
1362
1681
|
/**
|
|
1363
1682
|
* Interested in delete events
|
|
1364
1683
|
*/
|
|
1365
|
-
const Delete
|
|
1684
|
+
const Delete: 4;
|
|
1366
1685
|
}
|
|
1686
|
+
export declare type WatchKind = uinteger;
|
|
1367
1687
|
/**
|
|
1368
1688
|
* The publish diagnostic client capabilities.
|
|
1369
1689
|
*/
|
|
@@ -1471,9 +1791,6 @@ export interface CompletionClientCapabilities {
|
|
|
1471
1791
|
* Client supports the preselect property on a completion item.
|
|
1472
1792
|
*/
|
|
1473
1793
|
preselectSupport?: boolean;
|
|
1474
|
-
/**
|
|
1475
|
-
* Client supports to kee
|
|
1476
|
-
*/
|
|
1477
1794
|
/**
|
|
1478
1795
|
* Client supports the tag property on a completion item. Clients supporting
|
|
1479
1796
|
* tags have to handle unknown tags gracefully. Clients especially need to
|
|
@@ -1522,7 +1839,7 @@ export interface CompletionClientCapabilities {
|
|
|
1522
1839
|
* The client has support for completion item label
|
|
1523
1840
|
* details (see also `CompletionItemLabelDetails`).
|
|
1524
1841
|
*
|
|
1525
|
-
* @since 3.17.0
|
|
1842
|
+
* @since 3.17.0
|
|
1526
1843
|
*/
|
|
1527
1844
|
labelDetailsSupport?: boolean;
|
|
1528
1845
|
};
|
|
@@ -1552,6 +1869,25 @@ export interface CompletionClientCapabilities {
|
|
|
1552
1869
|
* `textDocument/completion` request.
|
|
1553
1870
|
*/
|
|
1554
1871
|
contextSupport?: boolean;
|
|
1872
|
+
/**
|
|
1873
|
+
* The client supports the following `CompletionList` specific
|
|
1874
|
+
* capabilities.
|
|
1875
|
+
*
|
|
1876
|
+
* @since 3.17.0
|
|
1877
|
+
*/
|
|
1878
|
+
completionList?: {
|
|
1879
|
+
/**
|
|
1880
|
+
* The client supports the the following itemDefaults on
|
|
1881
|
+
* a completion list.
|
|
1882
|
+
*
|
|
1883
|
+
* The value lists the supported property names of the
|
|
1884
|
+
* `CompletionList.itemDefaults` object. If omitted
|
|
1885
|
+
* no properties are supported.
|
|
1886
|
+
*
|
|
1887
|
+
* @since 3.17.0
|
|
1888
|
+
*/
|
|
1889
|
+
itemDefaults?: string[];
|
|
1890
|
+
};
|
|
1555
1891
|
}
|
|
1556
1892
|
/**
|
|
1557
1893
|
* How a completion was triggered
|
|
@@ -1632,7 +1968,7 @@ export interface CompletionOptions extends WorkDoneProgressOptions {
|
|
|
1632
1968
|
* The server supports the following `CompletionItem` specific
|
|
1633
1969
|
* capabilities.
|
|
1634
1970
|
*
|
|
1635
|
-
* @since 3.17.0
|
|
1971
|
+
* @since 3.17.0
|
|
1636
1972
|
*/
|
|
1637
1973
|
completionItem?: {
|
|
1638
1974
|
/**
|
|
@@ -1640,7 +1976,7 @@ export interface CompletionOptions extends WorkDoneProgressOptions {
|
|
|
1640
1976
|
* details (see also `CompletionItemLabelDetails`) when
|
|
1641
1977
|
* receiving a completion item in a resolve call.
|
|
1642
1978
|
*
|
|
1643
|
-
* @since 3.17.0
|
|
1979
|
+
* @since 3.17.0
|
|
1644
1980
|
*/
|
|
1645
1981
|
labelDetailsSupport?: boolean;
|
|
1646
1982
|
};
|
|
@@ -2208,6 +2544,20 @@ export interface WorkspaceSymbolClientCapabilities {
|
|
|
2208
2544
|
*/
|
|
2209
2545
|
valueSet: SymbolTag[];
|
|
2210
2546
|
};
|
|
2547
|
+
/**
|
|
2548
|
+
* The client support partial workspace symbols. The client will send the
|
|
2549
|
+
* request `workspaceSymbol/resolve` to the server to resolve additional
|
|
2550
|
+
* properties.
|
|
2551
|
+
*
|
|
2552
|
+
* @since 3.17.0
|
|
2553
|
+
*/
|
|
2554
|
+
resolveSupport?: {
|
|
2555
|
+
/**
|
|
2556
|
+
* The properties that a client can resolve lazily. Usually
|
|
2557
|
+
* `location.range`
|
|
2558
|
+
*/
|
|
2559
|
+
properties: string[];
|
|
2560
|
+
};
|
|
2211
2561
|
}
|
|
2212
2562
|
/**
|
|
2213
2563
|
* The parameters of a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
|
|
@@ -2223,6 +2573,13 @@ export interface WorkspaceSymbolParams extends WorkDoneProgressParams, PartialRe
|
|
|
2223
2573
|
* Server capabilities for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
|
|
2224
2574
|
*/
|
|
2225
2575
|
export interface WorkspaceSymbolOptions extends WorkDoneProgressOptions {
|
|
2576
|
+
/**
|
|
2577
|
+
* The server provides support to resolve additional
|
|
2578
|
+
* information for a workspace symbol.
|
|
2579
|
+
*
|
|
2580
|
+
* @since 3.17.0
|
|
2581
|
+
*/
|
|
2582
|
+
resolveProvider?: boolean;
|
|
2226
2583
|
}
|
|
2227
2584
|
/**
|
|
2228
2585
|
* Registration options for a [WorkspaceSymbolRequest](#WorkspaceSymbolRequest).
|
|
@@ -2234,10 +2591,25 @@ export interface WorkspaceSymbolRegistrationOptions extends WorkspaceSymbolOptio
|
|
|
2234
2591
|
* by the [WorkspaceSymbolParams](#WorkspaceSymbolParams). The response is
|
|
2235
2592
|
* of type [SymbolInformation[]](#SymbolInformation) or a Thenable that
|
|
2236
2593
|
* resolves to such.
|
|
2594
|
+
*
|
|
2595
|
+
* @since 3.17.0 - support for WorkspaceSymbol in the returned data. Clients
|
|
2596
|
+
* need to advertise support for WorkspaceSymbols via the client capability
|
|
2597
|
+
* `workspace.symbol.resolveSupport`.
|
|
2598
|
+
*
|
|
2237
2599
|
*/
|
|
2238
2600
|
export declare namespace WorkspaceSymbolRequest {
|
|
2239
2601
|
const method: 'workspace/symbol';
|
|
2240
|
-
const type: ProtocolRequestType<WorkspaceSymbolParams, SymbolInformation[] | null, SymbolInformation[], void, WorkspaceSymbolRegistrationOptions>;
|
|
2602
|
+
const type: ProtocolRequestType<WorkspaceSymbolParams, SymbolInformation[] | WorkspaceSymbol[] | null, SymbolInformation[] | WorkspaceSymbol[], void, WorkspaceSymbolRegistrationOptions>;
|
|
2603
|
+
}
|
|
2604
|
+
/**
|
|
2605
|
+
* A request to resolve the range inside the workspace
|
|
2606
|
+
* symbol's location.
|
|
2607
|
+
*
|
|
2608
|
+
* @since 3.17.0
|
|
2609
|
+
*/
|
|
2610
|
+
export declare namespace WorkspaceSymbolResolveRequest {
|
|
2611
|
+
const method: 'workspaceSymbol/resolve';
|
|
2612
|
+
const type: ProtocolRequestType<WorkspaceSymbol, WorkspaceSymbol, never, void, void>;
|
|
2241
2613
|
}
|
|
2242
2614
|
/**
|
|
2243
2615
|
* The client capabilities of a [CodeLensRequest](#CodeLensRequest).
|
|
@@ -2463,11 +2835,16 @@ export interface DocumentOnTypeFormattingParams {
|
|
|
2463
2835
|
*/
|
|
2464
2836
|
textDocument: TextDocumentIdentifier;
|
|
2465
2837
|
/**
|
|
2466
|
-
* The position
|
|
2838
|
+
* The position around which the on type formatting should happen.
|
|
2839
|
+
* This is not necessarily the exact position where the character denoted
|
|
2840
|
+
* by the property `ch` got typed.
|
|
2467
2841
|
*/
|
|
2468
2842
|
position: Position;
|
|
2469
2843
|
/**
|
|
2470
|
-
* The character that has been typed
|
|
2844
|
+
* The character that has been typed that triggered the formatting
|
|
2845
|
+
* on type request. That is not necessarily the last character that
|
|
2846
|
+
* got inserted into the document since the client could auto insert
|
|
2847
|
+
* characters as well (e.g. like automatic brace completion).
|
|
2471
2848
|
*/
|
|
2472
2849
|
ch: string;
|
|
2473
2850
|
/**
|
|
@@ -2480,7 +2857,7 @@ export interface DocumentOnTypeFormattingParams {
|
|
|
2480
2857
|
*/
|
|
2481
2858
|
export interface DocumentOnTypeFormattingOptions {
|
|
2482
2859
|
/**
|
|
2483
|
-
* A character on which formatting should be triggered, like `}`.
|
|
2860
|
+
* A character on which formatting should be triggered, like `{}`.
|
|
2484
2861
|
*/
|
|
2485
2862
|
firstTriggerCharacter: string;
|
|
2486
2863
|
/**
|
|
@@ -2584,6 +2961,12 @@ export declare namespace RenameRequest {
|
|
|
2584
2961
|
}
|
|
2585
2962
|
export interface PrepareRenameParams extends TextDocumentPositionParams, WorkDoneProgressParams {
|
|
2586
2963
|
}
|
|
2964
|
+
export declare type PrepareRenameResult = Range | {
|
|
2965
|
+
range: Range;
|
|
2966
|
+
placeholder: string;
|
|
2967
|
+
} | {
|
|
2968
|
+
defaultBehavior: boolean;
|
|
2969
|
+
};
|
|
2587
2970
|
/**
|
|
2588
2971
|
* A request to test and perform the setup necessary for a rename.
|
|
2589
2972
|
*
|
|
@@ -2591,12 +2974,7 @@ export interface PrepareRenameParams extends TextDocumentPositionParams, WorkDon
|
|
|
2591
2974
|
*/
|
|
2592
2975
|
export declare namespace PrepareRenameRequest {
|
|
2593
2976
|
const method: 'textDocument/prepareRename';
|
|
2594
|
-
const type: ProtocolRequestType<PrepareRenameParams,
|
|
2595
|
-
range: Range;
|
|
2596
|
-
placeholder: string;
|
|
2597
|
-
} | {
|
|
2598
|
-
defaultBehavior: boolean;
|
|
2599
|
-
} | null, never, void, void>;
|
|
2977
|
+
const type: ProtocolRequestType<PrepareRenameParams, PrepareRenameResult | null, never, void, void>;
|
|
2600
2978
|
}
|
|
2601
2979
|
/**
|
|
2602
2980
|
* The client capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
|
|
@@ -2618,7 +2996,7 @@ export interface ExecuteCommandParams extends WorkDoneProgressParams {
|
|
|
2618
2996
|
/**
|
|
2619
2997
|
* Arguments that the command should be invoked with.
|
|
2620
2998
|
*/
|
|
2621
|
-
arguments?:
|
|
2999
|
+
arguments?: LSPAny[];
|
|
2622
3000
|
}
|
|
2623
3001
|
/**
|
|
2624
3002
|
* The server capabilities of a [ExecuteCommandRequest](#ExecuteCommandRequest).
|
|
@@ -2701,9 +3079,11 @@ export interface ApplyWorkspaceEditParams {
|
|
|
2701
3079
|
edit: WorkspaceEdit;
|
|
2702
3080
|
}
|
|
2703
3081
|
/**
|
|
2704
|
-
*
|
|
3082
|
+
* The result returned from the apply workspace edit request.
|
|
3083
|
+
*
|
|
3084
|
+
* @since 3.17 renamed from ApplyWorkspaceEditResponse
|
|
2705
3085
|
*/
|
|
2706
|
-
export interface
|
|
3086
|
+
export interface ApplyWorkspaceEditResult {
|
|
2707
3087
|
/**
|
|
2708
3088
|
* Indicates whether the edit was applied or not.
|
|
2709
3089
|
*/
|
|
@@ -2721,11 +3101,15 @@ export interface ApplyWorkspaceEditResponse {
|
|
|
2721
3101
|
*/
|
|
2722
3102
|
failedChange?: uinteger;
|
|
2723
3103
|
}
|
|
3104
|
+
/**
|
|
3105
|
+
* @deprecated Use ApplyWorkspaceEditResult instead.
|
|
3106
|
+
*/
|
|
3107
|
+
export declare type ApplyWorkspaceEditResponse = ApplyWorkspaceEditResult;
|
|
2724
3108
|
/**
|
|
2725
3109
|
* A request sent from the server to the client to modified certain resources.
|
|
2726
3110
|
*/
|
|
2727
3111
|
export declare namespace ApplyWorkspaceEditRequest {
|
|
2728
|
-
const type: ProtocolRequestType<ApplyWorkspaceEditParams,
|
|
3112
|
+
const type: ProtocolRequestType<ApplyWorkspaceEditParams, ApplyWorkspaceEditResult, never, void, void>;
|
|
2729
3113
|
}
|
|
2730
|
-
export { ImplementationRequest, ImplementationParams, ImplementationRegistrationOptions, ImplementationOptions, TypeDefinitionRequest, TypeDefinitionParams, TypeDefinitionRegistrationOptions, TypeDefinitionOptions, WorkspaceFoldersRequest, DidChangeWorkspaceFoldersNotification, DidChangeWorkspaceFoldersParams,
|
|
3114
|
+
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
3115
|
export { DocumentColorOptions as ColorProviderOptions, DocumentColorOptions as ColorOptions, FoldingRangeOptions as FoldingRangeProviderOptions, SelectionRangeOptions as SelectionRangeProviderOptions, DocumentColorRegistrationOptions as ColorRegistrationOptions };
|