Documentation
¶
Index ¶
- func MDRenderer() (*glamour.TermRenderer, error)
- func ValidIssueColumns() []string
- func ValidSprintColumns() []string
- type Board
- type BoardOption
- type DisplayFormat
- type EpicIssueFunc
- type EpicList
- type Issue
- type IssueList
- type IssueOption
- type Project
- type ProjectOption
- type ProjectVersionOptions
- type Release
- type ServerInfo
- type ServerInfoOption
- type SprintIssueFunc
- type SprintList
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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.
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
Delimiter string
CSV bool
NoHeaders bool
NoTruncate bool
Columns []string
FixedColumns uint
Comments uint
TableStyle tui.TableStyle
Timezone string
}
DisplayFormat is a issue display type.
type EpicIssueFunc ¶
EpicIssueFunc provides issues for the epic.
type EpicList ¶
type EpicList struct {
Project string
Server string
Data []*jira.Issue
Issues EpicIssueFunc
Display DisplayFormat
}
EpicList is a list view for epics.
type Issue ¶
type Issue struct {
Server string
Data *jira.Issue
Display DisplayFormat
Options IssueOption
}
Issue is a list view for issues.
func (Issue) RenderedOut ¶ added in v0.3.0
func (i Issue) RenderedOut(renderer *glamour.TermRenderer) (string, error)
RenderedOut translates raw data to the format we want to display in.
type IssueList ¶
type IssueList struct {
Project string
Server string
Data []*jira.Issue
Display DisplayFormat
Refresh tui.RefreshFunc
}
IssueList is a list view for issues.
type IssueOption ¶ added in v0.3.0
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.
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 ProjectVersionOptions ¶ added in v1.7.0
type ProjectVersionOptions func(*Release)
ProjectVersionOptions is a functional option to wrap project version properties.
func WithReleaseWriter ¶ added in v1.7.0
func WithReleaseWriter(w io.Writer) ProjectVersionOptions
WithReleaseWriter sets a writer for the project release.
type Release ¶ added in v1.7.0
type Release struct {
// contains filtered or unexported fields
}
Release is a release view.
func NewRelease ¶ added in v1.7.0
func NewRelease(data []*jira.ProjectVersion, opts ...ProjectVersionOptions) *Release
NewRelease constructs a project release command.
type ServerInfo ¶ added in v1.2.0
type ServerInfo struct {
// contains filtered or unexported fields
}
ServerInfo is a serveronfo view.
func NewServerInfo ¶ added in v1.2.0
func NewServerInfo(data *jira.ServerInfo, opts ...ServerInfoOption) *ServerInfo
NewServerInfo initializes server info struct.
func (ServerInfo) Render ¶ added in v1.2.0
func (s ServerInfo) Render() error
Render renders the serverinfo view.
type ServerInfoOption ¶ added in v1.2.0
type ServerInfoOption func(*ServerInfo)
ServerInfoOption is a functional option to wrap serverinfo properties.
func WithServerInfoWriter ¶ added in v1.2.0
func WithServerInfoWriter(w io.Writer) ServerInfoOption
WithServerInfoWriter sets a writer for the serverinfo view.
type SprintIssueFunc ¶
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.