rule

Documentation

Index

• type HasApply
• type HasID
• type HasIsOfficial
• type HasPurpose
• type HasSeverity
• type Rule
• type Severity

Types

type HasApply

type HasApply interface {
	// Apply applies the rule to the proto.
	Apply(proto *parser.Proto) ([]report.Failure, error)
}

HasApply represents a rule which can be applied.

type HasID

type HasID interface {
	// ID returns the ID of this rule. This should be all UPPER_SNAKE_CASE.
	ID() string
}

HasID represents a rule with ID.

type HasIsOfficial

type HasIsOfficial interface {
	// IsOfficial decides whether or not this rule belongs to the official guide.
	IsOfficial() bool
}

HasIsOfficial represents a rule with IsOfficial.

type HasPurpose

type HasPurpose interface {
	// Purpose returns the purpose of this rule. This should be a human-readable string.
	Purpose() string
}

HasPurpose represents a rule with Purpose.

type HasSeverity

type HasSeverity interface {
	// Severity returns the selected severity of a rule
	Severity() Severity
}

HasSeverity represents a rule with a configurable severity

type Rule

type Rule interface {
	HasApply
	HasID
	HasPurpose
	HasIsOfficial
	HasSeverity
}

Rule represents a rule which a linter can apply.

type Severity

type Severity string

Severity represents the severity of the rule. All failues will have this severity on export.

const (
	// SeverityNote represents a note only rule severity
	SeverityNote Severity = "note"
	// SeverityWarning represents a rule severity at a warning level
	SeverityWarning Severity = "warning"
	// SeverityError represents a rule severity at a warning level
	SeverityError Severity = "error"
)