prcache

Documentation

Overview

Package prcache provides PR status caching stored in ~/.wt/prs.json. PRs are stored independently of worktree entries, keyed by folder name, allowing PR info to be cached before worktrees are created.

Index

• Constants
• func Path() string
• type Cache
  • func Load() (*Cache, error)
  • func New() *Cache
  • func (c *Cache) Delete(folder string)
  • func (c *Cache) Get(folder string) *PRInfo
  • func (c *Cache) Reset()
  • func (c *Cache) Save() error
  • func (c *Cache) Set(folder string, pr *PRInfo)
• type PRInfo
  • func FromForge(pr *forge.PRInfo) *PRInfo
  • func (p *PRInfo) IsStale() bool

Constants

const CacheMaxAge = 24 * time.Hour

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

Functions

func Path

func Path() string

Path returns the path to the PR cache file

Types

type Cache

type Cache struct {
	PRs map[string]*PRInfo `json:"prs"`
}

Cache stores PR info keyed by folder name

func Load

func Load() (*Cache, error)

Load loads the PR cache from disk

func New

func New() *Cache

New returns an empty, initialized cache.

func (*Cache) Delete

func (c *Cache) Delete(folder string)

Delete removes PR info for a folder

func (*Cache) Get

func (c *Cache) Get(folder string) *PRInfo

Get returns PR info for a folder, or nil if not found

func (*Cache) Reset

func (c *Cache) Reset()

Reset clears all cached data

func (*Cache) Save

func (c *Cache) Save() error

Save saves the PR cache to disk atomically

func (*Cache) Set

func (c *Cache) Set(folder string, pr *PRInfo)

Set stores PR info for a folder

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 FromForge

func FromForge(pr *forge.PRInfo) *PRInfo

FromForge converts a forge.PRInfo to a prcache.PRInfo. Returns nil if pr is nil.

func (*PRInfo) IsStale

func (p *PRInfo) IsStale() bool

IsStale returns true if the cache entry is older than CacheMaxAge