view

Documentation

Index

• func MDRenderer() (*glamour.TermRenderer, error)
• func ValidIssueColumns() []string
• func ValidSprintColumns() []string
• type Board
  • func NewBoard(data []*jira.Board, opts ...BoardOption) *Board
  • func (b Board) Render() error
• type BoardOption
  • func WithBoardWriter(w io.Writer) BoardOption
• type DisplayFormat
• type EpicIssueFunc
• type EpicList
  • func (el EpicList) Render() error
• type Issue
  • func (i Issue) Render() error
  • func (i Issue) RenderedOut(renderer *glamour.TermRenderer) (string, error)
  • func (i Issue) String() string
• type IssueList
  • func (l *IssueList) Render() error
• type IssueOption
• type Project
  • func NewProject(data []*jira.Project, opts ...ProjectOption) *Project
  • func (p Project) Render() error
• type ProjectOption
  • func WithProjectWriter(w io.Writer) ProjectOption
• type SprintIssueFunc
• type SprintList
  • func (sl SprintList) Render() error
  • func (sl SprintList) RenderInTable() error

Functions

func MDRenderer

func MDRenderer() (*glamour.TermRenderer, error)

MDRenderer constructs markdown renderer.

func ValidIssueColumns

func ValidIssueColumns() []string

ValidIssueColumns returns valid columns for issue list.

func ValidSprintColumns

func ValidSprintColumns() []string

ValidSprintColumns returns valid columns for sprint list.

Types

type Board

type Board struct {
	// contains filtered or unexported fields
}

Board is a board view.

func NewBoard

func NewBoard(data []*jira.Board, opts ...BoardOption) *Board

NewBoard initializes a board.

func (Board) Render

func (b Board) Render() error

Render renders the board view.

type BoardOption

type BoardOption func(*Board)

BoardOption is a functional option to wrap board properties.

func WithBoardWriter

func WithBoardWriter(w io.Writer) BoardOption

WithBoardWriter sets a writer for the board.

type DisplayFormat

type DisplayFormat struct {
	Plain      bool
	NoHeaders  bool
	NoTruncate bool
	Columns    []string
}

DisplayFormat is a issue display type.

type EpicIssueFunc

type EpicIssueFunc func(string) []*jira.Issue

EpicIssueFunc provides issues for the epic.

type EpicList

type EpicList struct {
	Total   int
	Project string
	Server  string
	Data    []*jira.Issue
	Issues  EpicIssueFunc
}

EpicList is a list view for epics.

func (EpicList) Render

func (el EpicList) Render() error

Render renders the epic explorer view.

type Issue

type Issue struct {
	Server  string
	Data    *jira.Issue
	Display DisplayFormat
	Options IssueOption
}

Issue is a list view for issues.

func (Issue) Render

func (i Issue) Render() error

Render renders the view.

func (Issue) RenderedOut

func (i Issue) RenderedOut(renderer *glamour.TermRenderer) (string, error)

RenderedOut translates raw data to the format we want to display in.

func (Issue) String

func (i Issue) String() string

type IssueList

type IssueList struct {
	Total      int
	Project    string
	Server     string
	Data       []*jira.Issue
	Display    DisplayFormat
	Refresh    tui.RefreshFunc
	FooterText string
}

IssueList is a list view for issues.

func (*IssueList) Render

func (l *IssueList) Render() error

Render renders the view.

type IssueOption

type IssueOption struct {
	NumComments uint
}

IssueOption is filtering options for an issue.

type Project

type Project struct {
	// contains filtered or unexported fields
}

Project is a project view.

func NewProject

func NewProject(data []*jira.Project, opts ...ProjectOption) *Project

NewProject initializes a project.

func (Project) Render

func (p Project) Render() error

Render renders the project view.

type ProjectOption

type ProjectOption func(*Project)

ProjectOption is a functional option to wrap project properties.

func WithProjectWriter

func WithProjectWriter(w io.Writer) ProjectOption

WithProjectWriter sets a writer for the project.

type SprintIssueFunc

type SprintIssueFunc func(boardID, sprintID int) []*jira.Issue

SprintIssueFunc provides issues in the sprint.

type SprintList

type SprintList struct {
	Project string
	Board   string
	Server  string
	Data    []*jira.Sprint
	Issues  SprintIssueFunc
	Display DisplayFormat
}

SprintList is a list view for sprints.

func (SprintList) Render

func (sl SprintList) Render() error

Render renders the sprint explorer view.

func (SprintList) RenderInTable

func (sl SprintList) RenderInTable() error

RenderInTable renders the list in table view.