quickfix

Documentation

Overview

Package quickfix carries the source edits that resolve a diagnostic, attached by the layer that reported it and rendered by an editor as a quick fix.

Index

• type Edit
  • func Insert(offset int, text string) Edit
  • func InsertLine(offset int, text string) Edit
  • func Replace(span source.Span, text string) Edit
  • func (e Edit) Render(content []byte) (source.Span, string)
• type Fix

Types

type Edit

type Edit struct {
	Span    source.Span
	NewText string
	// OwnLine makes the edit a whole line inserted before Span.Offset, indented
	// like the line that offset sits on (see Render).
	OwnLine bool
}

Edit replaces the text a span covers. A zero-length span is an insertion at its offset.

func Insert

func Insert(offset int, text string) Edit

Insert returns an insertion of text at offset.

func InsertLine

func InsertLine(offset int, text string) Edit

InsertLine returns an insertion of text as its own line before offset.

func Replace

func Replace(span source.Span, text string) Edit

Replace returns a replacement of the text span covers with text.

func (Edit) Render

func (e Edit) Render(content []byte) (source.Span, string)

Render resolves an edit against its document, returning the span to replace and the replacement. An own-line edit keeps the line it precedes on its own line.

type Fix

type Fix struct {
	Title     string
	Edits     []Edit
	Preferred bool
}

Fix is one unambiguous way to resolve a diagnostic, within the document that diagnostic belongs to. Preferred marks a fix an editor may apply unprompted.