task

Documentation

Index

• Variables
• type Task
  • func GitToTask(branch, repoName string) Task
  • func NewTask(name string, date time.Time, tags []string) Task
  • func NewTaskFromGit(branch, repo string, created time.Time) Task
  • func NewTaskFromStr(text string, lineNumber int) Task
  • func StrToTask(text string, id int) (Task, error)
  • func (t Task) GetFormattedBranch() string
  • func (t Task) GetFormattedCreated() string
  • func (t Task) GetFormattedCreatedDate() string
  • func (t Task) GetFormattedCreatedTime() string
  • func (t Task) GetFormattedId() string
  • func (t Task) GetFormattedIssueId() string
  • func (t Task) GetFormattedName() string
  • func (t Task) GetFormattedRepo() string
  • func (t Task) GetFormattedTags() string
  • func (t Task) MatchId(id int) bool
  • func (t Task) MatchTags(tags []string) bool
  • func (t Task) ToString() string

Variables

var ErrorEmptyName = errors.New("No name provided")

var ErrorFindMultipleFlags = errors.New("Cannot search using multiple flags")

var ErrorFindWithoutTag = errors.New("Tags not provided")

var ErrorInvalidDate = errors.New("Invalid task date format, use YYYY-MM-DD format")

var ErrorMainBranch = errors.New("Cannot use `main`/`master` as task name")

var ErrorNotInGitRepo = errors.New("Command was not run in git repo")

var ErrorParseInvalidCreatedDate = errors.New("Parsing Error: invalid task created date. Need to be in `YYYY-MM-DD HH:mm:ss` format")

Types

type Task

type Task struct {
	ID      int
	Created time.Time
	Name    string
	IssueId string   // optional
	Repo    string   // optional
	Branch  string   // optional
	Tags    []string // optional
}

func GitToTask

func GitToTask(branch, repoName string) Task

func NewTask

func NewTask(name string, date time.Time, tags []string) Task

func NewTaskFromGit

func NewTaskFromGit(branch, repo string, created time.Time) Task

func NewTaskFromStr

func NewTaskFromStr(text string, lineNumber int) Task

func StrToTask

func StrToTask(text string, id int) (Task, error)

func (Task) GetFormattedBranch

func (t Task) GetFormattedBranch() string

func (Task) GetFormattedCreated

func (t Task) GetFormattedCreated() string

func (Task) GetFormattedCreatedDate

func (t Task) GetFormattedCreatedDate() string

func (Task) GetFormattedCreatedTime

func (t Task) GetFormattedCreatedTime() string

func (Task) GetFormattedId

func (t Task) GetFormattedId() string

func (Task) GetFormattedIssueId

func (t Task) GetFormattedIssueId() string

func (Task) GetFormattedName

func (t Task) GetFormattedName() string

func (Task) GetFormattedRepo

func (t Task) GetFormattedRepo() string

func (Task) GetFormattedTags

func (t Task) GetFormattedTags() string

func (Task) MatchId

func (t Task) MatchId(id int) bool

func (Task) MatchTags

func (t Task) MatchTags(tags []string) bool

func (Task) ToString

func (t Task) ToString() string