Configuration

Documentation

Index

• type Configuration
  • func NewConfiguration() *Configuration
  • func (c *Configuration) SetExcludePatterns(patterns []string)
  • func (c *Configuration) SetSourcesToAnalyzePath(paths []string) error
• type ConfigurationDefaultRule
• type ConfigurationLoader
  • func NewConfigurationLoader() *ConfigurationLoader
  • func (c *ConfigurationLoader) CreateDefaultFile() error
  • func (c *ConfigurationLoader) Import(yamlString string) (*Configuration, error)
  • func (c *ConfigurationLoader) Loads(cfg *Configuration) (*Configuration, error)
• type ConfigurationReport
• type ConfigurationRequirements

Types

type Configuration

type Configuration struct {
	// The path to the sources to analyze
	SourcesToAnalyzePath []string `yaml:"sources"`

	// Exclude patterns (list of regular expressions. When a file matches one of these patterns, it is not analyzed)
	ExcludePatterns []string `yaml:"exclude"`

	// Reports
	Reports ConfigurationReport `yaml:"reports"`

	// Requirements
	Requirements *ConfigurationRequirements `yaml:"requirements"`

	Watching bool

	// if not empty, compare the current analysis with the one in this branch / commit
	CompareWith string

	// Location of cache files
	Storage *Storage.Workdir
}

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) SetExcludePatterns

func (c *Configuration) SetExcludePatterns(patterns []string)

func (*Configuration) SetSourcesToAnalyzePath

func (c *Configuration) SetSourcesToAnalyzePath(paths []string) error

type ConfigurationDefaultRule

type ConfigurationDefaultRule struct {
	Max             int      `yaml:"max"`
	Min             int      `yaml:"min"`
	ExcludePatterns []string `yaml:"exclude"`
}

type ConfigurationLoader

type ConfigurationLoader struct {
	FilenameToChecks []string
}

func NewConfigurationLoader

func NewConfigurationLoader() *ConfigurationLoader

func (*ConfigurationLoader) CreateDefaultFile

func (c *ConfigurationLoader) CreateDefaultFile() error

func (*ConfigurationLoader) Import

func (c *ConfigurationLoader) Import(yamlString string) (*Configuration, error)

func (*ConfigurationLoader) Loads

func (c *ConfigurationLoader) Loads(cfg *Configuration) (*Configuration, error)

type ConfigurationReport

type ConfigurationReport struct {
	Html     string `yaml:"html"`
	Markdown string `yaml:"markdown"`
}

type ConfigurationRequirements

type ConfigurationRequirements struct {
	Rules *struct {
		CyclomaticComplexity *ConfigurationDefaultRule `yaml:"cyclomatic_complexity"`
		Loc                  *ConfigurationDefaultRule `yaml:"loc"`
		Maintainability      *ConfigurationDefaultRule `yaml:"maintainability"`
		Coupling             *struct {
			Forbidden []struct {
				From string `yaml:"from"`
				To   string `yaml:"to"`
			} `yaml:"forbidden"`
		} `yaml:"coupling"`
	} `yaml:"rules"`

	FailOnError bool `yaml:"fail_on_error"`
}