analyzer

Documentation

Index

• type Action
• type Analyzer
  • func New() *Analyzer
  • func (a *Analyzer) Analyze(ctx context.Context, request Request) (Result, error)
• type CacheStats
• type Diagnostic
• type Edit
• type Position
• type Range
• type RelatedLocation
• type Request
• type Result
  • func Analyze(ctx context.Context, request Request) (Result, error)
• type RuleMigration
• type Source

Types

type Action

type Action struct {
	DiagnosticIndex int
	RuleID          string
	Title           string
	Path            string
	Range           Range
	Edits           []Edit
}

type Analyzer

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

func New

func New() *Analyzer

func (*Analyzer) Analyze

func (a *Analyzer) Analyze(ctx context.Context, request Request) (Result, error)

type CacheStats

type CacheStats struct {
	Hits   int
	Misses int
}

type Diagnostic

type Diagnostic struct {
	RuleID   string
	Code     string
	Severity string
	Category string
	Message  string
	Path     string
	Range    Range
	Related  []RelatedLocation
}

type Edit

type Edit struct {
	Range   Range
	NewText string
}

type Position

type Position struct {
	Offset int
	Line   int
	Column int
}

type Range

type Range struct {
	Start Position
	End   Position
}

type RelatedLocation

type RelatedLocation struct {
	Range   Range
	Message string
}

type Request

type Request struct {
	Sources          []Source
	ConfigPath       string
	WorkingDirectory string
	Build            string
	IncludePaths     []string
	Defines          []string
	DefinesComplete  bool
}

type Result

type Result struct {
	Diagnostics []Diagnostic
	SafeEdits   []Action
	Suggestions []Action
	Migrations  []RuleMigration
	Cache       CacheStats
}

func Analyze

func Analyze(ctx context.Context, request Request) (Result, error)

type RuleMigration

type RuleMigration struct {
	Deprecated  string
	Replacement string
}

type Source

type Source struct {
	Path    string
	Content []byte
}