github

Documentation

Index

• type Repo
  • func NewGithubRepo(name, owner, apiKey, baseURL, uploadURL string) *Repo
  • func (repo *Repo) IssueCount() int
  • func (repo *Repo) Open()
  • func (repo *Repo) OpenIssues()
  • func (repo *Repo) OpenPulls()
  • func (repo *Repo) PullRequestCount() int
  • func (repo *Repo) Refresh()
  • func (repo *Repo) StarCount() int
• type Settings
  • func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings
• type Widget
  • func NewWidget(tviewApp *tview.Application, redrawChan chan bool, pages *tview.Pages, ...) *Widget
  • func (widget *Widget) GetItemCount() int
  • func (widget *Widget) GetSelected() int
  • func (widget *Widget) Next()
  • func (widget *Widget) Prev()
  • func (widget *Widget) Refresh()
  • func (widget *Widget) SetItemCount(items int)
  • func (widget *Widget) Unselect()

Types

type Repo

type Repo struct {
	Name         string
	Owner        string
	PullRequests []*ghb.PullRequest
	RemoteRepo   *ghb.Repository
	Err          error
	// contains filtered or unexported fields
}

Repo defines a new GitHub Repo structure

func NewGithubRepo

func NewGithubRepo(name, owner, apiKey, baseURL, uploadURL string) *Repo

NewGithubRepo returns a new Github Repo with a name, owner, apiKey, baseURL and uploadURL

func (*Repo) IssueCount

func (repo *Repo) IssueCount() int

IssueCount return the total amount of issues as an int

func (*Repo) Open

func (repo *Repo) Open()

Open will open the GitHub Repo URL using the utils helper

func (*Repo) OpenIssues

func (repo *Repo) OpenIssues()

OpenIssues will open the GitHub Issues URL using the utils helper

func (*Repo) OpenPulls

func (repo *Repo) OpenPulls()

OpenPulls will open the GitHub Pull Requests URL using the utils helper

func (*Repo) PullRequestCount

func (repo *Repo) PullRequestCount() int

PullRequestCount returns the total amount of pull requests as an int

func (*Repo) Refresh

func (repo *Repo) Refresh()

Refresh reloads the github data via the Github API

func (*Repo) StarCount

func (repo *Repo) StarCount() int

StarCount returns the total amount of stars this repo has gained as an int

type Settings

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

Settings defines the configuration properties for this module

func NewSettingsFromYAML

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

NewSettingsFromYAML creates a new settings instance from a YAML config block

type Widget

type Widget struct {
	view.MultiSourceWidget
	view.TextWidget

	GithubRepos []*Repo

	Selected int

	Items []int
	// contains filtered or unexported fields
}

Widget define wtf widget to register widget later

func NewWidget

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

NewWidget creates a new instance of the widget

func (*Widget) GetItemCount

func (widget *Widget) GetItemCount() int

GetItemCount returns the amount of PRs RRs and other PRs calculated so far as an int

func (*Widget) GetSelected

func (widget *Widget) GetSelected() int

GetSelected returns the index of the currently highlighted item as an int

func (*Widget) Next

func (widget *Widget) Next()

Next cycles the currently highlighted text down

func (*Widget) Prev

func (widget *Widget) Prev()

Prev cycles the currently highlighted text up

func (*Widget) Refresh

func (widget *Widget) Refresh()

Refresh reloads the github data via the Github API and reruns the display

func (*Widget) SetItemCount

func (widget *Widget) SetItemCount(items int)

SetItemCount sets the amount of PRs RRs and other PRs throughout the widgets display creation

func (*Widget) Unselect

func (widget *Widget) Unselect()

Unselect stops highlighting the text and jumps the scroll position to the top