formatter

Documentation

Index

• type Checkstyle
  • func (f *Checkstyle) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)
  • func (f *Checkstyle) Name() string
• type Default
  • func (f *Default) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)
  • func (f *Default) Name() string
• type Friendly
  • func (f *Friendly) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)
  • func (f *Friendly) Name() string
• type JSON
  • func (f *JSON) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)
  • func (f *JSON) Name() string
• type NDJSON
  • func (f *NDJSON) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)
  • func (f *NDJSON) Name() string
• type Stylish
  • func (f *Stylish) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)
  • func (f *Stylish) Name() string

Types

type Checkstyle

type Checkstyle struct {
	Metadata lint.FormatterMetadata
}

Checkstyle is an implementation of the Formatter interface which formats the errors to Checkstyle-like format.

func (*Checkstyle) Format

func (f *Checkstyle) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)

Format formats the failures gotten from the lint.

func (*Checkstyle) Name

func (f *Checkstyle) Name() string

Name returns the name of the formatter

type Default

type Default struct {
	Metadata lint.FormatterMetadata
}

Default is an implementation of the Formatter interface which formats the errors to JSON.

func (*Default) Format

func (f *Default) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)

Format formats the failures gotten from the lint.

func (*Default) Name

func (f *Default) Name() string

Name returns the name of the formatter

type Friendly

type Friendly struct {
	Metadata lint.FormatterMetadata
}

Friendly is an implementation of the Formatter interface which formats the errors to JSON.

func (*Friendly) Format

func (f *Friendly) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)

Format formats the failures gotten from the lint.

func (*Friendly) Name

func (f *Friendly) Name() string

Name returns the name of the formatter

type JSON

type JSON struct {
	Metadata lint.FormatterMetadata
}

JSON is an implementation of the Formatter interface which formats the errors to JSON.

func (*JSON) Format

func (f *JSON) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)

Format formats the failures gotten from the lint.

func (*JSON) Name

func (f *JSON) Name() string

Name returns the name of the formatter

type NDJSON

type NDJSON struct {
	Metadata lint.FormatterMetadata
}

NDJSON is an implementation of the Formatter interface which formats the errors to NDJSON stream.

func (*NDJSON) Format

func (f *NDJSON) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)

Format formats the failures gotten from the lint.

func (*NDJSON) Name

func (f *NDJSON) Name() string

Name returns the name of the formatter

type Stylish

type Stylish struct {
	Metadata lint.FormatterMetadata
}

Stylish is an implementation of the Formatter interface which formats the errors to JSON.

func (*Stylish) Format

func (f *Stylish) Format(failures <-chan lint.Failure, config lint.RulesConfig) (string, error)

Format formats the failures gotten from the lint.

func (*Stylish) Name

func (f *Stylish) Name() string

Name returns the name of the formatter