fixer

Documentation

Index

• type Fixer
  • func NewFixer() *Fixer
  • func (f *Fixer) Fix(ctx context.Context, l *linter.Linter, fp fileprovider.FileProvider) (*Report, error)
  • func (f *Fixer) GetFixForName(name string) (fixes.Fix, bool)
  • func (f *Fixer) RegisterFixes(fixes ...fixes.Fix)
• type PrettyReporter
  • func NewPrettyReporter(outputWriter io.Writer) *PrettyReporter
  • func (r *PrettyReporter) Report(fixReport *Report) error
• type Report
  • func NewReport() *Report
  • func (r *Report) FixedFiles() []string
  • func (r *Report) FixedViolationsForFile(file string) []string
  • func (r *Report) SetFileFixedViolation(file string, violation string)
  • func (r *Report) TotalFixes() int
• type Reporter
  • func ReporterForFormat(format string, outputWriter io.Writer) (Reporter, error)

Types

type Fixer

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

func NewFixer

func NewFixer() *Fixer

func (*Fixer) Fix

func (f *Fixer) Fix(ctx context.Context, l *linter.Linter, fp fileprovider.FileProvider) (*Report, error)

func (*Fixer) GetFixForName

func (f *Fixer) GetFixForName(name string) (fixes.Fix, bool)

func (*Fixer) RegisterFixes

func (f *Fixer) RegisterFixes(fixes ...fixes.Fix)

type PrettyReporter

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

PrettyReporter outputs a fix report in a human-readable format.

func NewPrettyReporter

func NewPrettyReporter(outputWriter io.Writer) *PrettyReporter

func (*PrettyReporter) Report

func (r *PrettyReporter) Report(fixReport *Report) error

type Report

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

Report contains updated file contents and summary information about the fixes that were applied during a fix operation.

func NewReport

func NewReport() *Report

func (*Report) FixedFiles

func (r *Report) FixedFiles() []string

func (*Report) FixedViolationsForFile

func (r *Report) FixedViolationsForFile(file string) []string

func (*Report) SetFileFixedViolation

func (r *Report) SetFileFixedViolation(file string, violation string)

func (*Report) TotalFixes

func (r *Report) TotalFixes() int

type Reporter

type Reporter interface {
	Report(*Report) error
}

Reporter is responsible for outputting a fix report in a specific format.

func ReporterForFormat

func ReporterForFormat(format string, outputWriter io.Writer) (Reporter, error)

ReporterForFormat returns a suitable Reporter for outputting a fix report in the given format.