disablerule

Documentation

Index

• Constants
• Variables
• type Interpreter
  • func NewInterpreter(ruleID string) *Interpreter
  • func (i *Interpreter) CallEachIfValid(lines []string, f func(index int, line string))
  • func (i *Interpreter) Interpret(comments []*parser.Comment, inlines ...*parser.Comment) (isDisabled bool)

Constants

const (
	PrefixDisable     = `protolint:disable`
	PrefixEnable      = `protolint:enable`
	PrefixDisableNext = `protolint:disable:next`
	PrefixDisableThis = `protolint:disable:this`
)

comment prefix

Variables

var (
	ReDisable     = regexp.MustCompile(PrefixDisable + ` (.*)`)
	ReEnable      = regexp.MustCompile(PrefixEnable + ` (.*)`)
	ReDisableNext = regexp.MustCompile(PrefixDisableNext + ` (.*)`)
	ReDisableThis = regexp.MustCompile(PrefixDisableThis + ` (.*)`)
)

comment prefix regexp

Types

type Interpreter

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

Interpreter represents an interpreter for disable rule comments.

func NewInterpreter

func NewInterpreter(
	ruleID string,
) *Interpreter

NewInterpreter creates an Interpreter.

func (*Interpreter) CallEachIfValid

func (i *Interpreter) CallEachIfValid(
	lines []string,
	f func(index int, line string),
)

CallEachIfValid calls a given function each time the line is not disabled.

func (*Interpreter) Interpret

func (i *Interpreter) Interpret(
	comments []*parser.Comment,
	inlines ...*parser.Comment,
) (isDisabled bool)

Interpret interprets comments and returns a bool whether not apply the rule to a next or this element.