config

Documentation

Overview

Package config provides configuration for headercheck.

Index

• type Config
  • func Load(explicitPath string, root string) (Config, error)
• type TemplateDef

Types

type Config

type Config struct {
	Templates []TemplateDef `yaml:"templates"`
	// Legacy/global defaults (optional): applied to templates without include/exclude
	Include string `yaml:"include"`
	Exclude string `yaml:"exclude"`
}

Config represents headercheck configuration. `templates` can be either a list of strings or a list of objects {path, include, exclude}.

func Load

func Load(explicitPath string, root string) (Config, error)

Load loads configuration from explicit path or common defaults.

type TemplateDef

type TemplateDef struct {
	Path    string `yaml:"path"`
	Include string `yaml:"include"`
	Exclude string `yaml:"exclude"`
}

TemplateDef represents a single template configuration with optional include/exclude.