dashboard

package

v0.7.0 Latest Latest Go to latest Published: May 28, 2026 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/aaronl1011/spec

Links

Open Source Insights

Documentation ¶

Overview ¶

Package dashboard aggregates signals from all configured adapters into a single terminal view.

Index ¶

func PendingCount(rc *config.ResolvedConfig, role string) int
func PrintAwarenessLine(rc *config.ResolvedConfig, role string) bool
func Render(data *DashboardData, userName, role, cycle string)
type DashboardData
- func Aggregate(ctx context.Context, rc *config.ResolvedConfig, reg *adapter.Registry, ...) (*DashboardData, error)
type DashboardItem

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func PendingCount ¶

func PendingCount(rc *config.ResolvedConfig, role string) int

PendingCount returns the number of specs awaiting action from the current user's role. Reads local files only — never blocks on network.

func PrintAwarenessLine ¶

func PrintAwarenessLine(rc *config.ResolvedConfig, role string) bool

PrintAwarenessLine prints the passive "you have mail" indicator. Returns true if something was printed.

func Render ¶

func Render(data *DashboardData, userName, role, cycle string)

Render outputs the dashboard to the terminal.

Types ¶

type DashboardData ¶

type DashboardData struct {
	Do       []DashboardItem `json:"do"`
	Review   []DashboardItem `json:"review"`
	Incoming []DashboardItem `json:"incoming"`
	Blocked  []DashboardItem `json:"blocked"`
	FYI      []DashboardItem `json:"fyi"`
}

DashboardData holds all dashboard sections.

func Aggregate ¶

func Aggregate(ctx context.Context, rc *config.ResolvedConfig, reg *adapter.Registry, role string) (*DashboardData, error)

Aggregate collects data for the dashboard from all sources.

type DashboardItem ¶

type DashboardItem struct {
	SpecID  string `json:"spec_id"`
	Title   string `json:"title"`
	Stage   string `json:"stage"`
	Detail  string `json:"detail"`
	Urgency string `json:"urgency"` // "normal", "stale", "critical"
}

DashboardItem represents a single item in a dashboard section.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL