Skip to main content
Blitz
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
  1. Blitz
  2. /
  3. Architecture
  4. /
  5. API reference
  6. /
  7. language.proto
Edit page

language.proto

Generated from proto/blitz/v1/language.proto by proto-gen-md-diagrams.

Imports

Import Description
google/protobuf/timestamp.proto

Options

Name Value Description
go_package github.com/retail-cortex/blitz/proto/blitz/v1

blitz.v1 Diagram 

classDiagram
direction LR
%% Mermaid Diagram for package: blitz.v1

%% Request message for LanguageService.OpenDocument.

class OpenDocumentRequest {
  + string workspace
  + string client
  + string path
  + string text
  + int64 version
  + CodeBlock block
}
OpenDocumentRequest --> `CodeBlock`

%% A code block opened as a document: the server sees it as a file of its own, in the workspace, that's never written to disk. Go fragments are made whole files first (a package clause, statements inside a function), the positions mapped across.

class CodeBlock {
  + string extension
  + string id
}

%% Response message for LanguageService.OpenDocument.

class OpenDocumentResponse {
  + string document
  + string language
  + ServerState state
  + string detail
  + string install
}
OpenDocumentResponse --> `ServerState`

%% Request message for LanguageService.ChangeDocument.

class ChangeDocumentRequest {
  + string workspace
  + string document
  + string text
  + int64 version
}

%% Response message for LanguageService.ChangeDocument.

class ChangeDocumentResponse {
}

%% Request message for LanguageService.CloseDocument.

class CloseDocumentRequest {
  + string workspace
  + string document
}

%% Response message for LanguageService.CloseDocument.

class CloseDocumentResponse {
}

%% Request message for LanguageService.KeepDocuments.

class KeepDocumentsRequest {
  + string workspace
  + string client
}

%% Response message for LanguageService.KeepDocuments.

class KeepDocumentsResponse {
  + List~string~ documents
}

%% A position in a document: 1-based line and column, in characters.

class TextPosition {
  + int32 line
  + int32 column
}

%% A range in a document, from start to before end.

class TextRange {
  + TextPosition start
  + TextPosition end
}
TextRange --> `TextPosition`
TextRange --> `TextPosition`

%% A change to a document's text: the range replaced by text.

class TextEdit {
  + TextRange range
  + string text
}
TextEdit --> `TextRange`

%% Request message for LanguageService.Complete.

class CompleteRequest {
  + string workspace
  + string document
  + int64 version
  + TextPosition position
  + string trigger
}
CompleteRequest --> `TextPosition`

%% One completion.

class CompletionItem {
  + string label
  + string kind
  + string detail
  + string documentation
  + string insert_text
  + TextEdit edit
  + bool snippet
  + List~TextEdit~ additional_edits
  + string sort_text
  + string filter_text
}
CompletionItem --> `TextEdit`
CompletionItem --> `TextEdit`

%% Response message for LanguageService.Complete.

class CompleteResponse {
  + List~CompletionItem~ items
  + bool incomplete
}
CompleteResponse --> `CompletionItem`

%% Request message for LanguageService.Hover.

class HoverRequest {
  + string workspace
  + string document
  + int64 version
  + TextPosition position
}
HoverRequest --> `TextPosition`

%% Response message for LanguageService.Hover.

class HoverResponse {
  + string text
}

%% Request message for LanguageService.Definition.

class DefinitionRequest {
  + string workspace
  + string document
  + int64 version
  + TextPosition position
}
DefinitionRequest --> `TextPosition`

%% Request message for LanguageService.References.

class ReferencesRequest {
  + string workspace
  + string document
  + int64 version
  + TextPosition position
}
ReferencesRequest --> `TextPosition`

%% A place in a file, as Definition and References answer.

class SourceLocation {
  + string path
  + int32 line
  + int32 column
  + string text
  + bool outside
}

%% Response message for LanguageService.Definition.

class DefinitionResponse {
  + List~SourceLocation~ locations
}
DefinitionResponse --> `SourceLocation`

%% Response message for LanguageService.References.

class ReferencesResponse {
  + List~SourceLocation~ locations
}
ReferencesResponse --> `SourceLocation`

%% One problem a server reports.

class LanguageDiagnostic {
  + TextRange range
  + string severity
  + string message
  + string source
  + string code
}
LanguageDiagnostic --> `TextRange`

%% Request message for LanguageService.WatchDiagnostics.

class WatchDiagnosticsRequest {
  + string workspace
  + string client
}

%% Response message for LanguageService.WatchDiagnostics: a document's diagnostics, all of them, replacing those sent before.

class WatchDiagnosticsResponse {
  + string document
  + int64 version
  + List~LanguageDiagnostic~ diagnostics
}
WatchDiagnosticsResponse --> `LanguageDiagnostic`

%% Request message for LanguageService.GetLanguageStatus.

class GetLanguageStatusRequest {
  + string workspace
}

%% A language's server.

class LanguageServerStatus {
  + string language
  + List~string~ command
  + List~string~ extensions
  + ServerState state
  + google.protobuf.Timestamp since
  + string error
  + string install
}
LanguageServerStatus --> `ServerState`

%% Response message for LanguageService.GetLanguageStatus.

class GetLanguageStatusResponse {
  + List~LanguageServerStatus~ servers
  + bool untrusted
}
GetLanguageStatusResponse --> `LanguageServerStatus`

%% Request message for LanguageService.RestartLanguageServer.

class RestartLanguageServerRequest {
  + string workspace
  + string language
}

%% Response message for LanguageService.RestartLanguageServer.

class RestartLanguageServerResponse {
}
%% How a document's language server is.

class ServerState{
  <<enumeration>>
  SERVER_STATE_UNSPECIFIED
  SERVER_STATE_READY
  SERVER_STATE_STARTING
  SERVER_STATE_MISSING
  SERVER_STATE_FAILED
  SERVER_STATE_UNTRUSTED
  SERVER_STATE_NONE
  SERVER_STATE_IDLE
}
class LanguageService {
  <<service>>
  +OpenDocument(OpenDocumentRequest) OpenDocumentResponse
  +ChangeDocument(ChangeDocumentRequest) ChangeDocumentResponse
  +CloseDocument(CloseDocumentRequest) CloseDocumentResponse
  +KeepDocuments(KeepDocumentsRequest) KeepDocumentsResponse
  +Complete(CompleteRequest) CompleteResponse
  +Hover(HoverRequest) HoverResponse
  +Definition(DefinitionRequest) DefinitionResponse
  +References(ReferencesRequest) ReferencesResponse
  +WatchDiagnostics(WatchDiagnosticsRequest) Stream~WatchDiagnosticsResponse~
  +GetLanguageStatus(GetLanguageStatusRequest) GetLanguageStatusResponse
  +RestartLanguageServer(RestartLanguageServerRequest) RestartLanguageServerResponse
}
LanguageService --> `OpenDocumentRequest`
LanguageService --> `OpenDocumentResponse`
LanguageService --> `ChangeDocumentRequest`
LanguageService --> `ChangeDocumentResponse`
LanguageService --> `CloseDocumentRequest`
LanguageService --> `CloseDocumentResponse`
LanguageService --> `KeepDocumentsRequest`
LanguageService --> `KeepDocumentsResponse`
LanguageService --> `CompleteRequest`
LanguageService --> `CompleteResponse`
LanguageService --> `HoverRequest`
LanguageService --> `HoverResponse`
LanguageService --> `DefinitionRequest`
LanguageService --> `DefinitionResponse`
LanguageService --> `ReferencesRequest`
LanguageService --> `ReferencesResponse`
LanguageService --> `WatchDiagnosticsRequest`
LanguageService --o `WatchDiagnosticsResponse` : server stream
LanguageService --> `GetLanguageStatusRequest`
LanguageService --> `GetLanguageStatusResponse`
LanguageService --> `RestartLanguageServerRequest`
LanguageService --> `RestartLanguageServerResponse`

Service: LanguageService

FQN: blitz.v1
LanguageService is the workspace's language servers for the editor (spec_visual_editor_037): completion, hover, definitions, references and problems for the documents it has open, unsaved text included. The editor shares the servers the agent's lsp tool uses: one per workspace and language. A document is opened, changed with its whole text and a version, and closed; its diagnostics come on a stream. Documents belong to a client (a window), and close by themselves when it hasn't called or watched for two minutes (KeepDocuments keeps them). Positions are 1-based lines and columns in characters. Every request names its workspace by absolute directory. Errors carry an ErrorInfo detail: UNKNOWN_DOCUMENT, STALE (an older version than the document's), UNTRUSTED, NO_SERVER, SERVER_MISSING, SERVER_FAILED, BAD_PATH.

LanguageService Diagram 

classDiagram
direction LR
class LanguageService {
  <<service>>
  +OpenDocument(OpenDocumentRequest) OpenDocumentResponse
  +ChangeDocument(ChangeDocumentRequest) ChangeDocumentResponse
  +CloseDocument(CloseDocumentRequest) CloseDocumentResponse
  +KeepDocuments(KeepDocumentsRequest) KeepDocumentsResponse
  +Complete(CompleteRequest) CompleteResponse
  +Hover(HoverRequest) HoverResponse
  +Definition(DefinitionRequest) DefinitionResponse
  +References(ReferencesRequest) ReferencesResponse
  +WatchDiagnostics(WatchDiagnosticsRequest) Stream~WatchDiagnosticsResponse~
  +GetLanguageStatus(GetLanguageStatusRequest) GetLanguageStatusResponse
  +RestartLanguageServer(RestartLanguageServerRequest) RestartLanguageServerResponse
}
LanguageService --> `OpenDocumentRequest`
LanguageService --> `OpenDocumentResponse`
LanguageService --> `ChangeDocumentRequest`
LanguageService --> `ChangeDocumentResponse`
LanguageService --> `CloseDocumentRequest`
LanguageService --> `CloseDocumentResponse`
LanguageService --> `KeepDocumentsRequest`
LanguageService --> `KeepDocumentsResponse`
LanguageService --> `CompleteRequest`
LanguageService --> `CompleteResponse`
LanguageService --> `HoverRequest`
LanguageService --> `HoverResponse`
LanguageService --> `DefinitionRequest`
LanguageService --> `DefinitionResponse`
LanguageService --> `ReferencesRequest`
LanguageService --> `ReferencesResponse`
LanguageService --> `WatchDiagnosticsRequest`
LanguageService --o `WatchDiagnosticsResponse` : server stream
LanguageService --> `GetLanguageStatusRequest`
LanguageService --> `GetLanguageStatusResponse`
LanguageService --> `RestartLanguageServerRequest`
LanguageService --> `RestartLanguageServerResponse`
Method Parameter (In) Parameter (Out) Description
OpenDocument OpenDocumentRequest OpenDocumentResponse Opens a document for the editor; the server starts if it isn’t running (the state says how that is going).
ChangeDocument ChangeDocumentRequest ChangeDocumentResponse Replaces a document’s text: the newer version wins.
CloseDocument CloseDocumentRequest CloseDocumentResponse Closes a document: the server reads the file from disk again.
KeepDocuments KeepDocumentsRequest KeepDocumentsResponse Keeps a client’s documents open (every 30 s while its window is).
Complete CompleteRequest CompleteResponse Completion at a position.
Hover HoverRequest HoverResponse What the server says about the symbol at a position (Markdown).
Definition DefinitionRequest DefinitionResponse Where the symbol at a position is defined.
References ReferencesRequest ReferencesResponse Where the symbol at a position is used, its definition included.
WatchDiagnostics WatchDiagnosticsRequest Stream<WatchDiagnosticsResponse> A client’s documents’ diagnostics, as servers publish them (each document’s latest first, then changes). Watching keeps the client’s documents open.
GetLanguageStatus GetLanguageStatusRequest GetLanguageStatusResponse The workspace’s language servers and how each is.
RestartLanguageServer RestartLanguageServerRequest RestartLanguageServerResponse Stops a language’s server; the next request starts it again, and the editor’s documents are opened in it again.

Enum: ServerState

FQN: blitz.v1.ServerState
How a document's language server is.
Name Ordinal Description
SERVER_STATE_UNSPECIFIED 0
SERVER_STATE_READY 1 Running: requests are answered.
SERVER_STATE_STARTING 2 Being started.
SERVER_STATE_MISSING 3 Its command isn’t installed (install says what to install).
SERVER_STATE_FAILED 4 It failed to start or stopped; tried again after a minute.
SERVER_STATE_UNTRUSTED 5 The workspace’s project settings aren’t trusted.
SERVER_STATE_NONE 6 No server is configured for the language.
SERVER_STATE_IDLE 7 Configured, not started yet (no file of its language asked).

ServerState Diagram 

classDiagram
direction LR
%% How a document's language server is.

class ServerState{
  <<enumeration>>
  SERVER_STATE_UNSPECIFIED
  SERVER_STATE_READY
  SERVER_STATE_STARTING
  SERVER_STATE_MISSING
  SERVER_STATE_FAILED
  SERVER_STATE_UNTRUSTED
  SERVER_STATE_NONE
  SERVER_STATE_IDLE
}

OpenDocumentRequest Diagram 

classDiagram
direction LR

%% Request message for LanguageService.OpenDocument.

class OpenDocumentRequest {
  + string workspace
  + string client
  + string path
  + string text
  + int64 version
  + CodeBlock block
}
OpenDocumentRequest --> `CodeBlock`

CodeBlock Diagram 

classDiagram
direction LR

%% A code block opened as a document: the server sees it as a file of its own, in the workspace, that's never written to disk. Go fragments are made whole files first (a package clause, statements inside a function), the positions mapped across.

class CodeBlock {
  + string extension
  + string id
}

OpenDocumentResponse Diagram 

classDiagram
direction LR

%% Response message for LanguageService.OpenDocument.

class OpenDocumentResponse {
  + string document
  + string language
  + ServerState state
  + string detail
  + string install
}
OpenDocumentResponse --> `ServerState`

ChangeDocumentRequest Diagram 

classDiagram
direction LR

%% Request message for LanguageService.ChangeDocument.

class ChangeDocumentRequest {
  + string workspace
  + string document
  + string text
  + int64 version
}

ChangeDocumentResponse Diagram 

classDiagram
direction LR

%% Response message for LanguageService.ChangeDocument.

class ChangeDocumentResponse {
}

CloseDocumentRequest Diagram 

classDiagram
direction LR

%% Request message for LanguageService.CloseDocument.

class CloseDocumentRequest {
  + string workspace
  + string document
}

CloseDocumentResponse Diagram 

classDiagram
direction LR

%% Response message for LanguageService.CloseDocument.

class CloseDocumentResponse {
}

KeepDocumentsRequest Diagram 

classDiagram
direction LR

%% Request message for LanguageService.KeepDocuments.

class KeepDocumentsRequest {
  + string workspace
  + string client
}

KeepDocumentsResponse Diagram 

classDiagram
direction LR

%% Response message for LanguageService.KeepDocuments.

class KeepDocumentsResponse {
  + List~string~ documents
}

TextPosition Diagram 

classDiagram
direction LR

%% A position in a document: 1-based line and column, in characters.

class TextPosition {
  + int32 line
  + int32 column
}

TextRange Diagram 

classDiagram
direction LR

%% A range in a document, from start to before end.

class TextRange {
  + TextPosition start
  + TextPosition end
}
TextRange --> `TextPosition`
TextRange --> `TextPosition`

TextEdit Diagram 

classDiagram
direction LR

%% A change to a document's text: the range replaced by text.

class TextEdit {
  + TextRange range
  + string text
}
TextEdit --> `TextRange`

CompleteRequest Diagram 

classDiagram
direction LR

%% Request message for LanguageService.Complete.

class CompleteRequest {
  + string workspace
  + string document
  + int64 version
  + TextPosition position
  + string trigger
}
CompleteRequest --> `TextPosition`

CompletionItem Diagram 

classDiagram
direction LR

%% One completion.

class CompletionItem {
  + string label
  + string kind
  + string detail
  + string documentation
  + string insert_text
  + TextEdit edit
  + bool snippet
  + List~TextEdit~ additional_edits
  + string sort_text
  + string filter_text
}
CompletionItem --> `TextEdit`
CompletionItem --> `TextEdit`

CompleteResponse Diagram 

classDiagram
direction LR

%% Response message for LanguageService.Complete.

class CompleteResponse {
  + List~CompletionItem~ items
  + bool incomplete
}
CompleteResponse --> `CompletionItem`

HoverRequest Diagram 

classDiagram
direction LR

%% Request message for LanguageService.Hover.

class HoverRequest {
  + string workspace
  + string document
  + int64 version
  + TextPosition position
}
HoverRequest --> `TextPosition`

HoverResponse Diagram 

classDiagram
direction LR

%% Response message for LanguageService.Hover.

class HoverResponse {
  + string text
}

DefinitionRequest Diagram 

classDiagram
direction LR

%% Request message for LanguageService.Definition.

class DefinitionRequest {
  + string workspace
  + string document
  + int64 version
  + TextPosition position
}
DefinitionRequest --> `TextPosition`

ReferencesRequest Diagram 

classDiagram
direction LR

%% Request message for LanguageService.References.

class ReferencesRequest {
  + string workspace
  + string document
  + int64 version
  + TextPosition position
}
ReferencesRequest --> `TextPosition`

SourceLocation Diagram 

classDiagram
direction LR

%% A place in a file, as Definition and References answer.

class SourceLocation {
  + string path
  + int32 line
  + int32 column
  + string text
  + bool outside
}

DefinitionResponse Diagram 

classDiagram
direction LR

%% Response message for LanguageService.Definition.

class DefinitionResponse {
  + List~SourceLocation~ locations
}
DefinitionResponse --> `SourceLocation`

ReferencesResponse Diagram 

classDiagram
direction LR

%% Response message for LanguageService.References.

class ReferencesResponse {
  + List~SourceLocation~ locations
}
ReferencesResponse --> `SourceLocation`

LanguageDiagnostic Diagram 

classDiagram
direction LR

%% One problem a server reports.

class LanguageDiagnostic {
  + TextRange range
  + string severity
  + string message
  + string source
  + string code
}
LanguageDiagnostic --> `TextRange`

WatchDiagnosticsRequest Diagram 

classDiagram
direction LR

%% Request message for LanguageService.WatchDiagnostics.

class WatchDiagnosticsRequest {
  + string workspace
  + string client
}

WatchDiagnosticsResponse Diagram 

classDiagram
direction LR

%% Response message for LanguageService.WatchDiagnostics: a document's diagnostics, all of them, replacing those sent before.

class WatchDiagnosticsResponse {
  + string document
  + int64 version
  + List~LanguageDiagnostic~ diagnostics
}
WatchDiagnosticsResponse --> `LanguageDiagnostic`

GetLanguageStatusRequest Diagram 

classDiagram
direction LR

%% Request message for LanguageService.GetLanguageStatus.

class GetLanguageStatusRequest {
  + string workspace
}

LanguageServerStatus Diagram 

classDiagram
direction LR

%% A language's server.

class LanguageServerStatus {
  + string language
  + List~string~ command
  + List~string~ extensions
  + ServerState state
  + google.protobuf.Timestamp since
  + string error
  + string install
}
LanguageServerStatus --> `ServerState`

GetLanguageStatusResponse Diagram 

classDiagram
direction LR

%% Response message for LanguageService.GetLanguageStatus.

class GetLanguageStatusResponse {
  + List~LanguageServerStatus~ servers
  + bool untrusted
}
GetLanguageStatusResponse --> `LanguageServerStatus`

RestartLanguageServerRequest Diagram 

classDiagram
direction LR

%% Request message for LanguageService.RestartLanguageServer.

class RestartLanguageServerRequest {
  + string workspace
  + string language
}

RestartLanguageServerResponse Diagram 

classDiagram
direction LR

%% Response message for LanguageService.RestartLanguageServer.

class RestartLanguageServerResponse {
}

Message: OpenDocumentRequest

FQN: blitz.v1.OpenDocumentRequest
Request message for LanguageService.OpenDocument.
Field Ordinal Type Label Description
workspace 1 string
client 2 string The client opening it (a random ID per window).
path 3 string The file, relative to the workspace.
text 4 string Its text in the editor, unsaved edits included.
version 5 int64 The editor’s version of the text (it only grows).
block 6 CodeBlock Set for a code block in the Markdown file at path, rather than the file itself (spec_visual_editor_037 §7).

Message: CodeBlock

FQN: blitz.v1.CodeBlock
A code block opened as a document: the server sees it as a file of its own, in the workspace, that's never written to disk. Go fragments are made whole files first (a package clause, statements inside a function), the positions mapped across.
Field Ordinal Type Label Description
extension 1 string Its language, as a file extension (".go").
id 2 string An ID the client gives the block, unique in its window.

Message: OpenDocumentResponse

FQN: blitz.v1.OpenDocumentResponse
Response message for LanguageService.OpenDocument.
Field Ordinal Type Label Description
document 1 string The document’s ID, for the other calls.
language 2 string The language server’s language (“go”), "" with none.
state 3 ServerState
detail 4 string Why it’s missing, failed or untrusted, for people.
install 5 string What to run to install a missing server.

Message: ChangeDocumentRequest

FQN: blitz.v1.ChangeDocumentRequest
Request message for LanguageService.ChangeDocument.
Field Ordinal Type Label Description
workspace 1 string
document 2 string
text 3 string
version 4 int64

Message: ChangeDocumentResponse

FQN: blitz.v1.ChangeDocumentResponse
Response message for LanguageService.ChangeDocument.
Field Ordinal Type Label Description

Message: CloseDocumentRequest

FQN: blitz.v1.CloseDocumentRequest
Request message for LanguageService.CloseDocument.
Field Ordinal Type Label Description
workspace 1 string
document 2 string

Message: CloseDocumentResponse

FQN: blitz.v1.CloseDocumentResponse
Response message for LanguageService.CloseDocument.
Field Ordinal Type Label Description

Message: KeepDocumentsRequest

FQN: blitz.v1.KeepDocumentsRequest
Request message for LanguageService.KeepDocuments.
Field Ordinal Type Label Description
workspace 1 string
client 2 string

Message: KeepDocumentsResponse

FQN: blitz.v1.KeepDocumentsResponse
Response message for LanguageService.KeepDocuments.
Field Ordinal Type Label Description
documents 1 string Repeated The client’s documents still open (one missing was closed: open it again).

Message: TextPosition

FQN: blitz.v1.TextPosition
A position in a document: 1-based line and column, in characters.
Field Ordinal Type Label Description
line 1 int32
column 2 int32

Message: TextRange

FQN: blitz.v1.TextRange
A range in a document, from start to before end.
Field Ordinal Type Label Description
start 1 TextPosition
end 2 TextPosition

Message: TextEdit

FQN: blitz.v1.TextEdit
A change to a document's text: the range replaced by text.
Field Ordinal Type Label Description
range 1 TextRange
text 2 string

Message: CompleteRequest

FQN: blitz.v1.CompleteRequest
Request message for LanguageService.Complete.
Field Ordinal Type Label Description
workspace 1 string
document 2 string
version 3 int64 The version the position is in.
position 4 TextPosition
trigger 5 string The character typed that asked for it ("." in Go), "" when asked for.

Message: CompletionItem

FQN: blitz.v1.CompletionItem
One completion.
Field Ordinal Type Label Description
label 1 string
kind 2 string function, method, field, variable, constant, class, interface, struct, module, keyword, snippet, property, type parameter, …
detail 3 string A short description (a type or signature).
documentation 4 string Documentation, in Markdown.
insert_text 5 string What to insert: edit’s text over edit’s range when set, else insert_text at the position, replacing the word before it.
edit 6 TextEdit
snippet 7 bool insert_text or edit’s text is an LSP snippet ($1, ${2:name}).
additional_edits 8 TextEdit Repeated Other changes that come with it (an import).
sort_text 9 string The server’s order and the text it filters by.
filter_text 10 string

Message: CompleteResponse

FQN: blitz.v1.CompleteResponse
Response message for LanguageService.Complete.
Field Ordinal Type Label Description
items 1 CompletionItem Repeated At most 200.
incomplete 2 bool Typing more may find others: ask again rather than filter.

Message: HoverRequest

FQN: blitz.v1.HoverRequest
Request message for LanguageService.Hover.
Field Ordinal Type Label Description
workspace 1 string
document 2 string
version 3 int64
position 4 TextPosition

Message: HoverResponse

FQN: blitz.v1.HoverResponse
Response message for LanguageService.Hover.
Field Ordinal Type Label Description
text 1 string Markdown; "" when the server has nothing to say.

Message: DefinitionRequest

FQN: blitz.v1.DefinitionRequest
Request message for LanguageService.Definition.
Field Ordinal Type Label Description
workspace 1 string
document 2 string
version 3 int64
position 4 TextPosition

Message: ReferencesRequest

FQN: blitz.v1.ReferencesRequest
Request message for LanguageService.References.
Field Ordinal Type Label Description
workspace 1 string
document 2 string
version 3 int64
position 4 TextPosition

Message: SourceLocation

FQN: blitz.v1.SourceLocation
A place in a file, as Definition and References answer.
Field Ordinal Type Label Description
path 1 string Relative to the workspace when inside it, else absolute; "" for the code block the request was about.
line 2 int32
column 3 int32
text 4 string The line’s text, trimmed.
outside 5 bool The file is outside the workspace (the standard library, a module).

Message: DefinitionResponse

FQN: blitz.v1.DefinitionResponse
Response message for LanguageService.Definition.
Field Ordinal Type Label Description
locations 1 SourceLocation Repeated At most 100.

Message: ReferencesResponse

FQN: blitz.v1.ReferencesResponse
Response message for LanguageService.References.
Field Ordinal Type Label Description
locations 1 SourceLocation Repeated At most 100.

Message: LanguageDiagnostic

FQN: blitz.v1.LanguageDiagnostic
One problem a server reports.
Field Ordinal Type Label Description
range 1 TextRange
severity 2 string error, warning, information or hint.
message 3 string
source 4 string Who reported it (“compiler”, “staticcheck”).
code 5 string Its code, when it has one.

Message: WatchDiagnosticsRequest

FQN: blitz.v1.WatchDiagnosticsRequest
Request message for LanguageService.WatchDiagnostics.
Field Ordinal Type Label Description
workspace 1 string
client 2 string

Message: WatchDiagnosticsResponse

FQN: blitz.v1.WatchDiagnosticsResponse
Response message for LanguageService.WatchDiagnostics: a document's diagnostics, all of them, replacing those sent before.
Field Ordinal Type Label Description
document 1 string
version 2 int64 The document’s version they’re about.
diagnostics 3 LanguageDiagnostic Repeated

Message: GetLanguageStatusRequest

FQN: blitz.v1.GetLanguageStatusRequest
Request message for LanguageService.GetLanguageStatus.
Field Ordinal Type Label Description
workspace 1 string

Message: LanguageServerStatus

FQN: blitz.v1.LanguageServerStatus
A language's server.
Field Ordinal Type Label Description
language 1 string
command 2 string Repeated The command that runs it.
extensions 3 string Repeated Its file extensions (".go").
state 4 ServerState Ready, starting, failed, missing or idle.
since 5 google.protobuf.Timestamp Started or failed at.
error 6 string Why it failed.
install 7 string What to run to install it, when missing.

Message: GetLanguageStatusResponse

FQN: blitz.v1.GetLanguageStatusResponse
Response message for LanguageService.GetLanguageStatus.
Field Ordinal Type Label Description
servers 1 LanguageServerStatus Repeated
untrusted 2 bool The project’s settings aren’t trusted: no server starts for the editor.

Message: RestartLanguageServerRequest

FQN: blitz.v1.RestartLanguageServerRequest
Request message for LanguageService.RestartLanguageServer.
Field Ordinal Type Label Description
workspace 1 string
language 2 string

Message: RestartLanguageServerResponse

FQN: blitz.v1.RestartLanguageServerResponse
Response message for LanguageService.RestartLanguageServer.
Field Ordinal Type Label Description
gdoc_arrow_left_alt file.proto config.proto gdoc_arrow_right_alt