squealer

Documentation

Index

• type Option
  • func OptionNoGitScan(noGit bool) Option
  • func OptionRedactedSecrets(redacted bool) Option
  • func OptionWithBasePath(basePath string) Option
  • func OptionWithCommitListFile(commitListFile string) Option
  • func OptionWithConfig(config *config.Config) Option
  • func OptionWithFromHash(fromHash string) Option
  • func OptionWithScanEverything(everything bool) Option
  • func OptionWithToHash(toHash string) Option
• type Scanner
  • func New(options ...Option) (*Scanner, error)
  • func (s *Scanner) GetMetrics() *metrics.Metrics
  • func (s *Scanner) Scan() ([]match.Transgression, error)
• type StringScanner
  • func NewStringScanner() *StringScanner
  • func NewStringScannerWithConfig(conf *config.Config) *StringScanner
  • func (s StringScanner) Scan(content string) result.StringScanResult

Types

type Option

type Option func(s *Scanner)

func OptionNoGitScan

func OptionNoGitScan(noGit bool) Option

func OptionRedactedSecrets

func OptionRedactedSecrets(redacted bool) Option

func OptionWithBasePath

func OptionWithBasePath(basePath string) Option

func OptionWithCommitListFile

func OptionWithCommitListFile(commitListFile string) Option

func OptionWithConfig

func OptionWithConfig(config *config.Config) Option

func OptionWithFromHash

func OptionWithFromHash(fromHash string) Option

func OptionWithScanEverything

func OptionWithScanEverything(everything bool) Option

func OptionWithToHash

func OptionWithToHash(toHash string) Option

type Scanner

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

func New

func New(options ...Option) (*Scanner, error)

func (*Scanner) GetMetrics

func (s *Scanner) GetMetrics() *metrics.Metrics

func (*Scanner) Scan

func (s *Scanner) Scan() ([]match.Transgression, error)

type StringScanner

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

func NewStringScanner

func NewStringScanner() *StringScanner

func NewStringScannerWithConfig

func NewStringScannerWithConfig(conf *config.Config) *StringScanner

func (StringScanner) Scan

func (s StringScanner) Scan(content string) result.StringScanResult