langserver

Documentation

Index

• func RunTCPServer(ctx context.Context, addr string, config *Config) error
• type Config
  • func ReadConfig(configFile string) (*Config, error)
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (c *Config) Validate() error
• type HeadlessServer
  • func CreateHeadlessServer(ctx context.Context, prometheusClient promClient.Client, logger log.Logger) (HeadlessServer, error)
• type LogFormat
• type Server
  • func ServerFromStream(ctx context.Context, stream jsonrpc2.Stream, config *Config) (context.Context, Server)
  • func StdioServer(ctx context.Context, config *Config) (context.Context, Server)
  • func (s Server) Run() error

Functions

func RunTCPServer

func RunTCPServer(ctx context.Context, addr string, config *Config) error

RunTCPServer generates a server listening on the provided TCP Address, creating a new language Server instance using plain HTTP for every connection.

Types

type Config

type Config struct {
	RPCTrace      string    `yaml:"rpc_trace"`
	LogFormat     LogFormat `yaml:"log_format"`
	PrometheusURL string    `yaml:"prometheus_url"`
	RESTAPIPort   uint64    `yaml:"rest_api_port"`
}

Config contains the configuration for a server.

func ReadConfig

func ReadConfig(configFile string) (*Config, error)

ReadConfig gets the GlobalConfig from a configFile (that is a path to the file).

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML overrides a function used internally by the yaml.v3 lib.

func (*Config) Validate

func (c *Config) Validate() error

Validate returns an error if the config is not valid.

type HeadlessServer

type HeadlessServer interface {
	protocol.Server
	GetDiagnostics(uri protocol.DocumentURI) (*protocol.PublishDiagnosticsParams, error)
}

HeadlessServer is a modified Server interface that is used by the REST API.

func CreateHeadlessServer

func CreateHeadlessServer(ctx context.Context, prometheusClient promClient.Client, logger log.Logger) (HeadlessServer, error)

CreateHeadlessServer creates a locked down server instance for the REST API.

"locked down" in this case means, that the instance cannot send or receive any JSONRPC communication. Logging messages that the instance tries to send over JSONRPC are redirected to stderr.

type LogFormat

type LogFormat string

LogFormat is the type used for describing the format of logs.

const (
	// JSONFormat is used for JSON logs.
	JSONFormat LogFormat = "json"
	// TextFormat is used of structured text logs.
	TextFormat LogFormat = "text"
)

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server wraps language server instance that can connect to exactly one client.

func ServerFromStream

func ServerFromStream(ctx context.Context, stream jsonrpc2.Stream, config *Config) (context.Context, Server)

ServerFromStream generates a Server from a jsonrpc2.Stream.

func StdioServer

func StdioServer(ctx context.Context, config *Config) (context.Context, Server)

StdioServer generates a Server instance talking to stdio.

func (Server) Run

func (s Server) Run() error

Run starts the language server instance.