config

Documentation

Index

• Constants
• func DefaultTokensCache() string
• type Auth
• type AuthType
• type IssueTracker
• type Local
  • func NewLocal(cfgPath, basepath string) (*Local, error)
  • func (l *Local) Validate() []error

Constants

const (
	IssueTrackerInvalid IssueTracker = ""
	IssueTrackerJira                 = "JIRA"
	IssueTrackerGithub               = "GITHUB"
	IssueTrackerGitlab               = "GITLAB"
	IssueTrackerPivotal              = "PIVOTAL_TRACKER"
	IssueTrackerRedmine              = "REDMINE"
)

Issue tracker types

const DefaultLocal = ".todocheck.yaml"

DefaultLocal contains the default filepath to the local todocheck config for the current repository

Functions

func DefaultTokensCache

func DefaultTokensCache() string

DefaultTokensCache for storing auth tokens

Types

type Auth

type Auth struct {
	Type        AuthType `yaml:"type"`
	OfflineURL  string   `yaml:"offline_url"`
	TokensCache string   `yaml:"tokens_cache,omitempty"`
	Token       string   `yaml:"-"`
}

Auth configuration section for specifying issue tracker auth options

type AuthType

type AuthType string

AuthType specifies the type of the auth token in todocheck's config

const (
	AuthTypeNone     AuthType = "none"
	AuthTypeOffline  AuthType = "offline"
	AuthTypeAPIToken AuthType = "apitoken"
)

possible auth types

type IssueTracker

type IssueTracker string

IssueTracker enum

type Local

type Local struct {
	Origin       string       `yaml:"origin"`
	IssueTracker IssueTracker `yaml:"issue_tracker"`
	IgnoredPaths []string     `yaml:"ignored"`
	Auth         *Auth        `yaml:"auth"`
}

Local todocheck configuration struct definition

func NewLocal

func NewLocal(cfgPath, basepath string) (*Local, error)

NewLocal configuration from a given file path

func (*Local) Validate

func (l *Local) Validate() []error

Validate validates the values of given configuration