engine

Documentation

Index

• Constants
• type BigFileConfig
• type Clone
• type Config
  • func DefaultConfig() Config
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type CopyCheckConfig
• type CycloConfig
• type Executor
• type LintersConfig
• type LintersSettingsConfig
• type LongFuncConfig
• type Parameter
• type SecurityConfig
• type Summary
  • func RunAllTools(param Parameter, config Config) []Summary
  • func (s Summary) Print()

Constants

const (
	CyclomaticComplexity = "cyclo"
	UintTest             = "unittest"
	BigFile              = "bigFile"
	LongFunc             = "longFunc"
	CopyCheck            = "copyCheck"
	Security             = "security"
	Syntax               = "syntax"
)

const (
	Json    = "json"
	Console = "console"
)

Types

type BigFileConfig

type BigFileConfig struct {
	MaxLines int `yaml:"maxLines"`
}

type Clone

type Clone struct {
	Filename  string `json:"filename"`
	LineStart int    `json:"lineStart"`
	LineEnd   int    `json:"lineEnd"`
	Fragment  []byte `json:"fragment"`
}

type Config

type Config struct {
	IgnoreError     bool                  `yaml:"ignoreError"`
	ReportType      string                `yaml:"reportType"`
	Linters         LintersConfig         `yaml:"linters"`
	LintersSettings LintersSettingsConfig `yaml:"linters-settings"`
}

func DefaultConfig

func DefaultConfig() Config

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

type CopyCheckConfig

type CopyCheckConfig struct {
	Threshold  int    `yaml:"threshold"`
	IgnoreRegx string `yaml:"ignoreRegx"`
}

type CycloConfig

type CycloConfig struct {
	IgnoreRegx string `yaml:"ignoreRegx"`
	Over       int    `yaml:"over"`
}

type Executor

type Executor interface {
	Compute(param Parameter, config Config) Summary
}

type LintersConfig

type LintersConfig struct {
	Enable []string `yaml:"enable"`
}

type LintersSettingsConfig

type LintersSettingsConfig struct {
	Cyclo     CycloConfig     `yaml:"cyclo"`
	BigFile   BigFileConfig   `yaml:"bigFile"`
	LongFunc  LongFuncConfig  `yaml:"longFunc"`
	CopyCheck CopyCheckConfig `yaml:"copyCheck"`
	Security  SecurityConfig  `yaml:"security"`
}

type LongFuncConfig

type LongFuncConfig struct {
	MaxLength int `yaml:"maxLength"`
}

type Parameter

type Parameter struct {
	Path []string
}

type SecurityConfig

type SecurityConfig struct {
	Env []string `yaml:"env"`
}

type Summary

type Summary struct {
	Name     string                 `json:"name"`
	Value    float64                `json:"value"`
	Details  map[string]interface{} `json:"details"`
	Duration float64                `json:"duration"`
	Err      error                  `json:"error"`
}

func RunAllTools

func RunAllTools(param Parameter, config Config) []Summary

func (Summary) Print

func (s Summary) Print()