analysis

Documentation

Index

• func DeleteKey(field *fleetpkg.Field, key string, pass *Pass) (modified bool, err error)
• func VisitFields(fields []*fleetpkg.Field, v func(*fleetpkg.Field) error) error
• type AST
• type Analyzer
• type Diagnostic
• type Pass
• type Pos
  • func NewPos(meta fleetpkg.FileMetadata) Pos
  • func (p Pos) MarshalJSON() ([]byte, error)
  • func (p Pos) String() string
• type Printer
• type RelatedInformation

Functions

func DeleteKey

func DeleteKey(field *fleetpkg.Field, key string, pass *Pass) (modified bool, err error)

DeleteKey deletes the specified key from the AST associated with the given field. If pass.Fix is false, then this is a no-op.

func VisitFields

func VisitFields(fields []*fleetpkg.Field, v func(*fleetpkg.Field) error) error

VisitFields can be used to iterate over non-flat fields. Use this when you need to analyze attributes of non-leaf fields.

Types

type AST

type AST struct {
	File     *ast.File
	Modified bool // Modified tracks whether File has been modified.
}

type Analyzer

type Analyzer struct {
	Name        string
	Description string
	CanFix      bool
	Requires    []*Analyzer

	Flags flag.FlagSet

	Run func(*Pass) (interface{}, error)
}

type Diagnostic

type Diagnostic struct {
	Pos      Pos
	Category string
	Message  string
	Related  []RelatedInformation `json:"Related,omitempty"`
}

type Pass

type Pass struct {
	Analyzer *Analyzer

	Fix bool // Should the analyzer apply fixes to AST?

	// Field information.
	Fields []*fleetpkg.Field // Fields from every file.
	Flat   []*fleetpkg.Field // Flat view of all fields sorted by file and line number.

	// Map of file paths to the AST of that file. This is available when Fix is true.
	// Analyzers may add, modify, and delete map attributes, but they should not
	// add or remove entire field list entries (any operation that changes indices
	// in YAML paths would break other analyzers).
	AST map[string]*AST

	// ResultOf provides the inputs to this analysis pass, which are
	// the corresponding results of its prerequisite analyzers.
	// The map keys are the elements of Analysis.Required,
	// and the type of each corresponding value is the required
	// analysis's ResultType.
	ResultOf map[*Analyzer]interface{}

	Report func(Diagnostic)
}

type Pos

type Pos struct {
	File string
	Line int
	Col  int
}

func NewPos

func NewPos(meta fleetpkg.FileMetadata) Pos

func (Pos) MarshalJSON

func (p Pos) MarshalJSON() ([]byte, error)

func (Pos) String

func (p Pos) String() string

type Printer

type Printer func(diags []Diagnostic, w io.Writer)

type RelatedInformation

type RelatedInformation struct {
	Pos     Pos
	Message string
}