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