config

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 14, 2025 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Category

type Category string
const (
	CategoryStyle       Category = "style"
	CategoryBugRisk     Category = "bug-risk"
	CategoryAntipattern Category = "antipattern"
	CategoryPerformance Category = "performance"
	CategorySecurity    Category = "security"
)

func (Category) IsValid

func (c Category) IsValid() bool

type Config

type Config struct {
	CheckerDir       string        `yaml:"checkerDir"`
	EnabledCheckers  []string      `yaml:"enabledCheckers"`
	DisabledCheckers []string      `yaml:"disabledCheckers"`
	TargetDirs       []string      `yaml:"targetDirs"`
	ExcludePatterns  []string      `yaml:"excludePatterns"`
	FailWhen         FailureConfig `yaml:"failWhen"`
	// contains filtered or unexported fields
}

func NewConfigFromFile

func NewConfigFromFile(path string) (*Config, error)

func (*Config) AddExcludePatterns

func (config *Config) AddExcludePatterns(patterns ...string) error

func (*Config) PopulateDefaults

func (config *Config) PopulateDefaults()

func (*Config) ShouldExcludePath

func (config *Config) ShouldExcludePath(path string) bool

func (*Config) Validate

func (config *Config) Validate() error

type FailureConfig

type FailureConfig struct {
	ExitCode   int                 `yaml:"exitCode"`
	SeverityIn []Severity          `yaml:"severityIn"`
	CategoryIn []Category          `yaml:"categoryIn"`
	MetadataIn []map[string]string `yaml:"metadataIn"`
}

func (*FailureConfig) PopulateDefaults

func (fc *FailureConfig) PopulateDefaults()

type Severity

type Severity string
const (
	SeverityCritical Severity = "critical"
	SeverityError    Severity = "error"
	SeverityWarning  Severity = "warning"
	SeverityInfo     Severity = "info"
)

func (Severity) IsValid

func (s Severity) IsValid() bool

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL