revivelib

Documentation

Overview

Package revivelib provides revive's linting functionality as a lib.

Index

• type ArrayFlags
  • func (i *ArrayFlags) Set(value string) error
  • func (i *ArrayFlags) String() string
• type ExtraRule
  • func NewExtraRule(rule lint.Rule, defaultConfig lint.RuleConfig) ExtraRule
• type LintPattern
  • func Exclude(pattern string) *LintPattern
  • func Include(pattern string) *LintPattern
  • func (p *LintPattern) GetPattern() string
  • func (p *LintPattern) IsExclude() bool
  • func (p *LintPattern) Pattern() string
• type Revive
  • func New(conf *lint.Config, setExitStatus bool, maxOpenFiles int, ...) (*Revive, error)
  • func (r *Revive) Format(formatterName string, failuresChan <-chan lint.Failure) (output string, exitCode int, err error)
  • func (r *Revive) Lint(patterns ...*LintPattern) (<-chan lint.Failure, error)

Types

type ArrayFlags

type ArrayFlags []string

ArrayFlags type for string list.

func (*ArrayFlags) Set

func (i *ArrayFlags) Set(value string) error

Set value for array flags.

func (*ArrayFlags) String

func (i *ArrayFlags) String() string

type ExtraRule

type ExtraRule struct {
	Rule          lint.Rule
	DefaultConfig lint.RuleConfig
}

ExtraRule configures a new rule to be used with revive.

func NewExtraRule

func NewExtraRule(rule lint.Rule, defaultConfig lint.RuleConfig) ExtraRule

NewExtraRule returns a configured extra rule.

type LintPattern

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

LintPattern indicates a pattern to be included/excluded when linting.

func Exclude

func Exclude(pattern string) *LintPattern

Exclude this pattern when linting.

func Include

func Include(pattern string) *LintPattern

Include this pattern when linting.

func (*LintPattern) GetPattern

func (p *LintPattern) GetPattern() string

GetPattern returns the actual pattern

Deprecated: Use [Pattern].

func (*LintPattern) IsExclude

func (p *LintPattern) IsExclude() bool

IsExclude determines should this pattern be included or excluded when linting.

func (*LintPattern) Pattern

func (p *LintPattern) Pattern() string

Pattern returns the actual pattern.

type Revive

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

Revive is responsible for running linters and formatters and returning a set of results.

func New

func New(
	conf *lint.Config,
	setExitStatus bool,
	maxOpenFiles int,
	extraRules ...ExtraRule,
) (*Revive, error)

New creates a new instance of Revive lint runner.

func (*Revive) Format

func (r *Revive) Format(
	formatterName string,
	failuresChan <-chan lint.Failure,
) (output string, exitCode int, err error)

Format gets the output for a given failures channel from Lint.

func (*Revive) Lint

func (r *Revive) Lint(patterns ...*LintPattern) (<-chan lint.Failure, error)

Lint the included patterns, skipping excluded ones.