config

Documentation

Overview

Package config contains helpers, defaults for linter

Index

• Constants
• func GetConfig(confPath string) (*lint.Config, error)
• func GetDefaultConf(onlyEnabled bool) *lint.Config
• func GetEnabledRules(conf *lint.Config) ([]lint.Rule, error)
• func GetFormatter(conf *lint.Config) (lint.Formatter, error)
• func GetLinter(conf *lint.Config) (*lint.Linter, error)
• func Parse(confPath string) (*lint.Config, error)
• func RegisterFormatter(format lint.Formatter) error
• func RegisterRule(rule lint.Rule) error
• func Validate(conf *lint.Config) []error
• func WriteConfToFile(outFilePath string, conf *lint.Config) (retErr error)

Constants

const (
	// DefaultFile represent default config file name
	DefaultFile = "commitlint.yaml"
)

Functions

func GetConfig

func GetConfig(confPath string) (*lint.Config, error)

GetConfig gets the config according to precedence if needed parses config file and returns config instance

func GetDefaultConf

func GetDefaultConf(onlyEnabled bool) *lint.Config

GetDefaultConf writes default config to given file

func GetEnabledRules

func GetEnabledRules(conf *lint.Config) ([]lint.Rule, error)

GetEnabledRules forms Rule object for rules which are enabled in config

func GetFormatter

func GetFormatter(conf *lint.Config) (lint.Formatter, error)

GetFormatter returns the formatter as defined in conf

func GetLinter

func GetLinter(conf *lint.Config) (*lint.Linter, error)

GetLinter returns Linter for given confFilePath

func Parse

func Parse(confPath string) (*lint.Config, error)

Parse parse Config from given file

func RegisterFormatter

func RegisterFormatter(format lint.Formatter) error

RegisterFormatter registers a custom formatter if formatter already exists, returns error

func RegisterRule

func RegisterRule(rule lint.Rule) error

RegisterRule registers a custom rule if rule already exists, returns error

func Validate

func Validate(conf *lint.Config) []error

Validate validates given config

func WriteConfToFile

func WriteConfToFile(outFilePath string, conf *lint.Config) (retErr error)

WriteConfToFile util func to write config object to given file