revive/revivelib/pattern.go

package revivelib

// LintPattern indicates a pattern to be included/excluded when linting.
type LintPattern struct {
	isExclude bool
	pattern   string
}

// IsExclude determines should this pattern be included or excluded when linting.
func (p *LintPattern) IsExclude() bool {
	return p.isExclude
}

// GetPattern returns the actual pattern.
//
// Deprecated: Use [LintPattern.Pattern].
//
//go:fix inline
func (p *LintPattern) GetPattern() string {
	return p.Pattern()
}

// Pattern returns the actual pattern.
func (p *LintPattern) Pattern() string {
	return p.pattern
}

// Include this pattern when linting.
func Include(pattern string) *LintPattern {
	return &LintPattern{
		isExclude: false,
		pattern:   pattern,
	}
}

// Exclude this pattern when linting.
func Exclude(pattern string) *LintPattern {
	return &LintPattern{
		isExclude: true,
		pattern:   pattern,
	}
}