config

Documentation

Index

• Constants
• Variables
• func DefaultTokensCache() string
• type Auth
• type AuthType
  • func (a AuthType) IsValid() bool
  • func (a AuthType) String() string
• type IssueTracker
  • func (it IssueTracker) IsValid() bool
  • func (it IssueTracker) IsValidAuthType(authType AuthType) bool
  • func (it IssueTracker) IsValidOrigin(origin string) bool
• type Local
  • func NewLocal(cfgPath, basepath string) (*Local, error)

Constants

const (
	IssueTrackerInvalid  = ""
	IssueTrackerJira     = "JIRA"
	IssueTrackerGithub   = "GITHUB"
	IssueTrackerGitlab   = "GITLAB"
	IssueTrackerPivotal  = "PIVOTAL_TRACKER"
	IssueTrackerRedmine  = "REDMINE"
	IssueTrackerYoutrack = "YOUTRACK"
	IssueTrackerAzure    = "AZURE"
)

Issue tracker types

const DefaultLocal = ".todocheck.yaml"

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

Variables

var ValidAuthTypes = []AuthType{
	AuthTypeNone,
	AuthTypeOffline,
	AuthTypeAPIToken,
}

ValidAuthTypes is used for validation of auth type

var ValidIssueTrackerAuthTypes = map[IssueTracker][]AuthType{
	IssueTrackerGithub:   {AuthTypeNone, AuthTypeAPIToken},
	IssueTrackerGitlab:   {AuthTypeNone, AuthTypeAPIToken},
	IssueTrackerPivotal:  {AuthTypeNone, AuthTypeAPIToken},
	IssueTrackerRedmine:  {AuthTypeNone, AuthTypeAPIToken},
	IssueTrackerJira:     {AuthTypeNone, AuthTypeOffline, AuthTypeAPIToken},
	IssueTrackerYoutrack: {AuthTypeAPIToken},
	IssueTrackerAzure:    {AuthTypeNone, AuthTypeAPIToken},
}

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:"-"`
	Options     map[string]string `yaml:"options"`
}

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

func (AuthType) IsValid

func (a AuthType) IsValid() bool

IsValid checks if the given AuthType is among the valid enum values

func (AuthType) String

func (a AuthType) String() string

type IssueTracker

type IssueTracker string

IssueTracker enum

func (IssueTracker) IsValid

func (it IssueTracker) IsValid() bool

IsValid checks if the given issue tracker is among the valid enum values

func (IssueTracker) IsValidAuthType

func (it IssueTracker) IsValidAuthType(authType AuthType) bool

IsValidAuthType checks if the given auth type is among the valid auth types for the given issue tracker

func (IssueTracker) IsValidOrigin

func (it IssueTracker) IsValidOrigin(origin string) bool

IsValidOrigin checks if the given origin is among the valid patterns for the given issue tracker

type Local

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

Local todocheck configuration struct definition

func NewLocal

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

NewLocal configuration from a given file path