github

package

v0.0.0-...-c936f35 Latest Latest Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 13 Imported by: 6

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package github provides a barista module to show github notifications.

This section is empty.

This section is empty.

This section is empty.

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

Module represents a GitHub barista module that displays notification counts.

func New(clientID, clientSecret string) *Module

New creates a GitHub module using the given clientID and secret.

func (m *Module) Output(outputFunc func(Notifications) bar.Output) *Module

Output sets the output format for this module.

func (m *Module) Stream(sink bar.Sink)

Stream starts the module.

type Notifications map[string]int

Notifications represents the notifications grouped by reasons. The key is the reason ("comment", "mention"), and the value is the number of notifications for that reason. See https://developer.github.com/v3/activity/notifications/#notification-reasons for a list of reasons.

func (n Notifications) Total() int

Total returns the total number of unread notifications across all categories.