jira

Documentation

Index

• Constants
• type Issue
• type IssueFields
• type IssueStatus
• type IssueType
• type SearchResult
• type Settings
  • func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings
• type Widget
  • func NewWidget(tviewApp *tview.Application, pages *tview.Pages, settings *Settings) *Widget
  • func (widget *Widget) IssuesFor(username string, projects []string, jql string) (*SearchResult, error)
  • func (widget *Widget) Refresh()
  • func (widget *Widget) Render()

Constants

const MaxIssueTypeLength = 7

const MaxStatusNameLength = 14

Types

type Issue

type Issue struct {
	Expand string `json:"expand"`
	ID     string `json:"id"`
	Self   string `json:"self"`
	Key    string `json:"key"`

	IssueFields *IssueFields `json:"fields"`
}

type IssueFields

type IssueFields struct {
	Summary string `json:"summary"`

	IssueType   *IssueType   `json:"issuetype"`
	IssueStatus *IssueStatus `json:"status"`
}

type IssueStatus

type IssueStatus struct {
	ISelf        string `json:"self"`
	IDescription string `json:"description"`
	IName        string `json:"name"`
}

type IssueType

type IssueType struct {
	Self        string `json:"self"`
	ID          string `json:"id"`
	Description string `json:"description"`
	IconURL     string `json:"iconUrl"`
	Name        string `json:"name"`
	Subtask     bool   `json:"subtask"`
}

type SearchResult

type SearchResult struct {
	StartAt    int     `json:"startAt"`
	MaxResults int     `json:"maxResults"`
	Total      int     `json:"total"`
	Issues     []Issue `json:"issues"`
}

type Settings

type Settings struct {
	*cfg.Common
	// contains filtered or unexported fields
}

func NewSettingsFromYAML

func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings

type Widget

type Widget struct {
	view.ScrollableWidget
	// contains filtered or unexported fields
}

func NewWidget

func NewWidget(tviewApp *tview.Application, pages *tview.Pages, settings *Settings) *Widget

func (*Widget) IssuesFor

func (widget *Widget) IssuesFor(username string, projects []string, jql string) (*SearchResult, error)

IssuesFor returns a collection of issues for a given collection of projects. If username is provided, it scopes the issues to that person

func (*Widget) Refresh

func (widget *Widget) Refresh()

func (*Widget) Render

func (widget *Widget) Render()