scanner

Documentation

Index

• func DeregisterCheckRule(r rule.Rule)
• func GetRegisteredRules() []rule.Rule
• func GetRuleById(ID string) (*rule.Rule, error)
• func GetRuleByLegacyID(legacyID string) (*rule.Rule, error)
• func OptionExcludeRules(ruleIDs []string) func(s *Scanner)
• func OptionIgnoreCheckErrors(ignore bool) func(s *Scanner)
• func OptionIncludeIgnored() func(s *Scanner)
• func OptionIncludePassed() func(s *Scanner)
• func OptionWithWorkspaceName(workspaceName string) func(s *Scanner)
• func RegisterCheckRule(rule rule.Rule)
• type Option
• type Scanner
  • func New(options ...Option) *Scanner
  • func (scanner *Scanner) Scan(blocks []block.Block) []result.Result
• type Statistics
  • func AddStatisticsCount(StatisticsSlice Statistics, result result.Result) Statistics
  • func SortStatistics(statistics Statistics) Statistics
  • func (statistics Statistics) PrintStatisticsTable()
• type StatisticsItem

Functions

func DeregisterCheckRule

func DeregisterCheckRule(r rule.Rule)

func GetRegisteredRules

func GetRegisteredRules() []rule.Rule

GetRegisteredRules provides all Checks which have been registered with this package

func GetRuleById

func GetRuleById(ID string) (*rule.Rule, error)

func GetRuleByLegacyID

func GetRuleByLegacyID(legacyID string) (*rule.Rule, error)

func OptionExcludeRules

func OptionExcludeRules(ruleIDs []string) func(s *Scanner)

func OptionIgnoreCheckErrors

func OptionIgnoreCheckErrors(ignore bool) func(s *Scanner)

func OptionIncludeIgnored

func OptionIncludeIgnored() func(s *Scanner)

func OptionIncludePassed

func OptionIncludePassed() func(s *Scanner)

func OptionWithWorkspaceName

func OptionWithWorkspaceName(workspaceName string) func(s *Scanner)

func RegisterCheckRule

func RegisterCheckRule(rule rule.Rule)

RegisterCheckRule registers a new Rule which should be run on future scans

Types

type Option

type Option func(s *Scanner)

type Scanner

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

Scanner scans HCL blocks by running all registered rules against them

func New

func New(options ...Option) *Scanner

New creates a new Scanner

func (*Scanner) Scan

func (scanner *Scanner) Scan(blocks []block.Block) []result.Result

type Statistics

type Statistics []StatisticsItem

func AddStatisticsCount

func AddStatisticsCount(StatisticsSlice Statistics, result result.Result) Statistics

func SortStatistics

func SortStatistics(statistics Statistics) Statistics

func (Statistics) PrintStatisticsTable

func (statistics Statistics) PrintStatisticsTable()

type StatisticsItem

type StatisticsItem struct {
	RuleID          string
	RuleDescription string
	Links           []string
	Count           int
}