format

Documentation

Overview

Copyright © 2020-2024 Morten Hersson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• Variables
• func Epic(summary string) string
• func FixVersions(issue types.IssueDescription) string
• func Header(project, key, summary string) string
• func IssueType(issueType string, short bool) string
• func KanbanBoardHeader(board string) string
• func Priority(priority string, short bool) string
• func SprintHeader(sprint types.Sprint) string
• func SprintStatus(done bool) string
• func StatsAverage(avg, goal float64) string
• func StatsHolidays(holidays int) string
• func StatsSummary(num float64) string
• func StatsTotal(tot, goal, hoursPrDay float64, holidays int) string
• func StatsWorkdays(days, goal, holidays int) string
• func Status(status string, short bool) string
• func TimeEstimate(estimate string) string

Variables

var Color = types.Color{
	Red:     "\033[31m",
	Green:   "\033[32m",
	Yellow:  "\033[33m",
	Blue:    "\033[34m",
	Magenta: "\033[35m",
	Cyan:    "\033[36m",
	Bold:    "\033[1m",
	Ul:      "\033[4m",
	Nocolor: "\033[0m",
}

Functions

func Epic

func Epic(summary string) string

func FixVersions

func FixVersions(issue types.IssueDescription) string

func Header

func Header(project, key, summary string) string

func IssueType

func IssueType(issueType string, short bool) string

func KanbanBoardHeader

func KanbanBoardHeader(board string) string

func Priority

func Priority(priority string, short bool) string

func SprintHeader

func SprintHeader(sprint types.Sprint) string

func SprintStatus

func SprintStatus(done bool) string

func StatsAverage

func StatsAverage(avg, goal float64) string

func StatsHolidays

func StatsHolidays(holidays int) string

func StatsSummary

func StatsSummary(num float64) string

func StatsTotal

func StatsTotal(tot, goal, hoursPrDay float64, holidays int) string

func StatsWorkdays

func StatsWorkdays(days, goal, holidays int) string

func Status

func Status(status string, short bool) string

func TimeEstimate

func TimeEstimate(estimate string) string