config

Documentation

Overview

Configuration for changelog-lint

Index

• type Arguments
• type Config
  • func LoadConfig(configFile string) (*Config, error)
  • func (c Config) LintingConfig() *linting.Config
  • func (c Config) ParserConfig() (*parser.Config, error)
• type ParserConfig
• type ParserPatterns
• type RuleConfig
• type RulesConfig

Types

type Arguments

type Arguments = []any

Arguments is type used for the arguments of a rule.

type Config

type Config struct {
	Rules  RulesConfig  `toml:"rule"`
	Parser ParserConfig `toml:"parser"`
}

func LoadConfig

func LoadConfig(configFile string) (*Config, error)

func (Config) LintingConfig

func (c Config) LintingConfig() *linting.Config

func (Config) ParserConfig

func (c Config) ParserConfig() (*parser.Config, error)

type ParserConfig

type ParserConfig struct {
	Patterns ParserPatterns
}

RuleConfig is type used for the rule configuration.

type ParserPatterns

type ParserPatterns struct {
	Title      string
	Version    string
	Subsection string
	Entry      string
}

type RuleConfig

type RuleConfig struct {
	Arguments Arguments
	Disabled  bool
}

RuleConfig is type used for the rule configuration.

type RulesConfig

type RulesConfig = map[string]RuleConfig

RulesConfig defines the config for all rules.