workspace

Documentation

Overview

Package workspace aggregates several satelle repos into one read-only view. Each registered repo's per-repo database stays the source of truth; this opens each in turn and reads its stories/tasks/docs through the domain stores, so the workspace is an aggregation layer, not a second database. A repo that fails to open is reported (with its error) rather than failing the whole aggregate.

Index

• type Aggregate
  • func Load(ctx context.Context, repoRoots []string) Aggregate
  • func (a Aggregate) Totals() (stories, tasks, docs int)
• type RepoView

Types

type Aggregate

type Aggregate struct {
	Repos []RepoView
}

Aggregate is the merged view across the registered repos.

func Load

func Load(ctx context.Context, repoRoots []string) Aggregate

Load aggregates the given repo roots. Order is preserved; duplicates are kept as given (the caller de-dups). Each repo is opened, read, and closed.

func (Aggregate) Totals

func (a Aggregate) Totals() (stories, tasks, docs int)

Totals returns the summed story/task/doc counts across readable repos.

type RepoView

type RepoView struct {
	Path    string
	Name    string // base name of the repo dir, for display
	Stories []workitem.Item
	Tasks   []workitem.Item
	Docs    []docindex.Doc
	Err     string // non-empty when this repo could not be read
}

RepoView is one repo's slice of the aggregate.