config

Documentation

Overview

Package config contains helpers, defaults for linter

Index

• func GetEnabledRules(conf *lint.Config) ([]lint.Rule, error)
• func GetFormatter(conf *lint.Config) (lint.Formatter, error)
• func LookupAndParse() (*lint.Config, error)
• func NewDefault() *lint.Config
• func NewLinter(conf *lint.Config) (*lint.Linter, error)
• func Parse(confPath string) (*lint.Config, error)
• func Validate(conf *lint.Config) []error
• func WriteTo(w io.Writer, conf *lint.Config) (retErr error)

Functions

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 LookupAndParse

func LookupAndParse() (*lint.Config, error)

LookupAndParse gets the config path according to the precedence if exists, parses the config file and returns config instance

func NewDefault

func NewDefault() *lint.Config

NewDefault returns default config

func NewLinter

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

NewLinter returns Linter for given confFilePath

func Parse

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

Parse parse given file in confPath, and return Config instance, error if any

func Validate

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

Validate validates given config instance, it checks the following If formatters, rules are registered/known If arguments to rules are valid If version is valid and atleast minimum than commitlint version used

func WriteTo

func WriteTo(w io.Writer, conf *lint.Config) (retErr error)

WriteTo writes config in yaml format to given io.Writer