Documentation
¶
Index ¶
Constants ¶
View Source
const (
DefaultOutput = ".dox"
)
Variables ¶
This section is empty.
Functions ¶
func DefaultExcludes ¶
func DefaultExcludes() []string
DefaultExcludes returns common patterns to exclude from syncing. These are populated in the config template by `dox init`.
func DefaultPatterns ¶
func DefaultPatterns() []string
func FindConfigFile ¶
Types ¶
type Config ¶
type Config struct {
Output string `koanf:"output" validate:"omitempty,dirpath"`
GitHubToken string `koanf:"github_token"`
MaxParallel int `koanf:"max_parallel" validate:"omitempty,min=1,max=100"`
Excludes []string `koanf:"excludes"`
Display Display `koanf:"display"`
Sources map[string]Source `koanf:"sources" validate:"required,dive"`
ConfigDir string `koanf:"-"`
}
func (*Config) ApplyDefaults ¶
func (c *Config) ApplyDefaults()
type Source ¶
type Source struct {
Type string `koanf:"type" validate:"omitempty,oneof=github url git gitlab codeberg"`
Repo string `koanf:"repo" validate:"omitempty,github_repo"`
Host string `koanf:"host"`
Path string `koanf:"path"`
Ref string `koanf:"ref"`
Patterns []string `koanf:"patterns"`
Exclude []string `koanf:"exclude"`
URL string `koanf:"url" validate:"omitempty,url"`
Filename string `koanf:"filename"`
Out string `koanf:"out"`
}
Click to show internal directories.
Click to hide internal directories.