scanner

Documentation

Index

• type Metrics
• type Option
  • func OptionExcludeRules(ruleIDs []string) Option
  • func OptionIncludeIgnored(include bool) Option
  • func OptionIncludePassed(include bool) Option
  • func OptionIncludeRules(ruleIDs []string) Option
  • func OptionScanAllDirectories(all bool) Option
  • func OptionSkipDownloaded(skip bool) Option
  • func OptionStopOnHCLError(stop bool) Option
  • func OptionStopOnRuleErrors(stop bool) Option
  • func OptionWithConfigFile(path string) Option
  • func OptionWithCustomCheckDir(dir string) Option
  • func OptionWithDebugWriter(w io.Writer) Option
  • func OptionWithExcludePaths(paths []string) Option
  • func OptionWithIncludeOnlyResults(ids []string) Option
  • func OptionWithSingleThread(single bool) Option
  • func OptionWithTFVarsPaths(paths []string) Option
  • func OptionWithWorkspaceName(name string) Option
• type Scanner
  • func New(options ...Option) *Scanner
  • func (s *Scanner) AddPath(path string) error
  • func (s *Scanner) Scan() (rules.Results, Metrics, error)

Types

type Metrics

type Metrics struct {
	Parser   parser.Metrics
	Executor executor.Metrics
	Timings  struct {
		Total time.Duration
	}
}

type Option

type Option func(s *Scanner)

func OptionExcludeRules

func OptionExcludeRules(ruleIDs []string) Option

func OptionIncludeIgnored

func OptionIncludeIgnored(include bool) Option

func OptionIncludePassed

func OptionIncludePassed(include bool) Option

func OptionIncludeRules

func OptionIncludeRules(ruleIDs []string) Option

func OptionScanAllDirectories

func OptionScanAllDirectories(all bool) Option

func OptionSkipDownloaded

func OptionSkipDownloaded(skip bool) Option

func OptionStopOnHCLError

func OptionStopOnHCLError(stop bool) Option

func OptionStopOnRuleErrors

func OptionStopOnRuleErrors(stop bool) Option

func OptionWithConfigFile

func OptionWithConfigFile(path string) Option

func OptionWithCustomCheckDir

func OptionWithCustomCheckDir(dir string) Option

func OptionWithDebugWriter

func OptionWithDebugWriter(w io.Writer) Option

func OptionWithExcludePaths

func OptionWithExcludePaths(paths []string) Option

func OptionWithIncludeOnlyResults

func OptionWithIncludeOnlyResults(ids []string) Option

func OptionWithSingleThread

func OptionWithSingleThread(single bool) Option

func OptionWithTFVarsPaths

func OptionWithTFVarsPaths(paths []string) Option

func OptionWithWorkspaceName

func OptionWithWorkspaceName(name string) Option

type Scanner

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

func New

func New(options ...Option) *Scanner

func (*Scanner) AddPath

func (s *Scanner) AddPath(path string) error

func (*Scanner) Scan

func (s *Scanner) Scan() (rules.Results, Metrics, error)