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}
469
470message CodeLens {
471 bytes lsp_lens = 1;
472}
473
474message GetCodeLens {
475 uint64 project_id = 1;
476 uint64 buffer_id = 2;
477 repeated VectorClockEntry version = 3;
478}
479
480message GetCodeLensResponse {
481 repeated CodeAction lens_actions = 1;
482 repeated VectorClockEntry version = 2;
483}
484
485message RefreshCodeLens {
486 uint64 project_id = 1;
487}
488
489message MarkupContent {
490 bool is_markdown = 1;
491 string value = 2;
492}
493
494message PerformRenameResponse {
495 ProjectTransaction transaction = 2;
496}
497
498message CodeAction {
499 uint64 server_id = 1;
500 Anchor start = 2;
501 Anchor end = 3;
502 bytes lsp_action = 4;
503 Kind kind = 5;
504 bool resolved = 6;
505 enum Kind {
506 Action = 0;
507 Command = 1;
508 CodeLens = 2;
509 }
510}
511
512message LanguageServer {
513 uint64 id = 1;
514 string name = 2;
515 optional uint64 worktree_id = 3;
516}
517
518message StartLanguageServer {
519 uint64 project_id = 1;
520 LanguageServer server = 2;
521 string capabilities = 3;
522}
523
524message UpdateDiagnosticSummary {
525 uint64 project_id = 1;
526 uint64 worktree_id = 2;
527 DiagnosticSummary summary = 3;
528 repeated DiagnosticSummary more_summaries = 4;
529}
530
531message DiagnosticSummary {
532 string path = 1;
533 uint64 language_server_id = 2;
534 uint32 error_count = 3;
535 uint32 warning_count = 4;
536}
537
538message UpdateLanguageServer {
539 uint64 project_id = 1;
540 uint64 language_server_id = 2;
541 optional string server_name = 8;
542 oneof variant {
543 LspWorkStart work_start = 3;
544 LspWorkProgress work_progress = 4;
545 LspWorkEnd work_end = 5;
546 LspDiskBasedDiagnosticsUpdating disk_based_diagnostics_updating = 6;
547 LspDiskBasedDiagnosticsUpdated disk_based_diagnostics_updated = 7;
548 StatusUpdate status_update = 9;
549 RegisteredForBuffer registered_for_buffer = 10;
550 ServerMetadataUpdated metadata_updated = 11;
551 }
552}
553
554message LspWorkStart {
555 string token = 1;
556 optional string title = 4;
557 optional string message = 2;
558 optional uint32 percentage = 3;
559 optional bool is_cancellable = 5;
560}
561
562message LspWorkProgress {
563 string token = 1;
564 optional string message = 2;
565 optional uint32 percentage = 3;
566 optional bool is_cancellable = 4;
567}
568
569message LspWorkEnd {
570 string token = 1;
571}
572
573message LspDiskBasedDiagnosticsUpdating {}
574
575message LspDiskBasedDiagnosticsUpdated {}
576
577message StatusUpdate {
578 optional string message = 1;
579 oneof status {
580 ServerBinaryStatus binary = 2;
581 ServerHealth health = 3;
582 }
583}
584
585enum ServerHealth {
586 OK = 0;
587 WARNING = 1;
588 ERROR = 2;
589}
590
591enum ServerBinaryStatus {
592 NONE = 0;
593 CHECKING_FOR_UPDATE = 1;
594 DOWNLOADING = 2;
595 STARTING = 3;
596 STOPPING = 4;
597 STOPPED = 5;
598 FAILED = 6;
599}
600
601message RegisteredForBuffer {
602 string buffer_abs_path = 1;
603 uint64 buffer_id = 2;
604}
605
606message ServerMetadataUpdated {
607 optional string capabilities = 1;
608}
609
610message LanguageServerLog {
611 uint64 project_id = 1;
612 uint64 language_server_id = 2;
613 string message = 3;
614 oneof log_type {
615 LogMessage log = 4;
616 TraceMessage trace = 5;
617 RpcMessage rpc = 6;
618 }
619}
620
621message LogMessage {
622 LogLevel level = 1;
623
624 enum LogLevel {
625 LOG = 0;
626 INFO = 1;
627 WARNING = 2;
628 ERROR = 3;
629 }
630}
631
632message TraceMessage {
633 optional string verbose_info = 1;
634}
635
636message RpcMessage {
637 Kind kind = 1;
638
639 enum Kind {
640 RECEIVED = 0;
641 SENT = 1;
642 }
643}
644
645message LspLogTrace {
646 optional string message = 1;
647}
648
649message ApplyCodeActionKind {
650 uint64 project_id = 1;
651 string kind = 2;
652 repeated uint64 buffer_ids = 3;
653}
654
655message ApplyCodeActionKindResponse {
656 ProjectTransaction transaction = 1;
657}
658
659message RegisterBufferWithLanguageServers {
660 uint64 project_id = 1;
661 uint64 buffer_id = 2;
662 repeated LanguageServerSelector only_servers = 3;
663}
664
665enum FormatTrigger {
666 Save = 0;
667 Manual = 1;
668}
669
670message OpenBufferForSymbol {
671 uint64 project_id = 1;
672 Symbol symbol = 2;
673}
674
675message OpenBufferForSymbolResponse {
676 uint64 buffer_id = 1;
677}
678
679message FormatBuffers {
680 uint64 project_id = 1;
681 FormatTrigger trigger = 2;
682 repeated uint64 buffer_ids = 3;
683}
684
685message FormatBuffersResponse {
686 ProjectTransaction transaction = 1;
687}
688
689message GetCompletions {
690 uint64 project_id = 1;
691 uint64 buffer_id = 2;
692 Anchor position = 3;
693 repeated VectorClockEntry version = 4;
694}
695
696message CancelLanguageServerWork {
697 uint64 project_id = 1;
698
699 oneof work {
700 Buffers buffers = 2;
701 LanguageServerWork language_server_work = 3;
702 }
703
704 message Buffers {
705 repeated uint64 buffer_ids = 2;
706 }
707
708 message LanguageServerWork {
709 uint64 language_server_id = 1;
710 optional string token = 2;
711 }
712}
713
714message LanguageServerPromptRequest {
715 uint64 project_id = 1;
716
717 oneof level {
718 Info info = 2;
719 Warning warning = 3;
720 Critical critical = 4;
721 }
722
723 message Info {}
724 message Warning {}
725 message Critical {}
726
727 string message = 5;
728 repeated string actions = 6;
729 string lsp_name = 7;
730}
731
732message LanguageServerPromptResponse {
733 optional uint64 action_response = 1;
734}
735
736message GetDocumentColor {
737 uint64 project_id = 1;
738 uint64 buffer_id = 2;
739 repeated VectorClockEntry version = 3;
740
741}
742
743message GetDocumentColorResponse {
744 repeated ColorInformation colors = 1;
745 repeated VectorClockEntry version = 2;
746
747}
748
749message ColorInformation {
750 PointUtf16 lsp_range_start = 1;
751 PointUtf16 lsp_range_end = 2;
752 float red = 3;
753 float green = 4;
754 float blue = 5;
755 float alpha = 6;
756}
757
758message GetColorPresentation {
759 uint64 project_id = 1;
760 uint64 buffer_id = 2;
761 ColorInformation color = 3;
762 uint64 server_id = 4;
763}
764
765message GetColorPresentationResponse {
766 repeated ColorPresentation presentations = 1;
767}
768
769message ColorPresentation {
770 string label = 1;
771 optional TextEdit text_edit = 2;
772 repeated TextEdit additional_text_edits = 3;
773}
774
775message TextEdit {
776 string new_text = 1;
777 PointUtf16 lsp_range_start = 2;
778 PointUtf16 lsp_range_end = 3;
779}
780
781message LspQuery {
782 uint64 project_id = 1;
783 uint64 lsp_request_id = 2;
784 oneof request {
785 GetReferences get_references = 3;
786 GetDocumentColor get_document_color = 4;
787 GetHover get_hover = 5;
788 GetCodeActions get_code_actions = 6;
789 GetSignatureHelp get_signature_help = 7;
790 GetCodeLens get_code_lens = 8;
791 GetDocumentDiagnostics get_document_diagnostics = 9;
792 GetDefinition get_definition = 10;
793 GetDeclaration get_declaration = 11;
794 GetTypeDefinition get_type_definition = 12;
795 GetImplementation get_implementation = 13;
796 }
797}
798
799message LspQueryResponse {
800 uint64 project_id = 1;
801 uint64 lsp_request_id = 2;
802 repeated LspResponse responses = 3;
803}
804
805message LspResponse {
806 oneof response {
807 GetHoverResponse get_hover_response = 1;
808 GetCodeActionsResponse get_code_actions_response = 2;
809 GetSignatureHelpResponse get_signature_help_response = 3;
810 GetCodeLensResponse get_code_lens_response = 4;
811 GetDocumentDiagnosticsResponse get_document_diagnostics_response = 5;
812 GetDocumentColorResponse get_document_color_response = 6;
813 GetDefinitionResponse get_definition_response = 8;
814 GetDeclarationResponse get_declaration_response = 9;
815 GetTypeDefinitionResponse get_type_definition_response = 10;
816 GetImplementationResponse get_implementation_response = 11;
817 GetReferencesResponse get_references_response = 12;
818 }
819 uint64 server_id = 7;
820}
821
822message AllLanguageServers {}
823
824message LanguageServerSelector {
825 oneof selector {
826 uint64 server_id = 1;
827 string name = 2;
828 }
829}
830
831message RestartLanguageServers {
832 uint64 project_id = 1;
833 repeated uint64 buffer_ids = 2;
834 repeated LanguageServerSelector only_servers = 3;
835 bool all = 4;
836}
837
838message StopLanguageServers {
839 uint64 project_id = 1;
840 repeated uint64 buffer_ids = 2;
841 repeated LanguageServerSelector also_servers = 3;
842 bool all = 4;
843}
844
845message LspExtRunnables {
846 uint64 project_id = 1;
847 uint64 buffer_id = 2;
848 optional Anchor position = 3;
849}
850
851message LspExtRunnablesResponse {
852 repeated LspRunnable runnables = 1;
853}
854
855message LspRunnable {
856 bytes task_template = 1;
857 optional LocationLink location = 2;
858}
859
860message LspExtCancelFlycheck {
861 uint64 project_id = 1;
862 uint64 language_server_id = 2;
863}
864
865message LspExtRunFlycheck {
866 uint64 project_id = 1;
867 optional uint64 buffer_id = 2;
868 uint64 language_server_id = 3;
869 bool current_file_only = 4;
870}
871
872message LspExtClearFlycheck {
873 uint64 project_id = 1;
874 uint64 language_server_id = 2;
875}
876
877message LspDiagnosticRelatedInformation {
878 optional string location_url = 1;
879 PointUtf16 location_range_start = 2;
880 PointUtf16 location_range_end = 3;
881 string message = 4;
882}
883
884enum LspDiagnosticTag {
885 None = 0;
886 Unnecessary = 1;
887 Deprecated = 2;
888}
889
890message LspDiagnostic {
891 PointUtf16 start = 1;
892 PointUtf16 end = 2;
893 Severity severity = 3;
894 optional string code = 4;
895 optional string code_description = 5;
896 optional string source = 6;
897 string message = 7;
898 repeated LspDiagnosticRelatedInformation related_information = 8;
899 repeated LspDiagnosticTag tags = 9;
900 optional string data = 10;
901
902 enum Severity {
903 None = 0;
904 Error = 1;
905 Warning = 2;
906 Information = 3;
907 Hint = 4;
908 }
909}
910
911message GetDocumentDiagnostics {
912 uint64 project_id = 1;
913 uint64 buffer_id = 2;
914 repeated VectorClockEntry version = 3;
915}
916
917message GetDocumentDiagnosticsResponse {
918 repeated PulledDiagnostics pulled_diagnostics = 1;
919}
920
921message PulledDiagnostics {
922 uint64 server_id = 1;
923 string uri = 2;
924 optional string result_id = 3;
925 bool changed = 4;
926 repeated LspDiagnostic diagnostics = 5;
927}
928
929message PullWorkspaceDiagnostics {
930 uint64 project_id = 1;
931 uint64 server_id = 2;
932}
933
934message ToggleLspLogs {
935 uint64 project_id = 1;
936 LogType log_type = 2;
937 uint64 server_id = 3;
938 bool enabled = 4;
939
940 enum LogType {
941 LOG = 0;
942 TRACE = 1;
943 RPC = 2;
944 }
945}