summary

Documentation

Index

• func RenderToday(summary *Summary, hideCategories bool, out output.Output) (string, error)
• type Category
• type Counter
• type Data
• type Dependency
• type Editor
• type GrandTotal
• type Language
• type Machine
• type OperatingSystem
• type Project
• type Range
• type Summary

Functions

func RenderToday

func RenderToday(summary *Summary, hideCategories bool, out output.Output) (string, error)

RenderToday generates a text representation from summary of the current day. If out is set to output.RawJSONOutput or output.JSONOutput, the summary will be marshaled to JSON. Expects exactly one summary for the current day. Will return an error otherwise.

Types

type Category

type Category struct {
	Decimal      string  `json:"decimal"`
	Digital      string  `json:"digital"`
	Hours        int     `json:"hours"`
	Minutes      int     `json:"minutes"`
	Name         string  `json:"name"`
	Percent      float64 `json:"percent"`
	Seconds      int     `json:"seconds"`
	Text         string  `json:"text"`
	TotalSeconds float64 `json:"total_seconds"`
}

Category represents the tracked category for a single day activity.

type Counter

type Counter struct {
	Decimal      string  `json:"decimal"`
	Digital      string  `json:"digital"`
	Hours        int     `json:"hours"`
	Minutes      int     `json:"minutes"`
	Name         string  `json:"name"`
	Percent      float64 `json:"percent"`
	Seconds      int     `json:"seconds"`
	Text         string  `json:"text"`
	TotalSeconds float64 `json:"total_seconds"`
}

Counter represents the time counters.

type Data

type Data struct {
	Categories       []Category        `json:"categories"`
	Dependencies     []Dependency      `json:"dependencies"`
	Editors          []Editor          `json:"editors"`
	GrandTotal       GrandTotal        `json:"grand_total"`
	Languages        []Language        `json:"languages"`
	Machines         []Machine         `json:"machines"`
	OperatingSystems []OperatingSystem `json:"operating_systems"`
	Projects         []Project         `json:"projects"`
	Range            Range             `json:"range"`
}

Data aggregates all activities for a single day.

type Dependency

type Dependency struct {
	Decimal      string  `json:"decimal"`
	Digital      string  `json:"digital"`
	Hours        int     `json:"hours"`
	Minutes      int     `json:"minutes"`
	Name         string  `json:"name"`
	Percent      float64 `json:"percent"`
	Seconds      int     `json:"seconds"`
	Text         string  `json:"text"`
	TotalSeconds float64 `json:"total_seconds"`
}

Dependency represents the discovered dependency for a single day activity.

type Editor

type Editor struct {
	Decimal      string  `json:"decimal"`
	Digital      string  `json:"digital"`
	Hours        int     `json:"hours"`
	Minutes      int     `json:"minutes"`
	Name         string  `json:"name"`
	Percent      float64 `json:"percent"`
	Seconds      int     `json:"seconds"`
	Text         string  `json:"text"`
	TotalSeconds float64 `json:"total_seconds"`
}

Editor represents the used editor for a single day activity.

type GrandTotal

type GrandTotal struct {
	Decimal      string  `json:"decimal"`
	Digital      string  `json:"digital"`
	Hours        int     `json:"hours"`
	Minutes      int     `json:"minutes"`
	Text         string  `json:"text"`
	TotalSeconds float64 `json:"total_seconds"`
}

GrandTotal represents the total working time for a single day.

type Language

type Language struct {
	Decimal      string  `json:"decimal"`
	Digital      string  `json:"digital"`
	Hours        int     `json:"hours"`
	Minutes      int     `json:"minutes"`
	Name         string  `json:"name"`
	Percent      float64 `json:"percent"`
	Seconds      int     `json:"seconds"`
	Text         string  `json:"text"`
	TotalSeconds float64 `json:"total_seconds"`
}

Language represents the used programming language for a single day activity.

type Machine

type Machine struct {
	Decimal       string  `json:"decimal"`
	Digital       string  `json:"digital"`
	Hours         int     `json:"hours"`
	MachineNameID string  `json:"machine_name_id"`
	Minutes       int     `json:"minutes"`
	Name          string  `json:"name"`
	Percent       float64 `json:"percent"`
	Seconds       int     `json:"seconds"`
	Text          string  `json:"text"`
	TotalSeconds  float64 `json:"total_seconds"`
}

Machine represents the used machine for a single day activity.

type OperatingSystem

type OperatingSystem struct {
	Decimal      string  `json:"decimal"`
	Digital      string  `json:"digital"`
	Hours        int     `json:"hours"`
	Minutes      int     `json:"minutes"`
	Name         string  `json:"name"`
	Percent      float64 `json:"percent"`
	Seconds      int     `json:"seconds"`
	Text         string  `json:"text"`
	TotalSeconds float64 `json:"total_seconds"`
}

OperatingSystem represents the used operating system for a single day activity.

type Project

type Project struct {
	Decimal      string  `json:"decimal"`
	Digital      string  `json:"digital"`
	Hours        int     `json:"hours"`
	Minutes      int     `json:"minutes"`
	Name         string  `json:"name"`
	Percent      float64 `json:"percent"`
	Seconds      int     `json:"seconds"`
	Text         string  `json:"text"`
	TotalSeconds float64 `json:"total_seconds"`
}

Project represents the discovered project for a single day activity.

type Range

type Range struct {
	Date     string `json:"date"`
	End      string `json:"end"`
	Start    string `json:"start"`
	Text     string `json:"text"`
	Timezone string `json:"timezone"`
}

Range represents the time range of a summary.

type Summary

type Summary struct {
	CachedAt        string `json:"cached_at"`
	Data            Data   `json:"data"`
	HasTeamFeatures bool   `json:"has_team_features"`
}

Summary represents the tracked working time for a single day.