params

Documentation

Index

• type API
  • func (p API) String() string
• type Config
• type FilterParams
  • func (p FilterParams) String() string
• type Heartbeat
  • func (p Heartbeat) String() string
• type Offline
  • func (p Offline) String() string
• type Params
  • func Load(v *viper.Viper, config Config) (Params, error)
  • func (p Params) String() string
• type ProjectParams
  • func (p ProjectParams) String() string
• type SanitizeParams
  • func (p SanitizeParams) String() string
• type StatusBar
  • func (p StatusBar) String() string

Types

type API

type API struct {
	BackoffAt        time.Time
	BackoffRetries   int
	DisableSSLVerify bool
	Hostname         string
	Key              string
	Plugin           string
	ProxyURL         string
	SSLCertFilepath  string
	Timeout          time.Duration
	URL              string
}

API contains api related parameters.

func (API) String

func (p API) String() string

String implements fmt.Stringer interface.

type Config

type Config struct {
	APIKeyRequired    bool
	HeartbeatRequired bool
}

Config contains configuration settings.

type FilterParams

type FilterParams struct {
	Exclude                    []regex.Regex
	ExcludeUnknownProject      bool
	Include                    []regex.Regex
	IncludeOnlyWithProjectFile bool
}

FilterParams contains heartbeat filtering related command parameters.

func (FilterParams) String

func (p FilterParams) String() string

type Heartbeat

type Heartbeat struct {
	Category          heartbeat.Category
	CursorPosition    *int
	Entity            string
	EntityType        heartbeat.EntityType
	ExtraHeartbeats   []heartbeat.Heartbeat
	IsWrite           *bool
	Language          *string
	LanguageAlternate string
	LineNumber        *int
	LinesInFile       *int
	LocalFile         string
	Time              float64
	Filter            FilterParams
	Project           ProjectParams
	Sanitize          SanitizeParams
}

Heartbeat contains heartbeat command parameters.

func (Heartbeat) String

func (p Heartbeat) String() string

type Offline

type Offline struct {
	Disabled  bool
	QueueFile string
	SyncMax   int
}

Offline contains offline related parameters.

func (Offline) String

func (p Offline) String() string

String implements fmt.Stringer interface.

type Params

type Params struct {
	API       API
	Heartbeat Heartbeat
	Offline   Offline
	StatusBar StatusBar
}

Params contains params.

func Load

func Load(v *viper.Viper, config Config) (Params, error)

Load loads params from viper.Viper instance. Returns ErrAuth if failed to retrieve api key.

func (Params) String

func (p Params) String() string

String implements fmt.Stringer interface.

type ProjectParams

type ProjectParams struct {
	Alternate        string
	DisableSubmodule []regex.Regex
	MapPatterns      []project.MapPattern
	Override         string
}

ProjectParams params for project name sanitization.

func (ProjectParams) String

func (p ProjectParams) String() string

type SanitizeParams

type SanitizeParams struct {
	HideBranchNames  []regex.Regex
	HideFileNames    []regex.Regex
	HideProjectNames []regex.Regex
}

SanitizeParams params for heartbeat sanitization.

func (SanitizeParams) String

func (p SanitizeParams) String() string

type StatusBar

type StatusBar struct {
	HideCategories bool
}

StatusBar contains status bar related parameters.

func (StatusBar) String

func (p StatusBar) String() string

String implements fmt.Stringer interface.