config

Documentation

Index

• Constants
• type Config
  • func Load(flags Flags) (*Config, error)
• type Flags
• type KnownType
• type Marker
• type ProcessorConfig
• type RenderConfig
• type TargetType

Constants

const (
	OutputModeSingle = "single"
	OutputModeGroup  = "group"
)

Types

type Config

type Config struct {
	Processor ProcessorConfig `json:"processor"`
	Render    RenderConfig    `json:"render"`
	Flags     `json:"-"`
}

func Load

func Load(flags Flags) (*Config, error)

type Flags

type Flags struct {
	Config       string
	LogLevel     string
	OutputPath   string
	Renderer     string
	SourcePath   string
	TemplatesDir string
	OutputMode   string
	MaxDepth     int
}

type KnownType

type KnownType struct {
	Name    string `json:"name"`
	Package string `json:"package"`
	Link    string `json:"link"`
}

type Marker

type Marker struct {
	Name   string
	Target TargetType
}

type ProcessorConfig

type ProcessorConfig struct {
	MaxDepth            int      `json:"maxDepth"`
	IgnoreTypes         []string `json:"ignoreTypes"`
	IgnoreFields        []string `json:"ignoreFields"`
	IgnoreGroupVersions []string `json:"ignoreGroupVersions"`
	UseRawDocstring     bool     `json:"useRawDocstring"`
	CustomMarkers       []Marker `json:"customMarkers"`
}

type RenderConfig

type RenderConfig struct {
	KnownTypes        []*KnownType `json:"knownTypes"`
	KubernetesVersion string       `json:"kubernetesVersion"`
}

type TargetType

type TargetType string

const (
	TargetTypePackage TargetType = "package"
	TargetTypeType    TargetType = "type"
	TargetTypeField   TargetType = "field"
)