config

Documentation

Index

• Constants
• Variables
• func CreatePrinter(f string) printer.Printer
• type Config
  • func NewConfig(filename string) (*Config, error)
  • func (c *Config) AddDefaultRules()

Constants

const (
	OutFormatText          = "text"
	OutFormatSimple        = "simple"
	OutFormatGitHubActions = "github-actions"
)

Variables

var OutFormats = []string{
	OutFormatText,
	OutFormatSimple,
	OutFormatGitHubActions,
}

var OutFormatsString = strings.Join(OutFormats, ",")

Functions

func CreatePrinter

func CreatePrinter(f string) printer.Printer

Types

type Config

type Config struct {
	Rules       []*rule.Rule `yaml:"rules"`
	IgnoreFiles []string     `yaml:"ignore_files"`
}

Config contains a list of rules

func NewConfig

func NewConfig(filename string) (*Config, error)

NewConfig returns a new Config

func (*Config) AddDefaultRules

func (c *Config) AddDefaultRules()

AddDefaultRules adds the config Rules to DefaultRules