Documentation
¶
Index ¶
Constants ¶
View Source
const ( RouteIndex = "/" RouteEvents = "/events" // RouteCloseWorktree tears down a finished (inactive) worktree tab. The // {id} path value is the WorktreeDescriptor ID. This is the one // client→server message in the watch protocol; everything else flows // server→client. RouteCloseWorktree = "POST /worktrees/{id}/close" )
View Source
const SSEEventGraph = "graph"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CommitSummary ¶ added in v0.26.0
type CommitSummary struct {
Hash string `json:"hash"`
ShortHash string `json:"shortHash"`
Subject string `json:"subject"`
Author string `json:"author"`
Email string `json:"email"`
Timestamp time.Time `json:"timestamp"`
}
CommitSummary describes a commit that caused a working snapshot cycle to freeze into an archived collection.
type GraphSnapshot ¶
type GraphSnapshot struct {
ID int64 `json:"id"`
WorktreeID string `json:"worktreeId"`
Timestamp time.Time `json:"timestamp"`
DOT string `json:"dot"`
// SessionStart marks the first snapshot recorded for a worktree in this
// watch session — the state that already existed when the watcher attached.
// Changes made before this point are not in the timeline. Set once per repo
// and preserved across commit/archive cycles.
SessionStart bool `json:"sessionStart,omitempty"`
}
GraphSnapshot is the atom in the watch protocol timeline.
type GraphStreamPayload ¶
type GraphStreamPayload struct {
Worktrees []WorktreeDescriptor `json:"worktrees"`
// Format is the render format of every snapshot's DOT field for this watch
// session ("dot" or "mermaid"). Session-global; clients treat an empty value
// as "dot".
Format string `json:"format,omitempty"`
WorkingSnapshots []GraphSnapshot `json:"workingSnapshots"`
PastCollections []SnapshotCollection `json:"pastCollections"`
LatestWorkingID int64 `json:"latestWorkingId"`
LatestPastCollectionID int64 `json:"latestPastCollectionId"`
}
GraphStreamPayload is the wire payload for SSE "graph" events.
type SnapshotCollection ¶
type SnapshotCollection struct {
ID int64 `json:"id"`
WorktreeID string `json:"worktreeId"`
Timestamp time.Time `json:"timestamp"`
Snapshots []GraphSnapshot `json:"snapshots"`
CommitHistory []CommitSummary `json:"commitHistory,omitempty"`
}
SnapshotCollection represents an archived batch of working snapshots.
type WorktreeDescriptor ¶ added in v0.32.0
type WorktreeDescriptor struct {
// ID is a stable identifier for the tree across reconnects.
// "main" for the repository's main worktree; "wt-<hash8>" otherwise.
ID string `json:"id"`
// Path is the absolute path to the working tree on disk.
Path string `json:"path"`
// Label is a human-readable name for tab display.
Label string `json:"label"`
// Kind is WorktreeKindMain for the repository's main worktree,
// WorktreeKindLinked otherwise.
Kind WorktreeKind `json:"kind"`
// Active reports whether the worktree is still being watched. It flips to
// false when the underlying git worktree is removed: the tab stays visible
// as a frozen, read-only record and becomes user-closable. The main
// worktree stays active for the life of the watch session.
Active bool `json:"active"`
}
WorktreeDescriptor names a working tree visible to the watch session. One descriptor per tab in the viewer.
type WorktreeKind ¶ added in v0.32.0
type WorktreeKind string
WorktreeKind classifies a worktree using git's own vocabulary: the single main worktree created by `git init`/`git clone`, or one of possibly several linked worktrees created via `git worktree add`. See git-worktree(1). Kept independent of vcs/git.WorktreeKind so this package stays a self-contained wire contract.
const ( WorktreeKindMain WorktreeKind = "main" WorktreeKindLinked WorktreeKind = "linked" )
Source Files
Click to show internal directories.
Click to hide internal directories.