File tree 2 files changed +29
-1
lines changed
2 files changed +29
-1
lines changed Original file line number Diff line number Diff line change @@ -561,7 +561,7 @@ export class LanguageClientManager {
561
561
} ,
562
562
errorHandler : new SourceKitLSPErrorHandler ( 5 ) ,
563
563
initializationOptions : {
564
- peekDocuments : true ,
564
+ peekDocuments : true , // client capability to handle `PeekDocumentsRequest`
565
565
} ,
566
566
} ;
567
567
Original file line number Diff line number Diff line change @@ -18,17 +18,45 @@ import { Position, Uri } from "vscode";
18
18
19
19
// Definitions for non-standard requests used by sourcekit-lsp
20
20
21
+ // Peek Documents
21
22
export interface PeekDocumentsParams {
23
+ /**
24
+ * The `Uri` of the text document in which to show the "peeked" editor
25
+ * (default: current document in the active editor)
26
+ */
22
27
uri ?: Uri ;
28
+
29
+ /**
30
+ * The position in the given text document in which to show the
31
+ * "peeked editor" (default: current cursor position in the active editor)
32
+ */
23
33
position ?: Position ;
34
+
35
+ /**
36
+ * An array `Uri` of the documents to appear inside the "peeked" editor
37
+ */
24
38
locations : Uri [ ] ;
39
+
40
+ /**
41
+ * Presentation strategy when having multiple locations (default: "peek")
42
+ */
25
43
multiple : string ;
26
44
}
27
45
46
+ /**
47
+ * Response to indicate the `success` of the `PeekDocumentsRequest`
48
+ */
28
49
export interface PeekDocumentsResult {
29
50
success : boolean ;
30
51
}
31
52
53
+ /**
54
+ * Request from the server to the client to show the given documents in a "peeked" editor.
55
+ *
56
+ * This request is handled by the client to show the given documents in a "peeked" editor (i.e. inline with / inside the editor canvas).
57
+ *
58
+ * It requires the experimental client capability `"peekDocuments"` to use.
59
+ */
32
60
export const PeekDocumentsRequest = new langclient . RequestType <
33
61
PeekDocumentsParams ,
34
62
PeekDocumentsResult ,
You can’t perform that action at this time.
0 commit comments