diagnostics

package

v1.0.7 Latest Latest Go to latest Published: Mar 8, 2022 License: MIT Imports: 5 Imported by: 0

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

This section is empty.

This section is empty.

This section is empty.

type DocumentContext struct {
	Ctx         context.Context
	URI         lsp.DocumentURI
	Diagnostics []lsp.Diagnostic
}

DocumentContext contains data about the document on which we have performed the diagnostics on.

type Notifier struct {
	SessionCtx       context.Context
	TSCDocs          chan DocumentContext
	CloseTSCDocsOnce sync.Once
}

Notifier contains a channel representing TSC documents with diagnostics, as well as methods for publishing new diagnostics.

func NewNotifier(sessionCtx context.Context, logger *log.Logger) *Notifier

NewNotifier creates a new Notifier instance for running a goroutine that sends out diagnostics to all documents in the channel.

func (n *Notifier) Diagnose(ctx context.Context, uri lsp.DocumentURI, diagnostics []lsp.Diagnostic)

Diagnose will enqueue a document and a slice of diagnostics for publishing. Notifications will be delivered in the order of the queue.