autodisable

Documentation

Index

• type PlacementStrategy
  • func NewPlacementStrategy(ptype PlacementType, filename, ruleID string) (PlacementStrategy, error)
• type PlacementType

Types

type PlacementStrategy

type PlacementStrategy interface {
	Disable(offset int, comments []*parser.Comment, inline *parser.Comment)
	Finalize() error
}

PlacementStrategy is an abstraction to put a comment.

func NewPlacementStrategy

func NewPlacementStrategy(ptype PlacementType, filename, ruleID string) (PlacementStrategy, error)

NewPlacementStrategy creates a strategy object.

type PlacementType

type PlacementType int

PlacementType is a selection of the placement strategies.

const (
	// Noop does nothing
	Noop PlacementType = iota
	// ThisThenNext puts inline comments.
	ThisThenNext
	// Next puts newline comments.
	Next
)