lspframework/

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 ¶

Forked code from golang.org/x/tools/internal/

Original gopls intentions

From what I can see, the gopls implementation was originally written to support multiple workspaces connecting to a remote gopls instance as well as connecting locally. This is probably so multiple editors with a LSP client can connect to a single process. (NOT EXACTLY SURE IF THIS IS TRUE)

The sysl lsp server will not contain this feature and each client will create a new instance of the sysl lsp server (at least for now)

Forked on 2020/03/12

This folder mostly contains forked lsp code from the gopls implementation.
Some code is modified. Code which is modified is prepended with a comment // MODIFIED: SYSL_LSP
A general overview of how this lsp extension works:
- The LSP interface and data structures are transpiled from TypeScript to Golang using the typescript repository: https://github.com/microsoft/vscode-languageserver-node.
  - This is located in the internal/protocol/ folder and more information is contained there.
- The rest of the code is wrapped/frameworking code to originally provide gopls with debugging/golang diagnostics
  - The only partly stripped/modified code is the debugging server for lsprpc (which currently is not working, but may be used for future debugging)
- There is a helper/helper.go binary for server.go generation --> more information located in the internal/lsp/helper/ folder
- Use the helper binary to generate the concrete server implementation (maps the function to the lsp protocol call)
  - e.g. "textDocument/didOpen" --> mapped to func (s *Server) didOpen(ctx context.Context, params *protocol.DidOpenTextDocumentParams) error in internal/lspimpl/text_synchronization.go
  - Output file resulted in internal/lspimpl/server_gen.go

Folder structure

internal/jsonrpc2: contains a minimal implementation of the jsonrpc2 spec
internal/span: contains some code for OS independent file names and positions and ranges in files
internal/lsp: lsp frameworking code
internal/telemetry: seems to be telemetry code for prometheous or ocagent (used by the autogenerator)
internal/xcontext: extra functionality for the inbuilt context package (used by the autogenerator)
pkg/lspimpl (non gopls code): this package is created to separate lsp framework code from the sysl diagnostic code

Updating instructions

Update the ts protocol files in go. Instructions in internal/lsp/protocol/typescript/README.md
Compile helper binary in internal/lsp/helper/ [cd internal/lsp/helper && go build .]
Generate server_gen.go in pkg/lspimpl/ [cd ../pkg/lspimpl && go generate server.go]
Compile sysllsp [make buildlsp] in project root

Directories ¶

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

Path	Synopsis
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.
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
debug Package debug exports debug information for gopls.	Package debug exports debug information for gopls.
helper Invoke with //go:generate helper/helper -t Server -d protocol/tsserver.go -u lsp -o server_gen.go invoke in lspframework/lsp	Invoke with //go:generate helper/helper -t Server -d protocol/tsserver.go -u lsp -o server_gen.go invoke in lspframework/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".
telemetry Package telemetry provides the hooks and adapters to allow use of telemetry throughout gopls.	Package telemetry provides the hooks and adapters to allow use of telemetry throughout gopls.
span Package span contains support for representing with positions and ranges in text files.	Package span contains support for representing with positions and ranges in text files.
telemetry Package telemetry provides an opinionated set of packages that cover the main concepts of telemetry in an implementation agnostic way.	Package telemetry provides an opinionated set of packages that cover the main concepts of telemetry in an implementation agnostic way.
export Package export holds the definition of the telemetry Exporter interface, along with some simple implementations.	Package export holds the definition of the telemetry Exporter interface, along with some simple implementations.
export/ocagent Package ocagent adds the ability to export all telemetry to an ocagent.	Package ocagent adds the ability to export all telemetry to an ocagent.
export/ocagent/wire
export/prometheus
log Package log is a context based logging package, designed to interact well with both the lsp protocol and the other telemetry packages.	Package log is a context based logging package, designed to interact well with both the lsp protocol and the other telemetry packages.
metric Package metric aggregates stats into metrics that can be exported.	Package metric aggregates stats into metrics that can be exported.
stats Package stats provides support for recording telemetry statistics.	Package stats provides support for recording telemetry statistics.
tag Package tag provides support for telemetry tagging.	Package tag provides support for telemetry tagging.
trace Package trace adds support for telemetry tracing.	Package trace adds support for telemetry tracing.
unit Package unit holds the definitions for the units you can use in telemetry.	Package unit holds the definitions for the units you can use in telemetry.
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.