internal

Documentation

Index

• type Change
• type ChangeType
• type Changelog
  • func (c Changelog) Expand() map[string]map[string]any

Types

type Change

type Change struct {
	// field contains the path to the field that was changed. Nested fields can
	// be represented with dots (e.g. nested.field)
	Field      string
	ChangeType ChangeType
	// message is the log message that will be printed if a file is detected
	// that uses this field with an unsupported version.
	Message string
}

Change is a single change that was introduced in a specific version.

type ChangeType

type ChangeType int

ChangeType defines the type of the change introduced in a specific version.

const (
	FieldDeprecated ChangeType = iota
	FieldIntroduced
)

type Changelog

type Changelog map[string][]Change

Changelog contains a map of all changes introduced in each version. Based on the changelog the parser can output warnings.

func (Changelog) Expand

func (c Changelog) Expand() map[string]map[string]any

Expand expands a changelog map into a structure that is useful for traversing in ConfigLinter.