scanner

Documentation

Index

• func DeregisterRuleByID(id string)
• func GetRegisteredRules() []cfRules.Rule
• func GetRuleByLongID(long string) (*cfRules.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(rules ...cfRules.Rule)
• type Ignore
• type Option
• type Scanner
  • func New(options ...Option) *Scanner
  • func (scanner *Scanner) Scan(contexts parser.FileContexts) []rules.Result

Functions

func DeregisterRuleByID

func DeregisterRuleByID(id string)

func GetRegisteredRules

func GetRegisteredRules() []cfRules.Rule

func GetRuleByLongID

func GetRuleByLongID(long string) (*cfRules.Rule, error)

GetRuleByLongID ...

func OptionExcludeRules

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

OptionExcludeRules ...

func OptionIgnoreCheckErrors

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

OptionIgnoreCheckErrors ...

func OptionIncludeIgnored

func OptionIncludeIgnored() func(s *Scanner)

OptionIncludeIgnored ...

func OptionIncludePassed

func OptionIncludePassed() func(s *Scanner)

OptionIncludePassed ...

func OptionWithWorkspaceName

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

OptionWithWorkspaceName ...

func RegisterCheckRule

func RegisterCheckRule(rules ...cfRules.Rule)

Types

type Ignore

type Ignore struct {
	RuleID string
	Expiry *time.Time
}

type Option

type Option func(s *Scanner)

Option ...

type Scanner

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

Scanner ...

func New

func New(options ...Option) *Scanner

New creates a new Scanner

func (*Scanner) Scan

func (scanner *Scanner) Scan(contexts parser.FileContexts) []rules.Result

Scan ...