rulelevel

Documentation

Overview

Package rulelevel defines the level assigned to a rule violation.

Index

• type Type
  • func FailRuleLevel(ruleConfiguration ruleconfiguration.Type, ...) (Type, error)
  • func RuleLevel(ruleConfiguration ruleconfiguration.Type, ruleResult ruleresult.Type, ...) (Type, error)
  • func (i Type) String() string

Types

type Type

type Type int

Type is the type for the rule levels.

const (
	Info    Type = iota // INFO
	Warning             // WARNING
	Error               // ERROR
	Notice              // NOTICE
)

The line comments set the string for each level.

func FailRuleLevel

func FailRuleLevel(ruleConfiguration ruleconfiguration.Type, configurationRuleModes map[rulemode.Type]bool) (Type, error)

FailRuleLevel determines the level of a failed rule for the given rule modes.

func RuleLevel

func RuleLevel(ruleConfiguration ruleconfiguration.Type, ruleResult ruleresult.Type, lintedProject project.Type) (Type, error)

RuleLevel determines the rule level assigned to the given result of the given rule under the current tool configuration.

func (Type) String

func (i Type) String() string