1syntax = "proto3";
2package zed.messages;
3
4import "core.proto";
5import "worktree.proto";
6import "buffer.proto";
7
8message GetDefinition {
9 uint64 project_id = 1;
10 uint64 buffer_id = 2;
11 Anchor position = 3;
12 repeated VectorClockEntry version = 4;
13}
14
15message GetDefinitionResponse {
16 repeated LocationLink links = 1;
17}
18
19message GetDeclaration {
20 uint64 project_id = 1;
21 uint64 buffer_id = 2;
22 Anchor position = 3;
23 repeated VectorClockEntry version = 4;
24}
25
26message GetDeclarationResponse {
27 repeated LocationLink links = 1;
28}
29
30message GetTypeDefinition {
31 uint64 project_id = 1;
32 uint64 buffer_id = 2;
33 Anchor position = 3;
34 repeated VectorClockEntry version = 4;
35 }
36
37message GetTypeDefinitionResponse {
38 repeated LocationLink links = 1;
39}
40message GetImplementation {
41 uint64 project_id = 1;
42 uint64 buffer_id = 2;
43 Anchor position = 3;
44 repeated VectorClockEntry version = 4;
45 }
46
47message GetImplementationResponse {
48 repeated LocationLink links = 1;
49}
50
51message GetReferences {
52 uint64 project_id = 1;
53 uint64 buffer_id = 2;
54 Anchor position = 3;
55 repeated VectorClockEntry version = 4;
56 }
57
58message GetReferencesResponse {
59 repeated Location locations = 1;
60}
61
62message GetDocumentHighlights {
63 uint64 project_id = 1;
64 uint64 buffer_id = 2;
65 Anchor position = 3;
66 repeated VectorClockEntry version = 4;
67 }
68
69message GetDocumentHighlightsResponse {
70 repeated DocumentHighlight highlights = 1;
71}
72
73message LocationLink {
74 optional Location origin = 1;
75 Location target = 2;
76}
77
78message DocumentHighlight {
79 Kind kind = 1;
80 Anchor start = 2;
81 Anchor end = 3;
82
83 enum Kind {
84 Text = 0;
85 Read = 1;
86 Write = 2;
87 }
88}
89
90message GetProjectSymbols {
91 uint64 project_id = 1;
92 string query = 2;
93}
94
95message GetProjectSymbolsResponse {
96 repeated Symbol symbols = 4;
97}
98
99message Symbol {
100 uint64 source_worktree_id = 1;
101 uint64 worktree_id = 2;
102 string language_server_name = 3;
103 string name = 4;
104 int32 kind = 5;
105 string path = 6;
106 // Cannot use generate anchors for unopened files,
107 // so we are forced to use point coords instead
108 PointUtf16 start = 7;
109 PointUtf16 end = 8;
110 bytes signature = 9;
111 uint64 language_server_id = 10;
112}
113
114message GetDocumentSymbols {
115 uint64 project_id = 1;
116 uint64 buffer_id = 2;
117 repeated VectorClockEntry version = 3;
118}
119
120message GetDocumentSymbolsResponse {
121 repeated DocumentSymbol symbols = 1;
122}
123
124message DocumentSymbol {
125 string name = 1;
126 int32 kind = 2;
127 // Cannot use generate anchors for unopened files,
128 // so we are forced to use point coords instead
129 PointUtf16 start = 3;
130 PointUtf16 end = 4;
131 PointUtf16 selection_start = 5;
132 PointUtf16 selection_end = 6;
133 repeated DocumentSymbol children = 7;
134}
135
136message InlayHints {
137 uint64 project_id = 1;
138 uint64 buffer_id = 2;
139 Anchor start = 3;
140 Anchor end = 4;
141 repeated VectorClockEntry version = 5;
142}
143
144message InlayHintsResponse {
145 repeated InlayHint hints = 1;
146 repeated VectorClockEntry version = 2;
147}
148
149message PointUtf16 {
150 uint32 row = 1;
151 uint32 column = 2;
152}
153
154message LspExtExpandMacro {
155 uint64 project_id = 1;
156 uint64 buffer_id = 2;
157 Anchor position = 3;
158}
159
160message LspExtExpandMacroResponse {
161 string name = 1;
162 string expansion = 2;
163}
164
165message LspExtOpenDocs {
166 uint64 project_id = 1;
167 uint64 buffer_id = 2;
168 Anchor position = 3;
169}
170
171message LspExtOpenDocsResponse {
172 optional string web = 1;
173 optional string local = 2;
174}
175
176message LspExtSwitchSourceHeader {
177 uint64 project_id = 1;
178 uint64 buffer_id = 2;
179}
180
181message LspExtSwitchSourceHeaderResponse {
182 string target_file = 1;
183}
184
185message LspExtGoToParentModule {
186 uint64 project_id = 1;
187 uint64 buffer_id = 2;
188 Anchor position = 3;
189}
190
191message LspExtGoToParentModuleResponse {
192 repeated LocationLink links = 1;
193}
194
195message GetCompletionsResponse {
196 repeated Completion completions = 1;
197 repeated VectorClockEntry version = 2;
198 // `!is_complete`, inverted for a default of `is_complete = true`
199 bool can_reuse = 3;
200}
201
202message ApplyCompletionAdditionalEdits {
203 uint64 project_id = 1;
204 uint64 buffer_id = 2;
205 Completion completion = 3;
206}
207
208message ApplyCompletionAdditionalEditsResponse {
209 Transaction transaction = 1;
210}
211
212message Completion {
213 Anchor old_replace_start = 1;
214 Anchor old_replace_end = 2;
215 string new_text = 3;
216 uint64 server_id = 4;
217 bytes lsp_completion = 5;
218 bool resolved = 6;
219 Source source = 7;
220 optional bytes lsp_defaults = 8;
221 optional Anchor buffer_word_start = 9;
222 optional Anchor buffer_word_end = 10;
223 Anchor old_insert_start = 11;
224 Anchor old_insert_end = 12;
225 optional string sort_text = 13;
226
227 enum Source {
228 Lsp = 0;
229 Custom = 1;
230 BufferWord = 2;
231 Dap = 3;
232 }
233}
234
235message GetCodeActions {
236 uint64 project_id = 1;
237 uint64 buffer_id = 2;
238 Anchor start = 3;
239 Anchor end = 4;
240 repeated VectorClockEntry version = 5;
241}
242
243message GetCodeActionsResponse {
244 repeated CodeAction actions = 1;
245 repeated VectorClockEntry version = 2;
246}
247
248message GetSignatureHelp {
249 uint64 project_id = 1;
250 uint64 buffer_id = 2;
251 Anchor position = 3;
252 repeated VectorClockEntry version = 4;
253}
254
255message GetSignatureHelpResponse {
256 optional SignatureHelp signature_help = 1;
257}
258
259message SignatureHelp {
260 repeated SignatureInformation signatures = 1;
261 optional uint32 active_signature = 2;
262 optional uint32 active_parameter = 3;
263}
264
265message SignatureInformation {
266 string label = 1;
267 optional Documentation documentation = 2;
268 repeated ParameterInformation parameters = 3;
269 optional uint32 active_parameter = 4;
270}
271
272message Documentation {
273 oneof content {
274 string value = 1;
275 MarkupContent markup_content = 2;
276 }
277}
278
279enum MarkupKind {
280 PlainText = 0;
281 Markdown = 1;
282}
283
284message ParameterInformation {
285 oneof label {
286 string simple = 1;
287 LabelOffsets label_offsets = 2;
288 }
289 optional Documentation documentation = 3;
290}
291
292message LabelOffsets {
293 uint32 start = 1;
294 uint32 end = 2;
295}
296
297message GetHover {
298 uint64 project_id = 1;
299 uint64 buffer_id = 2;
300 Anchor position = 3;
301 repeated VectorClockEntry version = 5;
302}
303
304message GetHoverResponse {
305 optional Anchor start = 1;
306 optional Anchor end = 2;
307 repeated HoverBlock contents = 3;
308}
309
310message HoverBlock {
311 string text = 1;
312 optional string language = 2;
313 bool is_markdown = 3;
314}
315
316message ApplyCodeAction {
317 uint64 project_id = 1;
318 uint64 buffer_id = 2;
319 CodeAction action = 3;
320}
321
322message ApplyCodeActionResponse {
323 ProjectTransaction transaction = 1;
324}
325
326message PrepareRename {
327 uint64 project_id = 1;
328 uint64 buffer_id = 2;
329 Anchor position = 3;
330 repeated VectorClockEntry version = 4;
331}
332
333message PrepareRenameResponse {
334 bool can_rename = 1;
335 Anchor start = 2;
336 Anchor end = 3;
337 repeated VectorClockEntry version = 4;
338 bool only_unprepared_rename_supported = 5;
339}
340
341message PerformRename {
342 uint64 project_id = 1;
343 uint64 buffer_id = 2;
344 Anchor position = 3;
345 string new_name = 4;
346 repeated VectorClockEntry version = 5;
347}
348
349message OnTypeFormatting {
350 uint64 project_id = 1;
351 uint64 buffer_id = 2;
352 Anchor position = 3;
353 string trigger = 4;
354 repeated VectorClockEntry version = 5;
355}
356
357message OnTypeFormattingResponse {
358 Transaction transaction = 1;
359}
360
361
362message LinkedEditingRange {
363 uint64 project_id = 1;
364 uint64 buffer_id = 2;
365 Anchor position = 3;
366 repeated VectorClockEntry version = 4;
367}
368
369message LinkedEditingRangeResponse {
370 repeated AnchorRange items = 1;
371 repeated VectorClockEntry version = 4;
372}
373
374message InlayHint {
375 Anchor position = 1;
376 InlayHintLabel label = 2;
377 optional string kind = 3;
378 bool padding_left = 4;
379 bool padding_right = 5;
380 InlayHintTooltip tooltip = 6;
381 ResolveState resolve_state = 7;
382}
383
384message InlayHintLabel {
385 oneof label {
386 string value = 1;
387 InlayHintLabelParts label_parts = 2;
388 }
389}
390
391message InlayHintLabelParts {
392 repeated InlayHintLabelPart parts = 1;
393}
394
395message InlayHintLabelPart {
396 string value = 1;
397 InlayHintLabelPartTooltip tooltip = 2;
398 optional string location_url = 3;
399 PointUtf16 location_range_start = 4;
400 PointUtf16 location_range_end = 5;
401 optional uint64 language_server_id = 6;
402}
403
404message InlayHintTooltip {
405 oneof content {
406 string value = 1;
407 MarkupContent markup_content = 2;
408 }
409}
410
411message InlayHintLabelPartTooltip {
412 oneof content {
413 string value = 1;
414 MarkupContent markup_content = 2;
415 }
416}
417
418message ResolveState {
419 State state = 1;
420 LspResolveState lsp_resolve_state = 2;
421
422 enum State {
423 Resolved = 0;
424 CanResolve = 1;
425 Resolving = 2;
426 }
427
428 message LspResolveState {
429 optional string value = 1;
430 uint64 server_id = 2;
431 }
432}
433
434// This type is used to resolve more than just
435// the documentation, but for backwards-compatibility
436// reasons we can't rename the type.
437message ResolveCompletionDocumentation {
438 uint64 project_id = 1;
439 uint64 language_server_id = 2;
440 bytes lsp_completion = 3;
441 uint64 buffer_id = 4;
442}
443
444message ResolveCompletionDocumentationResponse {
445 string documentation = 1;
446 bool documentation_is_markdown = 2;
447 Anchor old_replace_start = 3;
448 Anchor old_replace_end = 4;
449 string new_text = 5;
450 bytes lsp_completion = 6;
451 Anchor old_insert_start = 7;
452 Anchor old_insert_end = 8;
453}
454
455message ResolveInlayHint {
456 uint64 project_id = 1;
457 uint64 buffer_id = 2;
458 uint64 language_server_id = 3;
459 InlayHint hint = 4;
460}
461
462message ResolveInlayHintResponse {
463 InlayHint hint = 1;
464}
465
466message RefreshInlayHints {
467 uint64 project_id = 1;
468 uint64 server_id = 2;
469}
470
471message CodeLens {
472 bytes lsp_lens = 1;
473}
474
475message GetCodeLens {
476 uint64 project_id = 1;
477 uint64 buffer_id = 2;
478 repeated VectorClockEntry version = 3;
479}
480
481message GetCodeLensResponse {
482 repeated CodeAction lens_actions = 1;
483 repeated VectorClockEntry version = 2;
484}
485
486message RefreshCodeLens {
487 uint64 project_id = 1;
488}
489
490message MarkupContent {
491 bool is_markdown = 1;
492 string value = 2;
493}
494
495message PerformRenameResponse {
496 ProjectTransaction transaction = 2;
497}
498
499message CodeAction {
500 uint64 server_id = 1;
501 Anchor start = 2;
502 Anchor end = 3;
503 bytes lsp_action = 4;
504 Kind kind = 5;
505 bool resolved = 6;
506 enum Kind {
507 Action = 0;
508 Command = 1;
509 CodeLens = 2;
510 }
511}
512
513message LanguageServer {
514 uint64 id = 1;
515 string name = 2;
516 optional uint64 worktree_id = 3;
517}
518
519message StartLanguageServer {
520 uint64 project_id = 1;
521 LanguageServer server = 2;
522 string capabilities = 3;
523}
524
525message UpdateDiagnosticSummary {
526 uint64 project_id = 1;
527 uint64 worktree_id = 2;
528 DiagnosticSummary summary = 3;
529 repeated DiagnosticSummary more_summaries = 4;
530}
531
532message DiagnosticSummary {
533 string path = 1;
534 uint64 language_server_id = 2;
535 uint32 error_count = 3;
536 uint32 warning_count = 4;
537}
538
539message UpdateLanguageServer {
540 uint64 project_id = 1;
541 uint64 language_server_id = 2;
542 optional string server_name = 8;
543 oneof variant {
544 LspWorkStart work_start = 3;
545 LspWorkProgress work_progress = 4;
546 LspWorkEnd work_end = 5;
547 LspDiskBasedDiagnosticsUpdating disk_based_diagnostics_updating = 6;
548 LspDiskBasedDiagnosticsUpdated disk_based_diagnostics_updated = 7;
549 StatusUpdate status_update = 9;
550 RegisteredForBuffer registered_for_buffer = 10;
551 ServerMetadataUpdated metadata_updated = 11;
552 }
553}
554
555message ProgressToken {
556 oneof value {
557 int32 number = 1;
558 string string = 2;
559 }
560}
561
562message LspWorkStart {
563 reserved 1;
564 optional string title = 4;
565 optional string message = 2;
566 optional uint32 percentage = 3;
567 optional bool is_cancellable = 5;
568 ProgressToken token = 6;
569}
570
571message LspWorkProgress {
572 reserved 1;
573 optional string message = 2;
574 optional uint32 percentage = 3;
575 optional bool is_cancellable = 4;
576 ProgressToken token = 5;
577}
578
579message LspWorkEnd {
580 reserved 1;
581 ProgressToken token = 2;
582}
583
584message LspDiskBasedDiagnosticsUpdating {}
585
586message LspDiskBasedDiagnosticsUpdated {}
587
588message StatusUpdate {
589 optional string message = 1;
590 oneof status {
591 ServerBinaryStatus binary = 2;
592 ServerHealth health = 3;
593 }
594}
595
596enum ServerHealth {
597 OK = 0;
598 WARNING = 1;
599 ERROR = 2;
600}
601
602enum ServerBinaryStatus {
603 NONE = 0;
604 CHECKING_FOR_UPDATE = 1;
605 DOWNLOADING = 2;
606 STARTING = 3;
607 STOPPING = 4;
608 STOPPED = 5;
609 FAILED = 6;
610}
611
612message RegisteredForBuffer {
613 string buffer_abs_path = 1;
614 uint64 buffer_id = 2;
615}
616
617message ServerMetadataUpdated {
618 optional string capabilities = 1;
619}
620
621message LanguageServerLog {
622 uint64 project_id = 1;
623 uint64 language_server_id = 2;
624 string message = 3;
625 oneof log_type {
626 LogMessage log = 4;
627 TraceMessage trace = 5;
628 RpcMessage rpc = 6;
629 }
630}
631
632message LogMessage {
633 LogLevel level = 1;
634
635 enum LogLevel {
636 LOG = 0;
637 INFO = 1;
638 WARNING = 2;
639 ERROR = 3;
640 }
641}
642
643message TraceMessage {
644 optional string verbose_info = 1;
645}
646
647message RpcMessage {
648 Kind kind = 1;
649
650 enum Kind {
651 RECEIVED = 0;
652 SENT = 1;
653 }
654}
655
656message LspLogTrace {
657 optional string message = 1;
658}
659
660message ApplyCodeActionKind {
661 uint64 project_id = 1;
662 string kind = 2;
663 repeated uint64 buffer_ids = 3;
664}
665
666message ApplyCodeActionKindResponse {
667 ProjectTransaction transaction = 1;
668}
669
670message RegisterBufferWithLanguageServers {
671 uint64 project_id = 1;
672 uint64 buffer_id = 2;
673 repeated LanguageServerSelector only_servers = 3;
674}
675
676enum FormatTrigger {
677 Save = 0;
678 Manual = 1;
679}
680
681message OpenBufferForSymbol {
682 uint64 project_id = 1;
683 Symbol symbol = 2;
684}
685
686message OpenBufferForSymbolResponse {
687 uint64 buffer_id = 1;
688}
689
690message FormatBuffers {
691 uint64 project_id = 1;
692 FormatTrigger trigger = 2;
693 repeated uint64 buffer_ids = 3;
694}
695
696message FormatBuffersResponse {
697 ProjectTransaction transaction = 1;
698}
699
700message GetCompletions {
701 uint64 project_id = 1;
702 uint64 buffer_id = 2;
703 Anchor position = 3;
704 repeated VectorClockEntry version = 4;
705}
706
707message CancelLanguageServerWork {
708 uint64 project_id = 1;
709
710 oneof work {
711 Buffers buffers = 2;
712 LanguageServerWork language_server_work = 3;
713 }
714
715 message Buffers {
716 repeated uint64 buffer_ids = 2;
717 }
718
719 message LanguageServerWork {
720 uint64 language_server_id = 1;
721 reserved 2;
722 optional ProgressToken token = 3;
723 }
724}
725
726message LanguageServerPromptRequest {
727 uint64 project_id = 1;
728
729 oneof level {
730 Info info = 2;
731 Warning warning = 3;
732 Critical critical = 4;
733 }
734
735 message Info {}
736 message Warning {}
737 message Critical {}
738
739 string message = 5;
740 repeated string actions = 6;
741 string lsp_name = 7;
742}
743
744message LanguageServerPromptResponse {
745 optional uint64 action_response = 1;
746}
747
748message GetDocumentColor {
749 uint64 project_id = 1;
750 uint64 buffer_id = 2;
751 repeated VectorClockEntry version = 3;
752
753}
754
755message GetDocumentColorResponse {
756 repeated ColorInformation colors = 1;
757 repeated VectorClockEntry version = 2;
758
759}
760
761message ColorInformation {
762 PointUtf16 lsp_range_start = 1;
763 PointUtf16 lsp_range_end = 2;
764 float red = 3;
765 float green = 4;
766 float blue = 5;
767 float alpha = 6;
768}
769
770message GetColorPresentation {
771 uint64 project_id = 1;
772 uint64 buffer_id = 2;
773 ColorInformation color = 3;
774 uint64 server_id = 4;
775}
776
777message GetColorPresentationResponse {
778 repeated ColorPresentation presentations = 1;
779}
780
781message ColorPresentation {
782 string label = 1;
783 optional TextEdit text_edit = 2;
784 repeated TextEdit additional_text_edits = 3;
785}
786
787message TextEdit {
788 string new_text = 1;
789 PointUtf16 lsp_range_start = 2;
790 PointUtf16 lsp_range_end = 3;
791}
792
793message LspQuery {
794 uint64 project_id = 1;
795 uint64 lsp_request_id = 2;
796 optional uint64 server_id = 15;
797 oneof request {
798 GetReferences get_references = 3;
799 GetDocumentColor get_document_color = 4;
800 GetHover get_hover = 5;
801 GetCodeActions get_code_actions = 6;
802 GetSignatureHelp get_signature_help = 7;
803 GetCodeLens get_code_lens = 8;
804 GetDocumentDiagnostics get_document_diagnostics = 9;
805 GetDefinition get_definition = 10;
806 GetDeclaration get_declaration = 11;
807 GetTypeDefinition get_type_definition = 12;
808 GetImplementation get_implementation = 13;
809 InlayHints inlay_hints = 14;
810 }
811}
812
813message LspQueryResponse {
814 uint64 project_id = 1;
815 uint64 lsp_request_id = 2;
816 repeated LspResponse responses = 3;
817}
818
819message LspResponse {
820 oneof response {
821 GetHoverResponse get_hover_response = 1;
822 GetCodeActionsResponse get_code_actions_response = 2;
823 GetSignatureHelpResponse get_signature_help_response = 3;
824 GetCodeLensResponse get_code_lens_response = 4;
825 GetDocumentDiagnosticsResponse get_document_diagnostics_response = 5;
826 GetDocumentColorResponse get_document_color_response = 6;
827 GetDefinitionResponse get_definition_response = 8;
828 GetDeclarationResponse get_declaration_response = 9;
829 GetTypeDefinitionResponse get_type_definition_response = 10;
830 GetImplementationResponse get_implementation_response = 11;
831 GetReferencesResponse get_references_response = 12;
832 InlayHintsResponse inlay_hints_response = 13;
833 }
834 uint64 server_id = 7;
835}
836
837message AllLanguageServers {}
838
839message LanguageServerSelector {
840 oneof selector {
841 uint64 server_id = 1;
842 string name = 2;
843 }
844}
845
846message RestartLanguageServers {
847 uint64 project_id = 1;
848 repeated uint64 buffer_ids = 2;
849 repeated LanguageServerSelector only_servers = 3;
850 bool all = 4;
851}
852
853message StopLanguageServers {
854 uint64 project_id = 1;
855 repeated uint64 buffer_ids = 2;
856 repeated LanguageServerSelector also_servers = 3;
857 bool all = 4;
858}
859
860message LspExtRunnables {
861 uint64 project_id = 1;
862 uint64 buffer_id = 2;
863 optional Anchor position = 3;
864}
865
866message LspExtRunnablesResponse {
867 repeated LspRunnable runnables = 1;
868}
869
870message LspRunnable {
871 bytes task_template = 1;
872 optional LocationLink location = 2;
873}
874
875message LspExtCancelFlycheck {
876 uint64 project_id = 1;
877 uint64 language_server_id = 2;
878}
879
880message LspExtRunFlycheck {
881 uint64 project_id = 1;
882 optional uint64 buffer_id = 2;
883 uint64 language_server_id = 3;
884 bool current_file_only = 4;
885}
886
887message LspExtClearFlycheck {
888 uint64 project_id = 1;
889 uint64 language_server_id = 2;
890}
891
892message LspDiagnosticRelatedInformation {
893 optional string location_url = 1;
894 PointUtf16 location_range_start = 2;
895 PointUtf16 location_range_end = 3;
896 string message = 4;
897}
898
899enum LspDiagnosticTag {
900 None = 0;
901 Unnecessary = 1;
902 Deprecated = 2;
903}
904
905message LspDiagnostic {
906 PointUtf16 start = 1;
907 PointUtf16 end = 2;
908 Severity severity = 3;
909 optional string code = 4;
910 optional string code_description = 5;
911 optional string source = 6;
912 string message = 7;
913 repeated LspDiagnosticRelatedInformation related_information = 8;
914 repeated LspDiagnosticTag tags = 9;
915 optional string data = 10;
916
917 enum Severity {
918 None = 0;
919 Error = 1;
920 Warning = 2;
921 Information = 3;
922 Hint = 4;
923 }
924}
925
926message GetDocumentDiagnostics {
927 uint64 project_id = 1;
928 uint64 buffer_id = 2;
929 repeated VectorClockEntry version = 3;
930}
931
932message GetDocumentDiagnosticsResponse {
933 repeated PulledDiagnostics pulled_diagnostics = 1;
934}
935
936message PulledDiagnostics {
937 uint64 server_id = 1;
938 string uri = 2;
939 optional string result_id = 3;
940 bool changed = 4;
941 repeated LspDiagnostic diagnostics = 5;
942}
943
944message PullWorkspaceDiagnostics {
945 uint64 project_id = 1;
946 uint64 server_id = 2;
947}
948
949message ToggleLspLogs {
950 uint64 project_id = 1;
951 LogType log_type = 2;
952 uint64 server_id = 3;
953 bool enabled = 4;
954
955 enum LogType {
956 LOG = 0;
957 TRACE = 1;
958 RPC = 2;
959 }
960}