lsp

Documentation

Overview

Package lsp implements a Language Server Protocol server for DBML. It wraps the analysis package and exposes diagnostics, hover, completion, definition, references, document symbols, and rename over JSON-RPC.

Index

• func Run(in io.Reader, out io.Writer, logger *log.Logger) error
• func RunStdio(logPath string) error
• type CompletionItem
• type CompletionList
• type CompletionOptions
• type Diagnostic
• type DidChangeParams
• type DidCloseParams
• type DidOpenParams
• type DocumentSymbol
• type DocumentSymbolParams
• type Hover
• type InitializeResult
• type LSPRange
• type Location
• type MarkupContent
• type Position
• type PrepareRenameResult
• type PublishDiagnosticsParams
• type ReferenceContext
• type ReferenceParams
• type RenameOptions
• type RenameParams
• type ServerCapabilities
• type TextDocumentContentChangeEvent
• type TextDocumentIdentifier
• type TextDocumentItem
• type TextDocumentPositionParams
• type TextEdit
• type VersionedTextDocumentIdentifier
• type WorkspaceEdit

Functions

func Run

func Run(in io.Reader, out io.Writer, logger *log.Logger) error

Run starts an LSP server that reads JSON-RPC messages from in and writes responses + notifications to out. Logs go to logger (may be nil).

func RunStdio

func RunStdio(logPath string) error

RunStdio is a convenience entry point: stdin → stdout, optional log path.

Types

type CompletionItem

type CompletionItem struct {
	Label            string    `json:"label"`
	Kind             int       `json:"kind,omitempty"`
	Detail           string    `json:"detail,omitempty"`
	Documentation    string    `json:"documentation,omitempty"`
	InsertText       string    `json:"insertText,omitempty"`
	InsertTextFormat int       `json:"insertTextFormat,omitempty"`
	TextEdit         *TextEdit `json:"textEdit,omitempty"`
}

type CompletionList

type CompletionList struct {
	IsIncomplete bool             `json:"isIncomplete"`
	Items        []CompletionItem `json:"items"`
}

type CompletionOptions

type CompletionOptions struct {
	TriggerCharacters []string `json:"triggerCharacters,omitempty"`
}

type Diagnostic

type Diagnostic struct {
	Range    LSPRange `json:"range"`
	Severity int      `json:"severity,omitempty"`
	Source   string   `json:"source,omitempty"`
	Message  string   `json:"message"`
}

type DidChangeParams

type DidChangeParams struct {
	TextDocument   VersionedTextDocumentIdentifier  `json:"textDocument"`
	ContentChanges []TextDocumentContentChangeEvent `json:"contentChanges"`
}

type DidCloseParams

type DidCloseParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

type DidOpenParams

type DidOpenParams struct {
	TextDocument TextDocumentItem `json:"textDocument"`
}

type DocumentSymbol

type DocumentSymbol struct {
	Name           string           `json:"name"`
	Detail         string           `json:"detail,omitempty"`
	Kind           int              `json:"kind"`
	Range          LSPRange         `json:"range"`
	SelectionRange LSPRange         `json:"selectionRange"`
	Children       []DocumentSymbol `json:"children,omitempty"`
}

type DocumentSymbolParams

type DocumentSymbolParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
}

type Hover

type Hover struct {
	Contents MarkupContent `json:"contents"`
	Range    *LSPRange     `json:"range,omitempty"`
}

type InitializeResult

type InitializeResult struct {
	Capabilities ServerCapabilities `json:"capabilities"`
	ServerInfo   struct {
		Name    string `json:"name"`
		Version string `json:"version"`
	} `json:"serverInfo"`
}

type LSPRange

type LSPRange struct {
	Start Position `json:"start"`
	End   Position `json:"end"`
}

type Location

type Location struct {
	URI   string   `json:"uri"`
	Range LSPRange `json:"range"`
}

type MarkupContent

type MarkupContent struct {
	Kind  string `json:"kind"`
	Value string `json:"value"`
}

type Position

type Position struct {
	Line      int `json:"line"`
	Character int `json:"character"`
}

type PrepareRenameResult

type PrepareRenameResult struct {
	Range       LSPRange `json:"range"`
	Placeholder string   `json:"placeholder"`
}

type PublishDiagnosticsParams

type PublishDiagnosticsParams struct {
	URI         string       `json:"uri"`
	Diagnostics []Diagnostic `json:"diagnostics"`
}

type ReferenceContext

type ReferenceContext struct {
	IncludeDeclaration bool `json:"includeDeclaration"`
}

type ReferenceParams

type ReferenceParams struct {
	TextDocumentPositionParams
	Context ReferenceContext `json:"context"`
}

type RenameOptions

type RenameOptions struct {
	PrepareProvider bool `json:"prepareProvider"`
}

type RenameParams

type RenameParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	Position     Position               `json:"position"`
	NewName      string                 `json:"newName"`
}

type ServerCapabilities

type ServerCapabilities struct {
	TextDocumentSync       int                `json:"textDocumentSync"`
	HoverProvider          bool               `json:"hoverProvider"`
	CompletionProvider     *CompletionOptions `json:"completionProvider,omitempty"`
	DefinitionProvider     bool               `json:"definitionProvider"`
	ReferencesProvider     bool               `json:"referencesProvider"`
	RenameProvider         *RenameOptions     `json:"renameProvider,omitempty"`
	DocumentSymbolProvider bool               `json:"documentSymbolProvider"`
}

Server capabilities advertised in initialize.

type TextDocumentContentChangeEvent

type TextDocumentContentChangeEvent struct {
	Text string `json:"text"` // full-sync only (we advertise sync=Full)
}

type TextDocumentIdentifier

type TextDocumentIdentifier struct {
	URI string `json:"uri"`
}

type TextDocumentItem

type TextDocumentItem struct {
	URI        string `json:"uri"`
	LanguageID string `json:"languageId"`
	Version    int    `json:"version"`
	Text       string `json:"text"`
}

type TextDocumentPositionParams

type TextDocumentPositionParams struct {
	TextDocument TextDocumentIdentifier `json:"textDocument"`
	Position     Position               `json:"position"`
}

type TextEdit

type TextEdit struct {
	Range   LSPRange `json:"range"`
	NewText string   `json:"newText"`
}

type VersionedTextDocumentIdentifier

type VersionedTextDocumentIdentifier struct {
	URI     string `json:"uri"`
	Version int    `json:"version"`
}

type WorkspaceEdit

type WorkspaceEdit struct {
	Changes map[string][]TextEdit `json:"changes,omitempty"`
}