lsp/

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/anz-bank/sysl

Links

Open Source Insights

README ¶

Sysl LSP Language Server Implementation

(forked from https://github.com/golang/tools/tree/378b9e1d59e2352276eff57e8153a4ff4053d8a7/internal/lsp)

gopls is a sophisticated LSP implementation providing language features for Golang. It's a large project that contains a combination of business logic, plumbing and boilerplate. Unfortunately it's all internal and can't be used as a library.

This Sysl LSP language server implementation copies the boilerplate from gopls, removes most of the plumbing for unnecessary features (e.g. remote servers, telemetry), and focuses on the much simpler Sysl language business logic.

Usage

For simple distribution, the Sysl LSP language server is built into the Sysl binary. It can be invoked via stdio with the command:

sysl lsp

Design

The LSP interface and data structures are transpiled from TypeScript to Golang using the TypeScript repository https://github.com/microsoft/vscode-languageserver-node.
server.go declares the main Server struct, to which all LSP handler functions are added in server_gen.go.
lsp/helper/helper.go generates the stub implementations in server_gen.go based on the existence of appropriately-named methods on Server in this package. Run make generate in the root directory to regenerate it with any changes in available methods.
The business logic for the various language features is divided between files in impl (other than server.go and server_gen.go).

Folder structure

framework/: The LSP boilerplate and plumbing copied from gopls
- fakenet/: implementation of the net.Conn interface over a reader and writer (used for stdio)
- jsonrpc2/: minimal implementation of the JSON-RPC 2.0 spec
- lsp/: LSP server boilerplate derived from the spec
- xcontext/: extra functionality for the in-built context package
impl/: business logic computing and providing Sysl language feature content to client
server/: Connects the server in impl to a stream

Directories ¶

Path	Synopsis
framework
fakenet
jsonrpc2 Package jsonrpc2 is a minimal implementation of the JSON RPC 2 spec.	Package jsonrpc2 is a minimal implementation of the JSON RPC 2 spec.
jsonrpc2/servertest Package servertest provides utilities for running tests against a remote LSP server.	Package servertest provides utilities for running tests against a remote LSP server.
lsp/helper Invoke with //go:generate helper/helper -t Server -d protocol/tsserver.go -u lsp -o server_gen.go invoke in internal/lsp	Invoke with //go:generate helper/helper -t Server -d protocol/tsserver.go -u lsp -o server_gen.go invoke in internal/lsp
lsp/protocol Package protocol contains the structs that map directly to the wire format of the "Language Server Protocol".	Package protocol contains the structs that map directly to the wire format of the "Language Server Protocol".
xcontext Package xcontext is a package to offer the extra functionality we need from contexts that is not available from the standard context package.	Package xcontext is a package to offer the extra functionality we need from contexts that is not available from the standard context package.
impl Package impl implements LSP for sysl.	Package impl implements LSP for sysl.
server Package lsp/server implements a jsonrpc2.StreamServer that may be used to serve the LSP on a jsonrpc2 channel.	Package lsp/server implements a jsonrpc2.StreamServer that may be used to serve the LSP on a jsonrpc2 channel.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL