cache

Documentation

Index

• Constants
• func CachePath(dir string) string
• func LockPath(dir string) string
• func MakeWorktreeKey(path string) string
• func MarkRemovedByKey(c *Cache, key string)
• func Save(scanDir string, cache *Cache) error
• type Cache
  • func Load(scanDir string) (*Cache, error)
  • func LoadWithLock(dir string) (*Cache, func(), error)
  • func (c *Cache) GetBranchByID(id int) (branch string, path string, found bool, removed bool)
  • func (c *Cache) GetBranchByPRNumber(originURL string, prNumber int) string
  • func (c *Cache) GetByID(id int) (path string, found bool, removed bool)
  • func (c *Cache) GetOrAssignID(info WorktreeInfo) int
  • func (c *Cache) GetPRByOriginAndBranch(originURL, branch string) *PRInfo
  • func (c *Cache) GetPRForBranch(folderName string) *PRInfo
  • func (c *Cache) MarkRemoved(folderName string)
  • func (c *Cache) Reset()
  • func (c *Cache) SetPRByOriginAndBranch(originURL, branch string, pr *PRInfo)
  • func (c *Cache) SetPRForBranch(folderName string, pr *PRInfo)
  • func (c *Cache) SyncWorktrees(worktrees []WorktreeInfo) map[string]int
• type FileLock
  • func NewFileLock(path string) *FileLock
  • func (l *FileLock) Lock() error
  • func (l *FileLock) Unlock() error
• type PRCache
• type PRInfo
  • func (m *PRInfo) IsStale() bool
• type WorktreeIDEntry
• type WorktreeInfo

Constants

const CacheMaxAge = 24 * time.Hour

CacheMaxAge is the maximum age of cached PR info before it's considered stale

Functions

func CachePath

func CachePath(dir string) string

CachePath returns the path to the cache file for a directory

func LockPath

func LockPath(dir string) string

LockPath returns the path to the lock file for a directory

func MakeWorktreeKey

func MakeWorktreeKey(path string) string

MakeWorktreeKey creates a cache key from worktree path (folder name). The folder name is unique within a worktree_dir and human-readable.

func MarkRemovedByKey

func MarkRemovedByKey(c *Cache, key string)

MarkRemovedByKey is a package-level function for marking an entry as removed. Used by doctor command for fixing cache issues.

func Save

func Save(scanDir string, cache *Cache) error

Save saves the unified cache to disk atomically

Types

type Cache

type Cache struct {
	PRs       PRCache                     `json:"prs,omitempty"`
	Worktrees map[string]*WorktreeIDEntry `json:"worktrees,omitempty"` // key: folder name (e.g., "repo-feature-branch")
	NextID    int                         `json:"next_id,omitempty"`
}

Cache is the unified cache structure stored in .wt-cache.json

func Load

func Load(scanDir string) (*Cache, error)

Load loads the unified cache from disk

func LoadWithLock

func LoadWithLock(dir string) (*Cache, func(), error)

LoadWithLock acquires a lock and loads the cache. Returns cache, unlock function, and error. Caller must defer unlock() if err == nil.

func (*Cache) GetBranchByID

func (c *Cache) GetBranchByID(id int) (branch string, path string, found bool, removed bool)

GetBranchByID looks up a worktree by its ID and returns the branch name Returns branch, path, found, and whether it was marked as removed

func (*Cache) GetBranchByPRNumber

func (c *Cache) GetBranchByPRNumber(originURL string, prNumber int) string

GetBranchByPRNumber looks up PR info by PR number for a given origin URL Returns the branch name if found and cache is not stale, empty string otherwise

func (*Cache) GetByID

func (c *Cache) GetByID(id int) (path string, found bool, removed bool)

GetByID looks up a worktree by its ID Returns path, found, and whether it was marked as removed

func (*Cache) GetOrAssignID

func (c *Cache) GetOrAssignID(info WorktreeInfo) int

GetOrAssignID returns the existing ID for a worktree or assigns a new one. Uses folder name as key, stores rich metadata for repair/recovery.

func (*Cache) GetPRByOriginAndBranch

func (c *Cache) GetPRByOriginAndBranch(originURL, branch string) *PRInfo

GetPRByOriginAndBranch returns the cached PR for a given origin URL and branch. Searches through all entries to find a match. Returns nil if not found. This is used for backwards compatibility in cases where folder name isn't available.

func (*Cache) GetPRForBranch

func (c *Cache) GetPRForBranch(folderName string) *PRInfo

GetPRForBranch returns the cached PR for a worktree by folder name. Returns nil if not found or not fetched.

func (*Cache) MarkRemoved

func (c *Cache) MarkRemoved(folderName string)

MarkRemoved sets the RemovedAt timestamp for a worktree entry by folder name. Call this immediately after successfully removing a worktree.

func (*Cache) Reset

func (c *Cache) Reset()

Reset clears all cached data and resets NextID to 1. Active worktrees will get new IDs on next sync.

func (*Cache) SetPRByOriginAndBranch

func (c *Cache) SetPRByOriginAndBranch(originURL, branch string, pr *PRInfo)

SetPRByOriginAndBranch stores PR info by origin URL and branch. Searches through all entries to find a match. This is used for backwards compatibility in cases where folder name isn't available.

func (*Cache) SetPRForBranch

func (c *Cache) SetPRForBranch(folderName string, pr *PRInfo)

SetPRForBranch stores PR info for a worktree by folder name. Updates the entry if it exists; does nothing if the entry doesn't exist.

func (*Cache) SyncWorktrees

func (c *Cache) SyncWorktrees(worktrees []WorktreeInfo) map[string]int

SyncWorktrees updates the cache with current worktrees Returns a map of path -> ID for display Note: entries are never deleted, only marked as removed for history

type FileLock

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

FileLock provides exclusive file-based locking using flock.

func NewFileLock

func NewFileLock(path string) *FileLock

NewFileLock creates a new file lock for the given path. The lock file will be created if it doesn't exist.

func (*FileLock) Lock

func (l *FileLock) Lock() error

Lock acquires an exclusive lock on the file. Blocks until the lock is acquired.

func (*FileLock) Unlock

func (l *FileLock) Unlock() error

Unlock releases the lock and closes the file.

type PRCache

type PRCache map[string]map[string]*PRInfo

PRCache maps origin URL -> branch -> PR info (legacy format)

type PRInfo

type PRInfo struct {
	Number       int       `json:"number"`
	State        string    `json:"state"`    // Normalized: OPEN, MERGED, CLOSED
	IsDraft      bool      `json:"is_draft"` // true if PR is a draft
	URL          string    `json:"url"`
	Author       string    `json:"author"`        // username/login
	CommentCount int       `json:"comment_count"` // number of comments
	HasReviews   bool      `json:"has_reviews"`   // any reviews submitted
	IsApproved   bool      `json:"is_approved"`   // approved status
	CachedAt     time.Time `json:"cached_at"`
	Fetched      bool      `json:"fetched"` // true = API was queried (distinguishes "not fetched" from "no PR")
}

PRInfo represents pull request information

func (*PRInfo) IsStale

func (m *PRInfo) IsStale() bool

IsStale returns true if the cache entry is older than CacheMaxAge

type WorktreeIDEntry

type WorktreeIDEntry struct {
	ID        int        `json:"id"`
	Path      string     `json:"path"`
	RepoPath  string     `json:"repo_path,omitempty"`  // main repo path for repair
	Branch    string     `json:"branch,omitempty"`     // branch name for repair
	OriginURL string     `json:"origin_url,omitempty"` // origin URL (may be empty for local-only repos)
	RemovedAt *time.Time `json:"removed_at,omitempty"` // nil if still exists
	PR        *PRInfo    `json:"pr,omitempty"`         // embedded PR info
}

WorktreeIDEntry stores the ID for a worktree with rich metadata for repair

type WorktreeInfo

type WorktreeInfo struct {
	Path      string // worktree path (required)
	RepoPath  string // main repo path
	Branch    string // branch name
	OriginURL string // origin URL (may be empty for local-only repos)
}

WorktreeInfo contains the info needed to sync the cache. Path is required; other fields are stored as metadata for repair/recovery.